public class

PortletRequestHandledEvent

extends RequestHandledEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ org.springframework.context.ApplicationEvent
       ↳ org.springframework.web.context.support.RequestHandledEvent
         ↳ org.springframework.web.portlet.context.PortletRequestHandledEvent

Class Overview

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

See Also

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
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.
Public Methods
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()
[Expand]
Inherited Methods
From class org.springframework.web.context.support.RequestHandledEvent
From class org.springframework.context.ApplicationEvent
From class java.util.EventObject
From class java.lang.Object

Public Constructors

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

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

Public Methods

public String getDescription ()

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

public String getPortletMode ()

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

public String getPortletName ()

Return the name of the portlet that handled the request.

public String getRequestType ()

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

public String getShortDescription ()

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

public String toString ()