Public PRT Api: Interface IPortalComponentRequest

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sapportals.portal.prt.component
Interface IPortalComponentRequest

public interface IPortalComponentRequest

The IPortalComponentRequest is the portal component specific view on all request related matters.

It provides access to the Portal Object Model, events, other components, the component context, and more.

Method Summary

IEvent createAboutRequestEvent()
          Deprecated. use INode.setNodeMode(com.sapportals.portal.prt.pom.NodeMode) instead

java.lang.String createComponentURL(INode targetNode, IPortalRequestEvent event)
          Deprecated. use createPortalComponentURI instead

java.lang.String createComponentURL(IPortalRequestEvent event)
          Deprecated. use createPortalComponentURI instead

IEvent createEditRequestEvent()
          Deprecated. use INode.setNodeMode(com.sapportals.portal.prt.pom.NodeMode) instead

IEvent createHelpRequestEvent()
          Deprecated. use INode.setNodeMode(com.sapportals.portal.prt.pom.NodeMode) instead

java.lang.String createPageURL(java.lang.String urn)
          Deprecated. use createPortalComponentURI instead

java.lang.String createPageURL(java.lang.String urn, IPortalRequestEvent event)
          Deprecated. use createPortalComponentURI instead

java.lang.String createPageURL(java.lang.String urn, NodeMode mode)
          Deprecated. use createPortalComponentURI instead

IPortalComponentURI createPortalComponentURI()
          Creates a new PortalComponentURI

IEvent createPreviewRequestEvent()
          Deprecated. use INode.setNodeMode(com.sapportals.portal.prt.pom.NodeMode) instead

IEvent createRefreshRequestEvent()
          Deprecated. use INode.setNodeMode(com.sapportals.portal.prt.pom.NodeMode) instead

IPortalRequestEvent createRequestEvent(java.lang.String eventName)
          Creates a request event.

IPortalRequestEvent createRequestEvent(java.lang.String eventName, IPortalRequestEventData eventData)
          Creates a request event.

IPortalRequestEventData createRequestEventData()
          Creates an empty request event data object.

void dispatchRequest(INode aNode, IPortalComponentResponse aResponse)
          Dispatches the request to another node

void dispatchRequest(IResource aResource, IPortalComponentResponse aResponse)
          Dispatches the request to a Resource

ILogger getClassLogger(java.lang.Class aClass)
          Returns the logger associated to aClass's package.

ClientType getClientType()
          Deprecated. Please use XXXX for User Agent information.

IPortalComponentContext getComponentContext()
          Gets the current context of the component.

IPortalComponentContext getComponentContext(NodeMode nodeMode)
          Gets the current context of the component for a particular mode

IPortalComponentContext getComponentContext(java.lang.String urn)
          This object allows to act as a factory for context objects.

IPortalComponentSession getComponentSession()
          gets a reference on the PortalComponentSession, that defines the component's view on a (servlet) session that is subject to time outs.

javax.servlet.http.Cookie[] getCookies()
          Deprecated. Please use the corresponding method on the servlet request object obtained by calling getServletRequest().

java.util.Locale getLocale()
          Retrieves the Locale associated with this request.

ILogger getLogger()
          Returns the default Logger.

ILogger getLogger(java.lang.String loggerName)
          Returns a logger associated to the logger name.

INode getNode()
          Gets the current node in the portal OM.

java.lang.String getParameter(java.lang.String name)
          gets a parameter of this request

java.lang.String getPrivateResourcePath()
          Returns the full file system path to access private resources that belong to the current component.

java.lang.String getPrivateResourcePath(java.lang.String componentName)
          Returns the full file system path to access private component resources.

java.lang.String getPublicResourcePath()
          Returns the full file system path to access public resources that belong to the current component.

java.lang.String getPublicResourcePath(java.lang.String componentName)
          Returns the full file system path to access public component resources.

java.lang.String getRedirectURL()
          Gets a currently set redirect URL or null if none was specified.

IPortalRequestEvent getRequestEvent()
          If applicable, gets the request event defined by the incoming request.

Guid getRequestGuid()
          Deprecated. Please handle GUIDs locally.

java.io.InputStream getRequestInputStream()
          Gets an InputStream that provides access to the request's body data.

java.lang.String getRequestTheme()
          Gets the theme associated with this request.

PortalComponentRequestType getRequestType()
          Deprecated. Instead of referring to request types, please use the mode information provided by the current node.

IResource getResource(java.lang.String resourceType, java.lang.String resourceName)
          Returns an IResource object that belongs to the current component.

IResource getResource(java.lang.String componentName, java.lang.String resourceType, java.lang.String resourceName)
          Returns an IResource object that belongs to the component.

java.util.ResourceBundle getResourceBundle()
          Retrieves the Portal Components default Resource Bundle, as specified in the Components profile or by using the default name defined by IPortalComponentProfile.DEFAULT_RESOURCE_BUNDLE.

IService getService(java.lang.String serviceName)
          Deprecated. Use access to services via PortalRuntime instead.

IService getService(java.lang.String serviceName, IServiceConfiguration aServiceConfiguration)
          Deprecated. Use access to services via PortalRuntime instead.

IService getService(java.lang.String serviceName, IServiceId aServiceID)
          Deprecated. Use access to services via PortalRuntime instead.

javax.servlet.ServletConfig getServletConfig()
          Gets the actual servlet config.

javax.servlet.http.HttpServletRequest getServletRequest()
          Gets the actual servlet request.

javax.servlet.http.HttpServletResponse getServletResponse(boolean answering)
          Gets the original servlet response.

IUserContext getUser()
          gets the profile of the current user.

java.lang.Object getValue(java.lang.String name)
          Retrieve a piece of data from the request.

java.lang.String getWebResourcePath()
          Returns a path to access to web resources that belong to the current component The generated path depends on some servlet settings (context name) provided by the request.

java.lang.String getWebResourcePath(java.lang.String componentName)
          Returns a URL to access to web resources that belong to the component.

java.lang.String getWebServicePath(java.lang.String serviceName)
          Deprecated. Please use getWebResourcePath(java.lang.String) instead.

boolean isResponseClean()
          Returns whether the servlet's response is still available for content procession by the runtime.

void putValue(java.lang.String name, java.lang.Object value)
          Put a piece of data into the request.

void redirect(java.lang.String location)
          Forces a redirect of the request to some other location.

void setNode(INode node)
          Sets the current node of this request.

void setRequestType(PortalComponentRequestType requestType)
          Deprecated. Instead of referring to request types, please use the mode information provided by the current node.

Method Detail

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

Gets the actual servlet config. Note: It is recommended not to access the servlet config if possible. This is only available, if the request was initiated from a servlet based connection.

Returns:: The actual servlet config, or null if not applicable

getServletRequest

public javax.servlet.http.HttpServletRequest getServletRequest()

Gets the actual servlet request. Note: It is recommended not to access the servlet request if possible. This is only available, if the request was initiated from a servlet based connection.

Returns:: The actual servlet request or null if not applicable

getServletResponse

public javax.servlet.http.HttpServletResponse getServletResponse(boolean answering)

Gets the original servlet response. Note: This should be accessed in extraordinary cases only. If the parameter is set to true all further content procession of the runtime will be skipped. This is only available, if the request was initiated from a servlet based connection.

Parameters:: answering - specificying whether it is intended by the caller to write into the response and thereby skip all further content procession by the runtime.
Returns:: The original servlet response of null if not applicable.

isResponseClean

public boolean isResponseClean()

Returns whether the servlet's response is still available for content procession by the runtime.

Returns:: whether the servlet's response is still available for content procession by the runtime.

getRequestInputStream

public java.io.InputStream getRequestInputStream()
                                          throws java.io.IOException

Gets an InputStream that provides access to the request's body data. Its content is buffered by the Runtime to provide access to any number of Portal Components

Returns:: the request input stream
Throws:: java.io.IOException -

getCookies

public javax.servlet.http.Cookie[] getCookies()

Deprecated. Please use the corresponding method on the servlet request object obtained by calling getServletRequest().

Gets the array of cookies provided by the client with the request

Returns:: An array of cookies from the request.

getRequestEvent

public IPortalRequestEvent getRequestEvent()

If applicable, gets the request event defined by the incoming request.

Returns:: The event provided by the request, null if none there.

getRequestType

public PortalComponentRequestType getRequestType()

Deprecated. Instead of referring to request types, please use the mode information provided by the current node.

Gets the type of this request

Returns:: The type of this request

getRequestTheme

public java.lang.String getRequestTheme()

Gets the theme associated with this request. This information can be used to do special rendering

Returns:: a theme identifier or null if not applicable.

setRequestType

public void setRequestType(PortalComponentRequestType requestType)

Deprecated. Instead of referring to request types, please use the mode information provided by the current node.

Sets the type of this request

Parameters:: requestType - The type of this request

getClientType

public ClientType getClientType()

Deprecated. Please use XXXX for User Agent information.

Gets the type of the client associated to thie request

Returns:: Information on the type of client that send the request

getComponentContext

public IPortalComponentContext getComponentContext()

Gets the current context of the component. This can be null, if no component context is assigned.

Returns:: The current context of the component

getComponentContext

public IPortalComponentContext getComponentContext(NodeMode nodeMode)

Gets the current context of the component for a particular mode

Parameters:: nodeMode - the node mode to retrieve the context for.
Returns:: The context corresponding to the specified mode. Note this can be a context resulting from a mode delegation.

getNode

public INode getNode()

Gets the current node in the portal OM.

Returns:: the current node.

setNode

public void setNode(INode node)

Sets the current node of this request. Note: usually you should not worry about setting the node of the request, but leave the responsibility to the runtime.

Parameters:: node - that needs to be attached to this request.

getComponentContext

public IPortalComponentContext getComponentContext(java.lang.String urn)

This object allows to act as a factory for context objects.
This method allows to obtain a context corresponding to the given urn.

Parameters:: urn - a URN specifying a Component Context.
Returns:: The component context specified by the URN

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value)

Put a piece of data into the request. This can be retrieved later during the request.

Parameters:: name - An identifier of the value; value - The object to be kept in the request

getValue

public java.lang.Object getValue(java.lang.String name)

Retrieve a piece of data from the request.

Parameters:: name - An identifier of the value
Returns:: The object that was kept in the request

getUser

public IUserContext getUser()

gets the profile of the current user.

Returns:: The current user.

getComponentSession

public IPortalComponentSession getComponentSession()

gets a reference on the PortalComponentSession, that defines the component's view on a (servlet) session that is subject to time outs.

Returns:: The portal component session

createPortalComponentURI

public IPortalComponentURI createPortalComponentURI()

Creates a new PortalComponentURI

Returns:: a new IPortalComponentURI

createComponentURL

public java.lang.String createComponentURL(INode targetNode,
                                           IPortalRequestEvent event)

Deprecated. use createPortalComponentURI instead

creates a url that refers to a node in the POM that a client event shall be sent to using it.

Parameters:: targetNode - The node that the URL is to point to.; event - The event to be passed by this URL.
Returns:: The generated URL.

createComponentURL

public java.lang.String createComponentURL(IPortalRequestEvent event)

Deprecated. use createPortalComponentURI instead

creates a url that refers to the current node in the POM that a client event shall be sent to using it.

Parameters:: event - The event to be passed by this URL.
Returns:: The generated URL.

createPageURL

public java.lang.String createPageURL(java.lang.String urn)

Deprecated. use createPortalComponentURI instead

Parameters:: urn - The URN of the context representing the new root component.
Returns:: The generated URL as a String

createPageURL

public java.lang.String createPageURL(java.lang.String urn,
                                      IPortalRequestEvent event)

Deprecated. use createPortalComponentURI instead

In contrast to createComponentURL(com.sapportals.portal.prt.pom.INode, com.sapportals.portal.prt.event.IPortalRequestEvent) this method generates a URL that replaces the root component of a subsequent request as specified by the context URN. context name. The passed on event will be fired on the new root component.

Parameters:: urn - The URN of the context representing the new root component.; event - The event to be fired on the top most Portal Component.
Returns:: The generated URL as a String

createPageURL

public java.lang.String createPageURL(java.lang.String urn,
                                      NodeMode mode)

Deprecated. use createPortalComponentURI instead

Parameters:: urn - The URN of the context representing the new root component.; mode - The mode to be set on the top most Portal Component.
Returns:: The generated URL as a String

redirect

public void redirect(java.lang.String location)

Forces a redirect of the request to some other location. To be effective this method must be called before the content phase. The Portal Builder Runtime will stop page procession as soon as possible but not before the content assembly phase.

Parameters:: location - A URL to redirect the request to.

getRedirectURL

public java.lang.String getRedirectURL()

Gets a currently set redirect URL or null if none was specified.

Returns:: a redirect URL.

getParameter

public java.lang.String getParameter(java.lang.String name)

gets a parameter of this request

Parameters:: name - The name of the parameter.

getResource

public IResource getResource(java.lang.String componentName,
                             java.lang.String resourceType,
                             java.lang.String resourceName)

Returns an IResource object that belongs to the component.

Example:

String componentName = request.getComponentContext().getComponentName(); IResource script = getResource(componentName, IResource.SCRIPT, "scripts/menu.js");

The component name specified must be the complete name including the profile name (i.e.: <par-file name>.<profile name>).

Parameters:: componentName - the component name; resourceType - the type of the resource; resourceName - the file name for the resource
Returns:: an IResource object
See Also:: getResource(String, String)

getResource

public IResource getResource(java.lang.String resourceType,
                             java.lang.String resourceName)

Returns an IResource object that belongs to the current component.

Example:

IResource script = getResource(IResource.SCRIPT, "scripts/menu.js");

The resourceName specified must be relative to the component resource path.
The IResource interface defines string constants for standard resource types.

Parameters:: resourceType - the type of the resource; resourceName - the file name for the resource
Returns:: an IResource object
See Also:: IResource, getPrivateResourcePath(), getPublicResourcePath(), getWebResourcePath(), IPortalComponentResponse.addResource(IResource)

getLogger

public ILogger getLogger(java.lang.String loggerName)

Returns a logger associated to the logger name.

Parameters:: loggerName - The logger name.
Returns:: A logger associated to the logger name.

getLogger

public ILogger getLogger()

Returns the default Logger.

Returns:: The default logger.

getClassLogger

public ILogger getClassLogger(java.lang.Class aClass)

Returns the logger associated to aClass's package.

Parameters:: aClass - The class which is calling the logger.
Returns:: The logger associated to aClass's package.

getService

public IService getService(java.lang.String serviceName)

Deprecated. Use access to services via PortalRuntime instead.

Returns a service of a specific name.

Parameters:: serviceName - name of the service to get
Returns:: the Service requested, null otherwise.
See Also:: IService

getService

public IService getService(java.lang.String serviceName,
                           IServiceId aServiceID)

Deprecated. Use access to services via PortalRuntime instead.

Gets a Service of a specific name and a given ID.

Parameters:: serviceName - name of the Service to access; aServiceID - the ID of the service to get
Returns:: the Service requested, null otherwise.
See Also:: IService, IServiceId

getService

public IService getService(java.lang.String serviceName,
                           IServiceConfiguration aServiceConfiguration)

Deprecated. Use access to services via PortalRuntime instead.

gets a service with a name and a service configuration.

Parameters:: serviceName - the name of the Service.; IServiceConfiguration - the configuration of the Servive; aServiceConfiguration -
Returns:: the Service requested, null otherwise.
See Also:: IService, IServiceConfiguration

createRequestEvent

public IPortalRequestEvent createRequestEvent(java.lang.String eventName)

Creates a request event.

Parameters:: eventName - the name of the event
Returns:: the Portal Request Event created with the event.
See Also:: IPortalRequestEvent

createRequestEvent

public IPortalRequestEvent createRequestEvent(java.lang.String eventName,
                                              IPortalRequestEventData eventData)

Creates a request event.

Parameters:: eventName - the name of the event; eventData - data to be passed on the event
Returns:: the Portal Request Event created with the event.
See Also:: IPortalRequestEvent

createRequestEventData

public IPortalRequestEventData createRequestEventData()

Creates an empty request event data object.

Returns:: An implementation of IPortalRequestEventData
See Also:: IPortalRequestEventData