com.ibm.portal.resolver.portlet
Interface EventRequest

All Superinterfaces:

Addressable, Identifiable, ParameterAccessor

All Known Subinterfaces:

RenderEventRequest, ResourceEventRequest

public interface EventRequest
extends Identifiable, Addressable, ParameterAccessor

Represents the basic state of the render or resource event and its context.

Since:

8.5

See Also:

RenderEventRequest, RenderEventResponse

Field Summary

Fields inherited from interface com.ibm.portal.resolver.data.Addressable

EMPTY_PARAMETERS

Method Summary

Context	getContext() Returns the COR context for the render event, this context can e.g.
java.lang.String	getLocalName(javax.xml.namespace.QName qName) Returns the local name for a public render parameter name
java.lang.String	getNamespace() The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the portal page.
ObjectID	getObjectID() Returns the ObjectID of the portlet window that triggered the current request.
java.util.Map<java.lang.String,java.lang.String[]>	getParameters() Returns an unmodifiable version of the event parameters, never null, but potentially the empty map.
PortletDefinition	getPortletDefinition() Returns the portlet definition
PortletEntity	getPortletEntity() Returns the portlet entity
PortletWindow	getPortletWindow() Returns the portlet window
javax.portlet.PortletPreferences	getPreferences() Returns the read-only preferences of the addressed portlet window
java.util.Set<java.lang.String>	getPublicRenderParameterNames() Returns an unmodifiable set of the names of the public render parameters of the targeted portlet
java.net.URI	getURI() Returns the unique identifier of the event
java.security.Principal	getUserPrincipal() Returns a Principal object containing the name of the current authenticated user.

Methods inherited from interface com.ibm.portal.resolver.accessors.url.ParameterAccessor

getParameter, getParameter, getParameters, getParameters

Method Detail

getContext

Context getContext()

Returns the COR context for the render event, this context can e.g. be used to delegate the resolution or access additional services.

Returns:

the COR context for this request, not null

Since:

7.0

getLocalName

java.lang.String getLocalName(javax.xml.namespace.QName qName)

Returns the local name for a public render parameter name

Parameters:

qName - the qname

Returns:

the local name or null if the portlet does not declare the parameter

Since:

8.5

getNamespace

java.lang.String getNamespace()

The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the portal page. The namespace value must be constant for the lifetime of the portlet window. *

Returns:

the namespace identifier

Since:

8.5

See Also:

PortletResponse.getNamespace()

getObjectID

ObjectID getObjectID()

Returns the ObjectID of the portlet window that triggered the current request.

Specified by:

getObjectID in interface Identifiable

Returns:

object ID of the window

getParameters

java.util.Map<java.lang.String,java.lang.String[]> getParameters()

Returns an unmodifiable version of the event parameters, never null, but potentially the empty map.

The key is of type String, the values of type String[]

This map is different from the render parameters

Specified by:

getParameters in interface Addressable

Specified by:

getParameters in interface ParameterAccessor

Returns:

parameter map

getPortletDefinition

PortletDefinition getPortletDefinition()

Returns the portlet definition

Returns:

the definition

Since:

7.0

getPortletEntity

PortletEntity getPortletEntity()

Returns the portlet entity

Returns:

the entity

Since:

7.0

getPortletWindow

PortletWindow getPortletWindow()

Returns the portlet window

Returns:

the portlet window

Since:

7.0

getPreferences

javax.portlet.PortletPreferences getPreferences()

Returns the read-only preferences of the addressed portlet window

Returns:

the preferences, not null

getPublicRenderParameterNames

java.util.Set<java.lang.String> getPublicRenderParameterNames()

Returns an unmodifiable set of the names of the public render parameters of the targeted portlet

Returns:

the set of names

Since:

8.5

getURI

java.net.URI getURI()

Returns the unique identifier of the event

Specified by:

getURI in interface Addressable

Returns:

URI of the object, never null

getUserPrincipal

java.security.Principal getUserPrincipal()

Returns a Principal object containing the name of the current authenticated user.

Returns:

the principal or null