org.pac4j.core.authorization.authorizer

Class ProfileAuthorizer<U extends CommonProfile>

java.lang.Object

org.pac4j.core.authorization.authorizer.ProfileAuthorizer<U>

All Implemented Interfaces:

Authorizer<U>

Direct Known Subclasses:

AbstractCheckAuthenticationAuthorizer, AbstractRequireElementAuthorizer

public abstract class ProfileAuthorizer<U extends CommonProfile>
extends Object
implements Authorizer<U>

Authorizer which is valid if one of the profiles is authorized or all the profiles are authorized.

Since:

1.9.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
ProfileAuthorizer()

Method Summary

Modifier and Type	Method and Description
protected boolean	handleError(WebContext context) Handle the error.
boolean	isAllAuthorized(WebContext context, List<U> profiles) If all profiles are authorized.
boolean	isAnyAuthorized(WebContext context, List<U> profiles) If any of the profiles is authorized.
protected abstract boolean	isProfileAuthorized(WebContext context, U profile) Whether a specific profile is authorized.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pac4j.core.authorization.authorizer.Authorizer

isAuthorized

Constructor Detail

ProfileAuthorizer

public ProfileAuthorizer()

Method Detail

isAllAuthorized

public boolean isAllAuthorized(WebContext context,
                               List<U> profiles)
                        throws HttpAction

If all profiles are authorized.

Parameters:

context - the web context

profiles - the user profiles

Returns:

whether all profiles are authorized

Throws:

HttpAction - an extra HTTP action

isAnyAuthorized

public boolean isAnyAuthorized(WebContext context,
                               List<U> profiles)
                        throws HttpAction

If any of the profiles is authorized.

Parameters:

context - the web context

profiles - the user profiles

Returns:

whether any of the profiles is authorized

Throws:

HttpAction - an extra HTTP action

isProfileAuthorized

protected abstract boolean isProfileAuthorized(WebContext context,
                                               U profile)
                                        throws HttpAction

Whether a specific profile is authorized.

Parameters:

context - the web context

profile - the user profile

Returns:

whether a specific profile is authorized

Throws:

HttpAction - whether an additional HTTP action is required

handleError

protected boolean handleError(WebContext context)
                       throws HttpAction

Handle the error.

Parameters:

context - the web context

Returns:

false

Throws:

HttpAction - whether an additional HTTP action is required