fish.payara.cdi.auth.roles

Annotation Type Roles

@InterceptorBinding
 @Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
public @interface Roles

Defines a list of roles which a caller must be in to access either methods within an annotated class, or a singular annotated method. Roles defined on a method level will always add to or overrule those defined on a class level.

Author:

Michael Ranaldo

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	allowed The roles which are allowed to access this method.
LogicalOperator	semantics Whether accessing users must be in any one of the given roles (OR) or all given roles (AND).

Element Detail

allowed

@NotNull
public abstract String[] allowed

The roles which are allowed to access this method. Defaults to an empty string.

Returns:

A String array of permitted roles.

Default:

""

semantics

public abstract LogicalOperator semantics

Whether accessing users must be in any one of the given roles (OR) or all given roles (AND). Uses the LogicalOperator enum defined in the same package (fish.payara.cdi.auth.roles.LogicalOperator).

Returns:

Default:

fish.payara.cdi.auth.roles.LogicalOperator.OR