org.springframework.web.portlet.context

Class PortletRequestHandledEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.web.context.support.RequestHandledEvent

org.springframework.web.portlet.context.PortletRequestHandledEvent

All Implemented Interfaces:

Serializable

public class PortletRequestHandledEvent
extends RequestHandledEvent

Portlet-specific subclass of RequestHandledEvent, adding portlet-specific context information.

Since:

2.0

Author:

Juergen Hoeller, John A. Lewis

See Also:

FrameworkPortlet, ApplicationEventPublisher.publishEvent(org.springframework.context.ApplicationEvent), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PortletRequestHandledEvent(Object source, String portletName, String portletMode, String requestType, String sessionId, String userName, long processingTimeMillis) Create a new PortletRequestHandledEvent.
PortletRequestHandledEvent(Object source, String portletName, String portletMode, String requestType, String sessionId, String userName, long processingTimeMillis, Throwable failureCause) Create a new PortletRequestHandledEvent.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return a full description of this event, involving all available context data.
String	getPortletMode() Return the mode of the portlet request (usually 'view', 'edit', or 'help').
String	getPortletName() Return the name of the portlet that handled the request.
String	getRequestType() Return the the type of Portlet Request ('action' or 'render').
String	getShortDescription() Return a short description of this event, only involving the most important context data.
String	toString()

Methods inherited from class org.springframework.web.context.support.RequestHandledEvent

getFailureCause, getProcessingTimeMillis, getSessionId, getUserName, wasFailure

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PortletRequestHandledEvent

public PortletRequestHandledEvent(Object source,
                                  String portletName,
                                  String portletMode,
                                  String requestType,
                                  String sessionId,
                                  String userName,
                                  long processingTimeMillis)

Create a new PortletRequestHandledEvent.

Parameters:

source - the component that published the event

portletName - the name of the portlet that handled the request

portletMode - the PortletMode of the request (usually 'view', 'edit', or 'help')

requestType - the type of Portlet request ('action' or 'render')

sessionId - the id of the HTTP session, if any

userName - the name of the user that was associated with the request, if any (usually the UserPrincipal)

processingTimeMillis - the processing time of the request in milliseconds

PortletRequestHandledEvent

public PortletRequestHandledEvent(Object source,
                                  String portletName,
                                  String portletMode,
                                  String requestType,
                                  String sessionId,
                                  String userName,
                                  long processingTimeMillis,
                                  Throwable failureCause)

Create a new PortletRequestHandledEvent.

Parameters:

source - the component that published the event

portletName - the name of the portlet that handled the request

portletMode - the PortletMode of the request (usually 'view', 'edit', or 'help')

requestType - the type of Portlet request ('action' or 'render')

sessionId - the id of the HTTP session, if any

userName - the name of the user that was associated with the request, if any (usually the UserPrincipal)

processingTimeMillis - the processing time of the request in milliseconds

failureCause - the cause of failure, if any

Method Detail

getPortletName

public String getPortletName()

Return the name of the portlet that handled the request.

getPortletMode

public String getPortletMode()

Return the mode of the portlet request (usually 'view', 'edit', or 'help').

getRequestType

public String getRequestType()

Return the the type of Portlet Request ('action' or 'render').

getShortDescription

public String getShortDescription()

Description copied from class: RequestHandledEvent

Return a short description of this event, only involving the most important context data.

Overrides:

getShortDescription in class RequestHandledEvent

getDescription

public String getDescription()

Description copied from class: RequestHandledEvent

Return a full description of this event, involving all available context data.

Overrides:

getDescription in class RequestHandledEvent

toString

public String toString()

Overrides:

toString in class RequestHandledEvent