javax.portlet.annotations

Annotation Type PortletApplication

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

Annotation for the portlet application configuration. These configuration parameters also appear in the portlet deployment descriptor.

The portlet deployment descriptor can continue to be used. Values of configuration parameters appearing in the deployment descriptor have precedence over the corresponding values defined in the annotation.

Since:

3.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
CustomPortletMode[]	customPortletModes The custom portlet modes defined for this portlet.
CustomWindowState[]	customWindowStates The custom window states defined for this portlet.
String	defaultNamespaceURI The default QName namespace URI.
EventDefinition[]	events The events defined for the portlet.
PublicRenderParameterDefinition[]	publicParams The public render parameters used by the portlet.
String	resourceBundle The resource bundle name for this portlet.
RuntimeOption[]	runtimeOptions The portlet container runtime options.
UserAttribute[]	userAttributes The user aattribute declarations.
String	version The portlet API version required by this portlet application.

Element Detail

version

public abstract String version

The portlet API version required by this portlet application.

Returns:

The portlet API version

Default:

"3.0"

runtimeOptions

public abstract RuntimeOption[] runtimeOptions

The portlet container runtime options.

Returns:

An array of portlet container runtime options

Default:

{}

publicParams

public abstract PublicRenderParameterDefinition[] publicParams

The public render parameters used by the portlet.

Returns:

The array of public render parameters.

Default:

{}

events

public abstract EventDefinition[] events

The events defined for the portlet. This includes the processing events as well as the publishing events.

The publishing event QNames are specified in the ActionMethod and EventMethod annotations. The processing event QNames are specified in the ActionMethod and EventMethod annotations.

Returns:

The event definitions

See Also:

PortletQName, ActionMethod, EventMethod

Default:

{}

resourceBundle

public abstract String resourceBundle

The resource bundle name for this portlet. Name of the resource bundle containing the language specific portlet information in different languages.

the file name is specified without the language specific part (e.g. _en) or the file extension.

Returns:

The resource bundle name

Default:

""

customPortletModes

public abstract CustomPortletMode[] customPortletModes

The custom portlet modes defined for this portlet.

Returns:

The custom portlet modes

Default:

{}

customWindowStates

public abstract CustomWindowState[] customWindowStates

The custom window states defined for this portlet.

Returns:

The custom window states

Default:

{}

defaultNamespaceURI

public abstract String defaultNamespaceURI

The default QName namespace URI.

The default namespace URI is used when no namespace URI is specified when declaring a QName for a public render parameter or portlet event.

Returns:

The default namespace URI.

Default:

""

userAttributes

public abstract UserAttribute[] userAttributes

The user aattribute declarations.

Returns:

The user attribute declarations

Default:

{}