org.pac4j.core.authorization.authorizer

Class AbstractRequireElementAuthorizer<E,U extends CommonProfile>

java.lang.Object

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

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

All Implemented Interfaces:

Authorizer<U>

Direct Known Subclasses:

AbstractRequireAllAuthorizer, AbstractRequireAnyAuthorizer

public abstract class AbstractRequireElementAuthorizer<E,U extends CommonProfile>
extends ProfileAuthorizer<U>

An authorizer to require elements.

Since:

1.8.1

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<E>	elements

Constructor Summary

Constructors

Constructor and Description
AbstractRequireElementAuthorizer()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	check(WebContext context, U profile, E element) Check a specific element.
java.util.Set<E>	getElements()
boolean	isAuthorized(WebContext context, java.util.List<U> profiles) Checks if the user profiles and / or the current web context are authorized.
void	setElements(E... elements)
void	setElements(java.util.List<E> elements)
void	setElements(java.util.Set<E> 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 Detail

elements

protected java.util.Set<E> elements

Constructor Detail

AbstractRequireElementAuthorizer

public AbstractRequireElementAuthorizer()

Method Detail

isAuthorized

public boolean isAuthorized(WebContext context,
                            java.util.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

check

protected abstract boolean check(WebContext context,
                                 U profile,
                                 E element)
                          throws HttpAction

Check a specific element.

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

getElements

public java.util.Set<E> getElements()

setElements

public void setElements(java.util.Set<E> elements)

setElements

public void setElements(java.util.List<E> elements)

setElements

public void setElements(E... elements)