Package jakarta.portlet.annotations
Annotation Type ActionMethod
-
@Retention(RUNTIME) @Target(METHOD) public @interface ActionMethod
Designates a method corresponding to the portlet API processAction method. The annotated method must have the following signature:public void <methodName>(ActionRequest, ActionResponse)where the method name can be freely selected.
The method declaration may contain a throws clause. Exceptions declared in the throws clause should be of type
PortletExceptionorIOException. Checked exceptions of any other type will be caught, wrapped with a PortletException, and rethrown.- Since:
- 3.0
- See Also:
processAction
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description StringportletNameThe portlet name for the annotated method.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description StringactionNameThe action name.PortletQName[]publishingEventsThe QName definitions of the events published by this method.
-
-
-
Element Detail
-
portletName
String portletName
The portlet name for the annotated method.- Returns:
- The portlet name
-
-
-
actionName
String actionName
The action name.If an action name is specified, the bean enabler will dispatch Action requests with matching values of the reserved "jakarta.portlet.action" parameter to this method.
An ActionMethod with an empty action name will receive all Action requests not dispatched to other named ActionMethods.
- Returns:
- The action name
- Default:
- ""
-
-
-
publishingEvents
PortletQName[] publishingEvents
The QName definitions of the events published by this method.- Returns:
- The processing event QNames
- See Also:
EventDefinition,PortletQName
- Default:
- {}
-
-