org.pac4j.core.authorization.authorizer

Class IsAuthenticatedAuthorizer<U extends CommonProfile>

java.lang.Object

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

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

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

All Implemented Interfaces:

Authorizer<U>

public class IsAuthenticatedAuthorizer<U extends CommonProfile>
extends AbstractCheckAuthenticationAuthorizer<U>

The user must be authenticated. This authorizer should never be necessary unless using the AnonymousClient.

Since:

1.9.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
IsAuthenticatedAuthorizer()
IsAuthenticatedAuthorizer(String redirectionUrl)

Method Summary

Modifier and Type	Method and Description
protected String	getErrorMessage() Return the error message.
boolean	isAuthorized(WebContext context, List<U> profiles) Checks if the user profiles and / or the current web context are authorized.
boolean	isProfileAuthorized(WebContext context, U profile) Whether a specific profile is authorized.

Methods inherited from class org.pac4j.core.authorization.authorizer.AbstractCheckAuthenticationAuthorizer

getRedirectionUrl, handleError, setRedirectionUrl

Methods inherited from class org.pac4j.core.authorization.authorizer.ProfileAuthorizer

isAllAuthorized, isAnyAuthorized

Methods inherited from class java.lang.Object

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

Constructor Detail

IsAuthenticatedAuthorizer

public IsAuthenticatedAuthorizer()

IsAuthenticatedAuthorizer

public IsAuthenticatedAuthorizer(String redirectionUrl)

Method Detail

isAuthorized

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

Description copied from interface: Authorizer

Checks if the user profiles and / or the current web context are authorized.

Parameters:

context - the web context

profiles - the user profiles

Returns:

if the access is authorized

Throws:

HttpAction - whether an additional HTTP action is required

isProfileAuthorized

public boolean isProfileAuthorized(WebContext context,
                                   U profile)
                            throws HttpAction

Description copied from class: ProfileAuthorizer

Whether a specific profile is authorized.

Specified by:

isProfileAuthorized in class ProfileAuthorizer<U extends CommonProfile>

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

getErrorMessage

protected String getErrorMessage()

Description copied from class: AbstractCheckAuthenticationAuthorizer

Return the error message.

Specified by:

getErrorMessage in class AbstractCheckAuthenticationAuthorizer<U extends CommonProfile>

Returns:

the error message.