Module de.codecamp.vaadin.security.spring

Package de.codecamp.vaadin.security.spring.access

Class AccessRule

java.lang.Object

de.codecamp.vaadin.security.spring.access.AccessRule

All Implemented Interfaces:

Serializable

public final class AccessRule
extends Object
implements Serializable

Represents the rule determining access. If both an expression and an AccessEvaluator are specified, both must be satisfied to gain access. At least one of them must be specified.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static AccessRule	asCopyOf(SecuredAccess securedAccess)	Creates a new access rule as copy from a SecuredAccess annotation.
boolean	checkLayout()	Returns whether parent layouts should also be examined for access rules.
Class<? extends AccessEvaluator>	evaluator()	A programmatic evaluator to control access; may be null.
String	expression()	A Spring Security expression to control access; may be null.
static AccessRule	of(Class<? extends AccessEvaluator> evaluator)	Creates a new access rule based on an evaluator, checking parent layouts for access rules.
static AccessRule	of(Class<? extends AccessEvaluator> evaluator, boolean checkLayout)	Creates a new access rule based on an evaluator, optionally checking parent layouts for access rules.
static AccessRule	of(String expression)	Creates a new access rule based on an expression, checking parent layouts for access rules.
static AccessRule	of(String expression, boolean checkLayout)	Creates a new access rule based on an expression, optionally checking parent layouts for access rules.

Methods inherited from class java.lang.Object

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

Method Details

expression

public String expression()

A Spring Security expression to control access; may be null.

If both an expression and an evaluator are set, both must be satisfied to grant access.

Returns:

a Spring Security expression; may be null

evaluator

public Class<? extends AccessEvaluator> evaluator()

A programmatic evaluator to control access; may be null.

If both an expression and an evaluator are set, both must be satisfied to grant access.

Returns:

a AccessEvaluator; may be null

checkLayout

public boolean checkLayout()

Returns whether parent layouts should also be examined for access rules. Only applicable to access to routes.

Returns:

whether parent layouts should also be examined for access rules

asCopyOf

public static AccessRule asCopyOf(SecuredAccess securedAccess)

Creates a new access rule as copy from a SecuredAccess annotation.

Parameters:

securedAccess - the SecuredAccess annotation

Returns:

the access rule

See Also:

• SecuredAccess

of

public static AccessRule of(String expression)

Creates a new access rule based on an expression, checking parent layouts for access rules.

Parameters:

expression - a Spring Security expression

Returns:

the access rule

See Also:

• SecuredAccess.value()

of

public static AccessRule of(String expression,
 boolean checkLayout)

Creates a new access rule based on an expression, optionally checking parent layouts for access rules.

Parameters:

expression - a Spring Security expression

checkLayout - whether parent layouts should also be checked for access rules

Returns:

the access rule

See Also:

• SecuredAccess.value()

of

public static AccessRule of(Class<? extends AccessEvaluator> evaluator)

Creates a new access rule based on an evaluator, checking parent layouts for access rules.

Parameters:

evaluator - a AccessEvaluator

Returns:

the access rule

See Also:

• SecuredAccess.evaluator()

of

public static AccessRule of(Class<? extends AccessEvaluator> evaluator,
 boolean checkLayout)

Creates a new access rule based on an evaluator, optionally checking parent layouts for access rules.

Parameters:

evaluator - a AccessEvaluator

checkLayout - whether parent layouts should also be checked for access rules

Returns:

the access rule

See Also:

• SecuredAccess.evaluator()