Package org.ametys.core.ui

Annotation Interface Callable

@Retention(RUNTIME)
@Target(METHOD)
public @interface Callable

Mark the annotated method as callable by a client-side component.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Callable.RightMode	Indicate how to check multiple rights

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	allowAnonymous	Determines if the method can be accessed by a anonymous user
String	context	The context to check the right.
int	paramIndex	The index of method's argument holding the context value to be converted by RightAssignmentContext
String	rightContext	The id of a type of the RightAssignmentContext to use to convert JS object into into a Java object
Callable.RightMode	rightMode	The mode to use to check multiple rights
String[]	rights	The ids of rights to be checked

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHECKED_BY_IMPLEMENTATION	Constant to use to ask explicitly the system to not check rights, as they will be checked by the method itself
static final String	NO_CHECK_REQUIRED	Constant to use to explicitly indicate that this method could be called by anyone (anonymous users included or not depending on allowAnonymous())
static final String	READ_ACCESS	Constant to check read access
static final String	SKIP_BUILTIN_CHECK	Deprecated. Use NO_CHECK_REQUIRED or CHECKED_BY_IMPLEMENTATION instead.

Field Details

SKIP_BUILTIN_CHECK

@Deprecated
static final String SKIP_BUILTIN_CHECK

Deprecated.

Use NO_CHECK_REQUIRED or CHECKED_BY_IMPLEMENTATION instead.

Constant to use to explicitly do not check right

See Also:

• Constant Field Values

CHECKED_BY_IMPLEMENTATION

static final String CHECKED_BY_IMPLEMENTATION

Constant to use to ask explicitly the system to not check rights, as they will be checked by the method itself

See Also:

• Constant Field Values

NO_CHECK_REQUIRED

static final String NO_CHECK_REQUIRED

Constant to use to explicitly indicate that this method could be called by anyone (anonymous users included or not depending on allowAnonymous())

See Also:

• Constant Field Values

READ_ACCESS

static final String READ_ACCESS

Constant to check read access

See Also:

• Constant Field Values

Element Details

rights

String[] rights

The ids of rights to be checked

Returns:

The ids or empty if there is no right protection

Default:

{""}

rightMode

Callable.RightMode rightMode

The mode to use to check multiple rights

Returns:

The mode to use

Default:

OR

allowAnonymous

boolean allowAnonymous

Determines if the method can be accessed by a anonymous user

Returns:

true if anonymous user is allowed

Default:

false

context

String context

The context to check the right. Defaults to '/${WorkspaceName}'

Returns:

The context

Default:

"/${WorkspaceName}"

rightContext

String rightContext

The id of a type of the RightAssignmentContext to use to convert JS object into into a Java object

Returns:

The id of the RightAssignmentContext

Default:

""

paramIndex

int paramIndex

The index of method's argument holding the context value to be converted by RightAssignmentContext

Returns:

The parameter's index

Default:

-1