Package org.apache.archiva.redback.authorization

Annotation Type RedbackAuthorization

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

Authorization annotation. The annotation can be defined for methods and describes the permissions necessary to execute the method.

Since:

1.3

Author:

Olivier Lamy

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	description	A description of the authorization definition.
boolean	noPermission
boolean	noRestriction
String[]	permissions	The list of permissions that are needed for executing the method.
String	resource	The resource is used to restrict access by using information from the method parameters or call environment.

Element Detail

permissions

String[] permissions

The list of permissions that are needed for executing the method. The strings refer to defined permission ids. The accessing user must have at least one of the given permissions to execute the method.

Returns:

the array of permission ids.

Default:

{""}

resource

String resource

The resource is used to restrict access by using information from the method parameters or call environment. Resource annotations have to be in line with the defined permissions. Parameters have to be given in the form {parameterName} and are extracted from the URIInfo (path- and query-parameters)

Returns:

the redback resource karma needed

Default:

""

description

String description

A description of the authorization definition.

Returns:

the description string

Default:

""

noRestriction

boolean noRestriction

Returns:

true if doesn't need any special permission

Default:

false

noPermission

boolean noPermission

Returns:

True, if this service need only authentication and not special karma

Default:

false