javax.portlet.annotations

Annotation Type SecurityRoleRef

@Retention(value=RUNTIME)
 @Target(value=ANNOTATION_TYPE)
public @interface SecurityRoleRef

This annotation is used within composite portlet configuration annotations to represent a single security role reference. It cannot be used as a stand-alone portlet annotation.

Since:

3.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	roleName The role name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
LocaleString[]	description The security role ref description.
String	roleLink The application role that the role name is mapped to.

Element Detail

roleName

public abstract String roleName

The role name.

Returns:

The role name

roleLink

public abstract String roleLink

The application role that the role name is mapped to.

Returns:

The role link

Default:

""

description

public abstract LocaleString[] description

The security role ref description. It provides locale-specific text describing the security role ref for use by the portal application or by tools.

Returns:

The security role reference description

Default:

{}