Package org.pac4j.core.authorization.authorizer

Class RequireAnyRoleAuthorizer

java.lang.Object

org.pac4j.core.authorization.authorizer.ProfileAuthorizer

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

org.pac4j.core.authorization.authorizer.AbstractRequireAnyAuthorizer<String>

org.pac4j.core.authorization.authorizer.RequireAnyRoleAuthorizer

All Implemented Interfaces:

Authorizer

public class RequireAnyRoleAuthorizer
extends AbstractRequireAnyAuthorizer<String>

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	Description
RequireAnyRoleAuthorizer()	Constructor for RequireAnyRoleAuthorizer.
RequireAnyRoleAuthorizer(String... roles)	Constructor for RequireAnyRoleAuthorizer.
RequireAnyRoleAuthorizer(List<String> roles)	Constructor for RequireAnyRoleAuthorizer.
RequireAnyRoleAuthorizer(Set<String> roles)	Constructor for RequireAnyRoleAuthorizer.

Method Summary

Modifier and Type	Method	Description
protected boolean	check(WebContext context, SessionStore sessionStore, UserProfile profile, String element)	Check a specific element.
static RequireAnyRoleAuthorizer	requireAnyRole(String... roles)	requireAnyRole.
static RequireAnyRoleAuthorizer	requireAnyRole(List<String> roles)	requireAnyRole.
static RequireAnyRoleAuthorizer	requireAnyRole(Set<String> roles)	requireAnyRole.

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 Details

RequireAnyRoleAuthorizer

public RequireAnyRoleAuthorizer()

Constructor for RequireAnyRoleAuthorizer.

RequireAnyRoleAuthorizer

public RequireAnyRoleAuthorizer(String... roles)

Constructor for RequireAnyRoleAuthorizer.

Parameters:

roles - a String object

RequireAnyRoleAuthorizer

public RequireAnyRoleAuthorizer(List<String> roles)

Constructor for RequireAnyRoleAuthorizer.

Parameters:

roles - a List object

RequireAnyRoleAuthorizer

public RequireAnyRoleAuthorizer(Set<String> roles)

Constructor for RequireAnyRoleAuthorizer.

Parameters:

roles - a Set object

Method Details

check

protected boolean check(WebContext context,
 SessionStore sessionStore,
 UserProfile profile,
 String element)

Check a specific element.

Specified by:

check in class AbstractRequireElementAuthorizer<String>

Parameters:

context - the web context

sessionStore - the session store

profile - the profile

element - the element to check

Returns:

whether it is authorized for this element

requireAnyRole

public static RequireAnyRoleAuthorizer requireAnyRole(String... roles)

requireAnyRole.

Parameters:

roles - a String object

Returns:

a RequireAnyRoleAuthorizer object

requireAnyRole

public static RequireAnyRoleAuthorizer requireAnyRole(List<String> roles)

requireAnyRole.

Parameters:

roles - a List object

Returns:

a RequireAnyRoleAuthorizer object

requireAnyRole

public static RequireAnyRoleAuthorizer requireAnyRole(Set<String> roles)

requireAnyRole.

Parameters:

roles - a Set object

Returns:

a RequireAnyRoleAuthorizer object