Package org.pac4j.core.authorization.authorizer

Class AbstractRequireElementAuthorizer<E>

java.lang.Object

org.pac4j.core.authorization.authorizer.ProfileAuthorizer

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

All Implemented Interfaces:

Authorizer

Direct Known Subclasses:

AbstractRequireAllAuthorizer, AbstractRequireAnyAuthorizer

public abstract class AbstractRequireElementAuthorizer<E>
extends ProfileAuthorizer

An authorizer to require elements.

Since:

1.8.1

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<E>	elements

Constructor Summary

Constructors

Constructor	Description
AbstractRequireElementAuthorizer()

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	check(WebContext context, SessionStore sessionStore, UserProfile profile, E element)	Check a specific element.
Set<E>	getElements()	Getter for the field elements.
boolean	isAuthorized(WebContext context, SessionStore sessionStore, List<UserProfile> profiles)	Checks if the user profiles and / or the current web context are authorized.
void	setElements(E... elements)	Setter for the field elements.
void	setElements(List<E> elements)	Setter for the field elements.
void	setElements(Set<E> elements)	Setter for the field elements.

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

handleError, isAllAuthorized, isAnyAuthorized, isProfileAuthorized

Methods inherited from class java.lang.Object

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

Field Details

elements

protected Set<E> elements

Constructor Details

AbstractRequireElementAuthorizer

public AbstractRequireElementAuthorizer()

Method Details

isAuthorized

public boolean isAuthorized(WebContext context,
 SessionStore sessionStore,
 List<UserProfile> profiles)

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

Parameters:

context - the web context

sessionStore - the session store

profiles - the user profiles

Returns:

if the access is authorized

check

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

Check a specific element.

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

getElements

public Set<E> getElements()

Getter for the field elements.

Returns:

a Set object

setElements

public void setElements(Set<E> elements)

Setter for the field elements.

Parameters:

elements - a Set object

setElements

public void setElements(List<E> elements)

Setter for the field elements.

Parameters:

elements - a List object

setElements

public void setElements(E... elements)

Setter for the field elements.

Parameters:

elements - a E object