MPHttpServletRequestWrapper (Policy Manager API)

java.lang.Object
- javax.servlet.ServletRequestWrapper
- - javax.servlet.http.HttpServletRequestWrapper
  - - com.soa.agent.servlet.MPHttpServletRequestWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class MPHttpServletRequestWrapper
extends javax.servlet.http.HttpServletRequestWrapper
```
Wraps an HttpServletRequest object so that it can be passed safely through a filter chain that may change the original request.

Field Summary
- Fields inherited from interface javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Constructor and Description

MPHttpServletRequestWrapper(javax.servlet.http.HttpServletRequest request)
Constructs the wrapper with an HttpServletRequest.

Constructors
Constructor and Description
`MPHttpServletRequestWrapper(javax.servlet.http.HttpServletRequest request)` Constructs the wrapper with an HttpServletRequest.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getContent()` Returns the request content in bytes.
`int`	`getContentLength()` Returns the length of the HTTP request content.
`java.lang.String`	`getContentType()`
`java.lang.Object`	`getContext()` Returns the message context of the request that need to be available for processing the response (or fault).
`ExchangeStatus`	`getExchangeStatus()` Returns the action to take on the request.
`java.lang.String`	`getHeader(java.lang.String name)`
`java.util.Enumeration`	`getHeaders(java.lang.String name)`
`javax.servlet.ServletInputStream`	`getInputStream()` Returns a ServletInputStream for streaming in the request.
`java.io.BufferedReader`	`getReader()` Returns a BufferedReader for reading the servlet request.
`int`	`getRemotePort()`
`void`	`resetStream()` Resets the stream of the request so that the content can be re-read from the beginning using either a ServletInputStream or BufferedReader.
`void`	`setContent(byte[] content)` Changes the HTTP content of the request.
`void`	`setContentType(java.lang.String contentType)`
`void`	`setContext(java.lang.Object context)` Changes the message context of the request.
`void`	`setExchangeStatus(ExchangeStatus status)` Changes the action to take on the request.
`void`	`setInputStream(java.io.InputStream istrm)`
`java.lang.String`	`toString()`

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper
getAuthType, getContextPath, getCookies, getDateHeader, getHeaderNames, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole

Methods inherited from class javax.servlet.ServletRequestWrapper
getAttribute, getAttributeNames, getCharacterEncoding, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest

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

Methods inherited from interface javax.servlet.ServletRequest
getAttribute, getAttributeNames, getCharacterEncoding, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

- Constructor Detail
  - MPHttpServletRequestWrapper
```
public MPHttpServletRequestWrapper(javax.servlet.http.HttpServletRequest request)
```
    Constructs the wrapper with an HttpServletRequest.
    
    Parameters:
    
    request - HttpServletRequest to wrap.
- Method Detail
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException
```
    Returns a ServletInputStream for streaming in the request. The content may not be the original HttpServletRequest content if modified within the filter chain.
    
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getInputStream in class javax.servlet.ServletRequestWrapper
    
    Returns:
    
    ServletInputStream for streaming the HTTP content.
    
    Throws:
    
    java.io.IOException - thrown if unable to create the input stream.
  - setInputStream
```
public void setInputStream(java.io.InputStream istrm)
```
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeader in class javax.servlet.http.HttpServletRequestWrapper
  - getHeaders
```
public java.util.Enumeration getHeaders(java.lang.String name)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeaders in class javax.servlet.http.HttpServletRequestWrapper
  - getReader
```
public java.io.BufferedReader getReader()
                                 throws java.io.IOException
```
    Returns a BufferedReader for reading the servlet request. The content may not be the original HttpServletRequest content if modified within the filter chain.
    
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getReader in class javax.servlet.ServletRequestWrapper
    
    Returns:
    
    BufferedReader for reading the HTTP content.
    
    Throws:
    
    java.io.IOException - thrown if unable to create the reader.
  - setContent
```
public void setContent(byte[] content)
                throws java.io.IOException
```
    Changes the HTTP content of the request. Any subsequent call to get a ServletInputStream or BufferedReader will gain access to this new content. Any open PrintWriters or ServletOutputStreams will be closed as a result of this call and new ones will have to be obtained.
    
    Parameters:
    
    content - New HTTP content of the request in bytes.
    
    Throws:
    
    java.io.IOException - Thrown if unable to change the content.
  - getContent
```
public byte[] getContent()
                  throws java.io.IOException
```
    Returns the request content in bytes.
    
    Returns:
    
    HTTP content in bytes.
    
    Throws:
    
    java.io.IOException - Thrown if unable to return the content.
  - getContentLength
```
public int getContentLength()
```
    Returns the length of the HTTP request content. This may not be the original content length if the content is modified within the filter chain.
    
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getContentLength in class javax.servlet.ServletRequestWrapper
    
    Returns:
    
    integer containing the length of the request body or -1 if the length is not known
  - getExchangeStatus
```
public ExchangeStatus getExchangeStatus()
```
    Returns the action to take on the request.
    
    Returns:
    
    FilterAction to take.
  - setExchangeStatus
```
public void setExchangeStatus(ExchangeStatus status)
```
    Changes the action to take on the request.
    
    Parameters:
    
    action - FilterAction to take.
  - getContext
```
public java.lang.Object getContext()
```
    Returns the message context of the request that need to be available for processing the response (or fault).
    
    Returns:
    
    Object representing the message context.
  - setContext
```
public void setContext(java.lang.Object context)
```
    Changes the message context of the request. This will be used when processing the response (or fault).
    
    Parameters:
    
    context - Object representing the message context.
  - resetStream
```
public void resetStream()
                 throws java.io.IOException
```
    Resets the stream of the request so that the content can be re-read from the beginning using either a ServletInputStream or BufferedReader. Any open PrintWriters or ServletOutputStreams will be closed as a result of this call and new ones will have to be obtained.
    
    Throws:
    
    java.io.IOException - Thrown if unable to close an open stream.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getContentType
```
public java.lang.String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getContentType in class javax.servlet.ServletRequestWrapper
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRemotePort in class javax.servlet.ServletRequestWrapper

This software is the confidential and proprietary information of Akana, Inc. and is subject to copyright protection under laws of the United States of America and other countries. The use of this software should be in accordance with the license agreement terms you entered into with Akana, Inc.

Class MPHttpServletRequestWrapper

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

Methods inherited from class javax.servlet.ServletRequestWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.ServletRequest

Constructor Detail

MPHttpServletRequestWrapper

Method Detail

getInputStream

setInputStream

getHeader

getHeaders

getReader

setContent

getContent

getContentLength

getExchangeStatus

setExchangeStatus

getContext

setContext

resetStream

toString

getContentType

setContentType

getRemotePort