org.pac4j.core.authorization.authorizer

Class RequireAnyRoleAuthorizer<U extends CommonProfile>

java.lang.Object

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

org.pac4j.core.authorization.authorizer.AbstractRequireElementAuthorizer<E,U>

org.pac4j.core.authorization.authorizer.AbstractRequireAnyAuthorizer<java.lang.String,U>

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

Type Parameters:

U - the user profile

All Implemented Interfaces:

Authorizer<U>

public class RequireAnyRoleAuthorizer<U extends CommonProfile>
extends AbstractRequireAnyAuthorizer<java.lang.String,U>

Checks an access if the user profile has any of the roles.

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

Fields inherited from class org.pac4j.core.authorization.authorizer.AbstractRequireElementAuthorizer

elements

Constructor Summary

Constructors

Constructor and Description
RequireAnyRoleAuthorizer()
RequireAnyRoleAuthorizer(java.util.List<java.lang.String> roles)
RequireAnyRoleAuthorizer(java.util.Set<java.lang.String> roles)
RequireAnyRoleAuthorizer(java.lang.String... roles)

Method Summary

Modifier and Type	Method and Description
protected boolean	check(WebContext context, U profile, java.lang.String element) Check a specific element.

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

isProfileAuthorized

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

getElements, isAuthorized, setElements, setElements, setElements

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

handleError, isAllAuthorized, isAnyAuthorized

Methods inherited from class java.lang.Object

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

Constructor Detail

RequireAnyRoleAuthorizer

public RequireAnyRoleAuthorizer()

RequireAnyRoleAuthorizer

public RequireAnyRoleAuthorizer(java.lang.String... roles)

RequireAnyRoleAuthorizer

public RequireAnyRoleAuthorizer(java.util.List<java.lang.String> roles)

RequireAnyRoleAuthorizer

public RequireAnyRoleAuthorizer(java.util.Set<java.lang.String> roles)

Method Detail

check

protected boolean check(WebContext context,
                        U profile,
                        java.lang.String element)
                 throws HttpAction

Description copied from class: AbstractRequireElementAuthorizer

Check a specific element.

Specified by:

check in class AbstractRequireElementAuthorizer<java.lang.String,U extends CommonProfile>

Parameters:

context - the web context

profile - the profile

element - the element to check

Returns:

whether it is authorized for this element

Throws:

HttpAction - whether an additional HTTP action is required