PortletRequestContext (Apache Portals Applications Web Content 2 Application 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.portals.applications.webcontent2.portlet.proxy.PortletRequestContext

All Implemented Interfaces:

RequestContext
```
public class PortletRequestContext
extends Object
implements RequestContext
```
PortletRequest / PortletResponse abstraction needed for reverse proxy processing.

Constructor Summary

Constructors
Constructor and Description
`PortletRequestContext(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)` Constructs a `PortletRequestContext` with given portlet request and portlet response.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCookie(javax.servlet.http.Cookie cookie)` Adds the specified cookie to the response.
`Object`	`getAttribute(String name)` Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
`List<javax.servlet.http.Cookie>`	`getCookies()`
`String`	`getHeader(String name)` Returns the value of the specified request header as a String.
`Enumeration`	`getHeaderNames()` Returns an enumeration of all the header names this request contains.
`Enumeration`	`getHeaders(String name)` Returns all the values of the specified request header as an Enumeration of String objects.
`InputStream`	`getInputStream()` Retrieves a `java.io.InputStream` of the body of the request as binary data.
`String`	`getMethod()` Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
`String`	`getPathInfo()` Returns any extra path information associated with the URL the client sent when it made this request.
`javax.portlet.PortletRequest`	`getPortletRequest()` Returns the underlying portlet request.
`javax.portlet.PortletResponse`	`getPortletResponse()` Returns the underlying portlet response.
`String`	`getQueryString()` Returns the query string that is contained in the request URL after the path.
`String`	`getRequestBasePath()` Returns the base relative path of the request before the request path info.
`String`	`getScheme()` Returns the scheme of the request URI.
`String`	`getServerName()` Returns the host name of the server to which the request was sent.
`int`	`getServerPort()` Returns the port number to which the request was sent.
`Sink`	`getSink()` Returns the `Sink` instance used in the current reverse proxy processing.
`int`	`getStatus()`
`boolean`	`isSecure()` Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
`void`	`sendRedirect(String location)` Sends a temporary redirect response to the client using the specified redirect location URL.
`void`	`setHeader(String name, String value)` Sets a response header with the given name and value.
`void`	`setIntHeader(String name, int value)` Sets a response header with the given name and integer value.
`void`	`setStatus(int sc)` Sets the status code for this response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PortletRequestContext
```
public PortletRequestContext(javax.portlet.PortletRequest request,
                     javax.portlet.PortletResponse response)
```
    Constructs a PortletRequestContext with given portlet request and portlet response.
    
    Parameters:
    request -
    response -
- Method Detail
  - getPortletRequest
```
public javax.portlet.PortletRequest getPortletRequest()
```
    Returns the underlying portlet request.
    
    Returns:
  - getPortletResponse
```
public javax.portlet.PortletResponse getPortletResponse()
```
    Returns the underlying portlet response.
    
    Returns:
  - isSecure
```
public boolean isSecure()
```
    Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
    
    Specified by:
    
    isSecure in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.ServletRequest#isSecure()}., javax.portlet.PortletRequest#isSecure()}.
  - getScheme
```
public String getScheme()
```
    Returns the scheme of the request URI.
    
    Specified by:
    
    getScheme in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.ServletRequest#getScheme()}, javax.portlet.PortletRequest#getScheme()}.
  - getServerName
```
public String getServerName()
```
    Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address.
    
    Specified by:
    
    getServerName in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.ServletRequest#getServerName()}, javax.portlet.PortletRequest#getServerName()}.
  - getServerPort
```
public int getServerPort()
```
    Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on.
    
    Specified by:
    
    getServerPort in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.ServletRequest#getServerPort()}, javax.portlet.PortletRequest#getServerPort()}.
  - getMethod
```
public String getMethod()
```
    Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.
    
    Specified by:
    
    getMethod in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.http.HttpServletRequest#getMethod()}, javax.portlet.ClientDataRequest#getMethod()}
  - getRequestBasePath
```
public String getRequestBasePath()
```
    Returns the base relative path of the request before the request path info.
    Typically, in servlet runtime, it is either the concatenation of the request context path and the servlet path, or the concatenation of the request context path and the servlet filter mapping path prefix.
    
    For example, in servlet runtime, if the context path is '/webcontent2', the servlet path is '/rproxy' and the path info is '/a/b/c.html', then this method may return the concatenation of the context path and servlet path, '/webcontent2/rproxy'.
    
    Or, if a servlet filter used for reverse proxy in servlet runtime, and if the context path is '/webcontent2', the servlet filter mapping path is '/rproxy/*' and the remaining path info is '/a/b/c.html', then this method may return the concatenation of the context path and filter mapping path prefix, '/webcontent2/rproxy'.
    Note: Portlet runtime doesn't give a request path info unlike servlet runtime. So, an implementation for that kind of runtime may return an empty string and decide not to use this method.
    
    Specified by:
    
    getRequestBasePath in interface RequestContext
    
    Returns:
  - getPathInfo
```
public String getPathInfo()
```
    Returns any extra path information associated with the URL the client sent when it made this request. For example, in servlet runtime, if the relative URL is '/webcontent2/rproxy/a/b/c.html' where the context path is '/webcontent2' and the servlet path is '/rproxy', then this method should return '/a/b/c.html'.
    
    Specified by:
    
    getPathInfo in interface RequestContext
    
    Returns:
    See Also:
    org.apache.portals.applications.webcontent2.portlet.proxy.PortletRequestContext#getRequestBasePath()}
  - getAttribute
```
public Object getAttribute(String name)
```
    Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
    
    Specified by:
    
    getAttribute in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.ServletRequest#getAttribute()}, javax.portlet.PortletRequest#getAttribute()}
  - getQueryString
```
public String getQueryString()
```
    Returns the query string that is contained in the request URL after the path.
    Note: Portlet runtime doesn't give an HTTP request query string unlike servlet runtime. So, an implementation for that kind of runtime may return null and decide not to use this method.
    
    Specified by:
    
    getQueryString in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.http.HttpServletRequest#getQueryString()}, org.apache.portals.applications.webcontent2.portlet.proxy.PortletRequestContext#getQueryString()}
  - getHeaderNames
```
public Enumeration getHeaderNames()
```
    Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.
    Note: Portlet runtime doesn't have a method named getHeaderNames() unlike servlet runtime. So, an implementation for portlet runtime may invoke PortletRequest.getPropertyNames() internally instead because some portlet container implementations such as Apache Jetspeed-2 may return HTTP header names on the method call.
    
    Specified by:
    
    getHeaderNames in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.http.HttpServletRequest#getHeaderNames()}, javax.portlet.PortletRequest#getPropertyNames()}
  - getHeaders
```
public Enumeration getHeaders(String name)
```
    Returns all the values of the specified request header as an Enumeration of String objects.
    Note: Portlet runtime doesn't have a method named getHeaders(String) unlike servlet runtime. So, an implementation for portlet runtime may invoke javax.portlet.PortletRequest#getProperties() internally instead because some portlet container implementations such as Apache Jetspeed-2 may return HTTP headers on the method call.
    
    Specified by:
    
    getHeaders in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.http.HttpServletRequest#getHeaders(String)}, javax.portlet.PortletRequest#getProperties(String)}
  - getHeader
```
public String getHeader(String name)
```
    Returns the value of the specified request header as a String.
    Note: Portlet runtime doesn't have a method named getHeader(String) unlike servlet runtime. So, an implementation for portlet runtime may invoke PortletRequest.getProperty(String) internally instead because some portlet container implementations such as Apache Jetspeed-2 may return HTTP headers on the method call.
    
    Specified by:
    
    getHeader in interface RequestContext
    
    Returns:
    See Also:
    javax.servlet.http.HttpServletRequest#getHeader(String)}, javax.portlet.PortletRequest#getProperty(String)}
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Retrieves a java.io.InputStream of the body of the request as binary data.
    
    Specified by:
    
    getInputStream in interface RequestContext
    
    Returns:
    
    Throws:
    
    IOException
    See Also:
    javax.servlet.ServletRequest#getInputStream()}, javax.portlet.ClientDataRequest#getPortletInputStream()}
  - setStatus
```
public void setStatus(int sc)
```
    Sets the status code for this response.
    Note: Portlet runtime doesn't allow a portlet to set the response status code unlike servlet runtime. So, an implementation for portlet runtime may store it as a member without making any impact by itself.
    
    Specified by:
    
    setStatus in interface RequestContext
    
    See Also:
    javax.servlet.http.HttpServletResponse#setStatus(int)}, org.apache.portals.applications.webcontent2.portlet.proxy.PortletRequestContext#setStatus(int)}
  - getStatus
```
public int getStatus()
```
  - sendRedirect
```
public void sendRedirect(String location)
                  throws IOException
```
    Sends a temporary redirect response to the client using the specified redirect location URL.
    
    Specified by:
    
    sendRedirect in interface RequestContext
    
    Throws:
    
    IOException
    See Also:
    javax.servlet.http.HttpServletResponse#sendRedirect(String)}, javax.portlet.ActionResponse#sendRedirect(String)}
  - setHeader
```
public void setHeader(String name,
             String value)
```
    Sets a response header with the given name and value.
    Note: Portlet runtime doesn't have a method named setHeader(String, String) unlike servlet runtime. So, an implementation for portlet runtime may invoke javax.portlet.PortletRequest#setProperty(String, String) internally instead because some portlet container implementations such as Apache Jetspeed-2 may return HTTP headers on the method call.
    
    Specified by:
    
    setHeader in interface RequestContext
    
    See Also:
    javax.servlet.http.HttpServletResponse#setHeader(String, String)}, javax.portlet.PortletResponse#setProperty(String, String)}
  - setIntHeader
```
public void setIntHeader(String name,
                int value)
```
    Sets a response header with the given name and integer value.
    Note: Portlet runtime doesn't have a method named setIntHeader(String, int) unlike servlet runtime. So, an implementation for portlet runtime may invoke javax.portlet.PortletRequest#setProperty(String, String) internally instead because some portlet container implementations such as Apache Jetspeed-2 may return HTTP headers on the method call.
    
    Specified by:
    
    setIntHeader in interface RequestContext
    
    See Also:
    javax.servlet.http.HttpServletResponse#setIntHeader(String, String)}, javax.portlet.PortletResponse#setProperty(String, String)}
  - addCookie
```
public void addCookie(javax.servlet.http.Cookie cookie)
```
    Adds the specified cookie to the response.
    
    Specified by:
    
    addCookie in interface RequestContext
    
    See Also:
    javax.servlet.http.HttpServletResponse#addCookie(Cookie)}, javax.portlet.PortletResponse#addProperty(Cookie)}
  - getCookies
```
public List<javax.servlet.http.Cookie> getCookies()
```
  - getSink
```
public Sink getSink()
```
    Returns the Sink instance used in the current reverse proxy processing.
    
    Specified by:
    
    getSink in interface RequestContext
    
    Returns:

Class PortletRequestContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PortletRequestContext

Method Detail

getPortletRequest

getPortletResponse

isSecure

getScheme

getServerName

getServerPort

getMethod

getRequestBasePath

getPathInfo

getAttribute

getQueryString

getHeaderNames

getHeaders

getHeader

getInputStream

setStatus

getStatus

sendRedirect

setHeader

setIntHeader

addCookie

getCookies

getSink