Package org.pac4j.core.authorization.authorizer

Class RequireAnyAttributeAuthorizer

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.RequireAnyAttributeAuthorizer

All Implemented Interfaces:

Authorizer

public class RequireAnyAttributeAuthorizer
extends AbstractRequireAnyAuthorizer<String>

This is RequireAnyAttributeAuthorizer which checks profile attributes for the specified element, and optionally may pattern-check the configured value. In practice, you may use this authorizer to see if the profile contains attribute X and optionally, whether X has a value that matches pattern Y.

Since:

1.9.2

Author:

Misagh Moayyed

Field Summary

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

elements

Constructor Summary

Constructors

Constructor	Description
RequireAnyAttributeAuthorizer()	Constructor for RequireAnyAttributeAuthorizer.
RequireAnyAttributeAuthorizer(String valueToMatch)	Constructor for RequireAnyAttributeAuthorizer.

Method Summary

Modifier and Type	Method	Description
protected boolean	check(WebContext context, SessionStore sessionStore, UserProfile profile, String element)	Check a specific element.
static RequireAnyAttributeAuthorizer	requireAnyAttribute(String valueToMatch)	requireAnyAttribute.

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

RequireAnyAttributeAuthorizer

public RequireAnyAttributeAuthorizer()

Constructor for RequireAnyAttributeAuthorizer.

RequireAnyAttributeAuthorizer

public RequireAnyAttributeAuthorizer(String valueToMatch)

Constructor for RequireAnyAttributeAuthorizer.

Parameters:

valueToMatch - a String 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

requireAnyAttribute

public static RequireAnyAttributeAuthorizer requireAnyAttribute(String valueToMatch)

requireAnyAttribute.

Parameters:

valueToMatch - a String object

Returns:

a RequireAnyAttributeAuthorizer object