javax.portlet.annotations

Annotation Type EventMethod

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface EventMethod

Designates a method corresponding to the portlet API processEvent method. The annotated method must have the following signature:

public void <methodName>(EventRequest, EventResponse)

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 PortletException or IOException. Checked exceptions of any other type will be caught, wrapped with a PortletException, and rethrown.

Since:

3.0

See Also:

processEvent

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	portletName The portlet name for the annotated method.
PortletQName[]	processingEvents The processing event QName definitions supported by this method.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
PortletQName[]	publishingEvents The QName definitions of the events published by this method.

Element Detail

portletName

public abstract String portletName

The portlet name for the annotated method.

Returns:

The portlet name

processingEvents

public abstract PortletQName[] processingEvents

The processing event QName definitions supported by this method.

At least one processing event QName must be specified.

Returns:

The processing event QNames

See Also:

EventDefinition, PortletQName

publishingEvents

public abstract PortletQName[] publishingEvents

The QName definitions of the events published by this method.

Returns:

The processing event QNames

See Also:

EventDefinition, PortletQName

Default:

{}