pl.bristleback.server.bristle.actions
Annotation Type AnnotatedRemoteAction

@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface AnnotatedRemoteAction

Annotation defines the name of action and user required rights set. All action classes, to be seen by a controller, must be marked with this annotation. Annotated classes are searched and processed at plugin start by ActionAnnotationsProcessor implementation. Plugin can use default or user processor implementation (specified in config file, see BristlebackServerPlugin). By default, PackageActionAnnotationsProcessor is used.

Created on: 2010-09-03 16:02:45

Author:

Wojciech Niemiec

Required Element Summary

java.lang.String

actionName Action class name.

Optional Element Summary

boolean	isSingleton Indicates whether this action class should be instantiated only once at plugin start or on every request.
java.lang.String[]	requiredRights Required user rights.

Element Detail

actionName

public abstract java.lang.String actionName

Action class name. Each action must have unique name.

Returns:

action class name.

requiredRights

public abstract java.lang.String[] requiredRights

Required user rights. When user wants to execute any action, his rights set is checked. Action is performed only if user has every required right.

Returns:

required user rights.

Default:

{}

isSingleton

public abstract boolean isSingleton

Indicates whether this action class should be instantiated only once at plugin start or on every request. If action class marked with this annotation is taken from the application context and this parameter is set to false, action class bean should be defined with scope="prototype".
Default value of isSingleton parameter is true.

Returns:

true if this action class should be instantiating only at plugin start, false otherwise.

Default:

true