Package org.springframework.extensions.webscripts.portlet

Class WebScriptPortletRequest

java.lang.Object

org.springframework.extensions.webscripts.WebScriptRequestImpl

org.springframework.extensions.webscripts.WebScriptRequestURLImpl

org.springframework.extensions.webscripts.portlet.WebScriptPortletRequest

All Implemented Interfaces:

WebScriptRequest

public class WebScriptPortletRequest
extends WebScriptRequestURLImpl

JSR-168 Web Script Request

Author:

davidc

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALFPORTLETUSERNAME

Fields inherited from class org.springframework.extensions.webscripts.WebScriptRequestURLImpl

contextPath, pathInfo, queryArgs, queryArgsMulti, queryString, serviceMatch, servletPath

Fields inherited from class org.springframework.extensions.webscripts.WebScriptRequestImpl

logger, MULTIPART_FORM_DATA

Constructor Summary

Constructors

Constructor	Description
WebScriptPortletRequest(Runtime container, javax.portlet.PortletRequest req, java.lang.String[] scriptUrlParts, Match serviceMatch)	Construct
WebScriptPortletRequest(Runtime container, javax.portlet.PortletRequest req, java.lang.String scriptUrl, Match serviceMatch)	Construct

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAgent()	Get User Agent TODO: Expand on known agents
org.springframework.extensions.surf.util.Content	getContent()	Gets the request body as content
java.lang.String	getHeader(java.lang.String name)	Gets the value of the named header
java.lang.String[]	getHeaderNames()	Gets the names of all headers for this request
java.lang.String[]	getHeaderValues(java.lang.String name)	Gets the (array) value of the named header Note: An array of one item is returned when a "single value" named header is requested
javax.portlet.PortletRequest	getPortletRequest()	Gets the Portlet Request
java.lang.String	getServerPath()	Get server portion of the request e.g.

Methods inherited from class org.springframework.extensions.webscripts.WebScriptRequestURLImpl

getContextPath, getParameter, getParameterNames, getParameterValues, getPathInfo, getQueryString, getServiceContextPath, getServiceMatch, getServicePath, getURL, splitURL, splitURL, toString

Methods inherited from class org.springframework.extensions.webscripts.WebScriptRequestImpl

forceSuccessStatus, getContentType, getExtensionPath, getFormat, getFormatStyle, getJSONCallback, getRuntime, isGuest, parseContent

Methods inherited from class java.lang.Object

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

Field Detail

ALFPORTLETUSERNAME

public static final java.lang.String ALFPORTLETUSERNAME

See Also:

Constant Field Values

Constructor Detail

WebScriptPortletRequest

public WebScriptPortletRequest(Runtime container,
                               javax.portlet.PortletRequest req,
                               java.lang.String scriptUrl,
                               Match serviceMatch)

Construct

Parameters:

container - Runtime

req - PortletRequest

scriptUrl - String

serviceMatch - Match

WebScriptPortletRequest

public WebScriptPortletRequest(Runtime container,
                               javax.portlet.PortletRequest req,
                               java.lang.String[] scriptUrlParts,
                               Match serviceMatch)

Construct

Parameters:

container - Runtime

req - PortletRequest

scriptUrlParts - String[]

serviceMatch - Match

Method Detail

getPortletRequest

public javax.portlet.PortletRequest getPortletRequest()

Gets the Portlet Request

Returns:

Portlet Request

getServerPath

public java.lang.String getServerPath()

Description copied from interface: WebScriptRequest

Get server portion of the request e.g. scheme://host:port

Returns:

server path

getAgent

public java.lang.String getAgent()

Description copied from interface: WebScriptRequest

Get User Agent TODO: Expand on known agents

Returns:

MSIE / Firefox

getHeaderNames

public java.lang.String[] getHeaderNames()

Description copied from interface: WebScriptRequest

Gets the names of all headers for this request

Returns:

the names (empty, if none)

getHeader

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

Description copied from interface: WebScriptRequest

Gets the value of the named header

Parameters:

name - header name

Returns:

header value (or null, if header does not exist)

getHeaderValues

public java.lang.String[] getHeaderValues(java.lang.String name)

Description copied from interface: WebScriptRequest

Gets the (array) value of the named header Note: An array of one item is returned when a "single value" named header is requested

Parameters:

name - header name

Returns:

array of values (or null, if header does not exist)

getContent

public org.springframework.extensions.surf.util.Content getContent()

Description copied from interface: WebScriptRequest

Gets the request body as content

Returns:

request content (or null, if none)