HttpTransportContext (Oracle Fusion Middleware Java API Reference for Oracle Web Services Manager for JRF)

java.lang.Object
- oracle.wsm.common.sdk.TransportContext
- - oracle.wsm.common.sdk.HttpTransportContext

All Implemented Interfaces:: ITransportContext

public class HttpTransportContext
extends TransportContext

Nested Class Summary
- Nested classes/interfaces inherited from interface oracle.wsm.common.sdk.ITransportContext
  ITransportContext.TYPE

Field Summary
- Fields inherited from interface oracle.wsm.common.sdk.ITransportContext
  JMS_MESSAGE_OBJ_NAME

Constructor Summary

Constructors
Constructor and Description
`HttpTransportContext()` For outbound message processing.
`HttpTransportContext(boolean doGenerateRequestResponse)` This method ensures that a proxy HttpServletRequest/HttpServletResponse is created.
`HttpTransportContext(javax.servlet.http.HttpServletRequest httpServletReq, javax.servlet.http.HttpServletResponse httpServletResp)` For inbound message processing, as server agent

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCookie(java.lang.Object cookie)`
`java.lang.Object`	`getAttribute(java.lang.String name)` See `HttpServletRequst.getAttribute`
`java.lang.String`	`getAuthType()` See `HttpServletRequest.getAuthType`
`int`	`getContentLength()` See `HttpServletRequest.getContentLength`
`java.lang.String`	`getContentType()` See `HttpServletRequest.getContentType`
`javax.servlet.http.Cookie[]`	`getCookies()` Get cookies from underlying transport layer See `HttpServletRequest.getCookies`
`java.util.Enumeration<java.lang.String>`	`getHeaderNames()` See `HttpServletRequest.getHeaderNames`
`java.io.InputStream`	`getInputStream()` See `HttpServletRequest.getInputStream`
`java.lang.String`	`getMethod()` Get HTTP method from underlying transport layer See `HttpServletRequest.getMethod`
`java.io.OutputStream`	`getOutputStream()` See `HttpServletRespons.getOutputStream()`
`java.lang.String`	`getParameter(java.lang.String parameter)` See `HttpServletRequest.getParameter`
`java.lang.String`	`getPathInfo()` See `HttpServletRequest.getPathInfo()`
`java.lang.String`	`getQueryString()` See `HttpServletRequest.getQueryString`
`java.lang.String`	`getRemoteAddr()` See `HttpServletRequest.getRemoteAddr`
`java.lang.String`	`getRemoteHost()`
`int`	`getRemotePort()`
`java.lang.String`	`getRequestURI()` Get RequestURI from underlying transport layer.
`java.lang.StringBuffer`	`getRequestURL()` Get RequestURL from underlying transport layer.
`int`	`getResponseStatus()` Returns response code
`java.lang.String`	`getScheme()` See `HttpServletRequest.getScheme()`
`java.lang.String`	`getServerName()` Get server name from underlying transport layer See `HttpServletRequest.getServerName`
`int`	`getServerPort()` Get server port from underlying transport layer See `HttpServletRequest.getServerPort`
`int`	`getStatus()` See `HttpServletResponse.getStatus`
`java.lang.String`	`getTransportHeader(java.lang.String headerName)` Get the header value from underlying transport layer
`java.util.Enumeration<java.lang.String>`	`getTransportHeaders(java.lang.String name)` See `HttpServletRequest.getHeaders`
`java.security.Principal`	`getUserPrincipal()`
`java.io.Writer`	`getWriter()` See `HttpServletResponse.getWriter()`
`boolean`	`hasRequest()` Checks if request object is null or not.
`boolean`	`hasResponse()` Checks if response object is null or not Returns true if not null else false.
`boolean`	`isSecure()` See `HttpServletRequest.isSecure`
`void`	`sendError(int errorCode, java.lang.String msg)` Sends Error using underlying transport layer See `HttpServletResponse.sendError`
`void`	`sendRedirect(java.lang.String redirectURL)` See `HttpServletResponse.sendRedirect`
`void`	`setClientCertificate(java.security.cert.X509Certificate[] certificates)` sets client side certificate for 2 way ssl
`void`	`setHeader(java.lang.String headerName, java.lang.String headerVal)` sets transport header
`void`	`setIsSecure(boolean isSecure)` returns true if request is made over ssl and is secure
`void`	`setRemoteAddr(java.lang.String remoteHost)` sets the host name of the remote client
`void`	`setResponseContentLength(int length)` See `HttpServletResponse.setContentLength`
`void`	`setResponseContentType(java.lang.String contentType)` See `HttpServletResponse.setContentType()`
`void`	`setResponseStatus(int responseStatus)` Deprecated. - use setStatus() Sets response code to be made available to calling WS stack
`void`	`setStatus(int status)` See `HttpServletResponse.setStatus()`
`void`	`setTransportHeader(java.lang.String headerName, java.lang.String headerVal, java.lang.String agentFunction)` Service agent uses it for inbound message processing with processResponse This method is not used for setting header for client so agentFunction is always service.

Methods inherited from class oracle.wsm.common.sdk.TransportContext
getAllHeaders, getHeader, getType, setType

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

- Constructor Detail
  - HttpTransportContext
```
public HttpTransportContext(javax.servlet.http.HttpServletRequest httpServletReq,
                            javax.servlet.http.HttpServletResponse httpServletResp)
```
    For inbound message processing, as server agent
    
    Parameters:
    
    jmsMsg -
  - HttpTransportContext
```
public HttpTransportContext()
```
    For outbound message processing. Client Agent construct
  - HttpTransportContext
```
public HttpTransportContext(boolean doGenerateRequestResponse)
```
    This method ensures that a proxy HttpServletRequest/HttpServletResponse is created. The properties set on HttpTransportContext are retrieved from HttpServletRequest/HttpServletResponse during execution of policies
    
    Parameters:
    
    doGenerateRequestResponse -
- Method Detail
  - setHeader
```
public void setHeader(java.lang.String headerName,
                      java.lang.String headerVal)
```
    sets transport header
    
    Specified by:
    
    setHeader in interface ITransportContext
    
    Overrides:
    
    setHeader in class TransportContext
    
    Parameters:
    
    headerName -
    
    headerVal -
  - setTransportHeader
```
public void setTransportHeader(java.lang.String headerName,
                               java.lang.String headerVal,
                               java.lang.String agentFunction)
                        throws WSMException
```
    Service agent uses it for inbound message processing with processResponse This method is not used for setting header for client so agentFunction is always service. For setting client side headers other ways are used.
    
    Throws:
    
    WSMException
  - setRemoteAddr
```
public void setRemoteAddr(java.lang.String remoteHost)
```
    sets the host name of the remote client
    
    Parameters:
    
    remoteHost -
  - setIsSecure
```
public void setIsSecure(boolean isSecure)
```
    returns true if request is made over ssl and is secure
    
    Parameters:
    
    isSecure -
  - setClientCertificate
```
public void setClientCertificate(java.security.cert.X509Certificate[] certificates)
```
    sets client side certificate for 2 way ssl
    
    Parameters:
    
    certificate -
  - getResponseStatus
```
public int getResponseStatus()
```
    Returns response code
    
    Returns:
  - setResponseStatus
```
public void setResponseStatus(int responseStatus)
```
    Deprecated. - use setStatus() Sets response code to be made available to calling WS stack
  - getTransportHeader
```
public java.lang.String getTransportHeader(java.lang.String headerName)
```
    Description copied from interface: ITransportContext
    
    Get the header value from underlying transport layer
    
    Returns:
  - getRequestURI
```
public java.lang.String getRequestURI()
```
    Description copied from interface: ITransportContext
    
    Get RequestURI from underlying transport layer. See HttpServletRequest.getRequestURI
    
    Returns:
  - getUserPrincipal
```
public java.security.Principal getUserPrincipal()
```
  - getRequestURL
```
public java.lang.StringBuffer getRequestURL()
```
    Description copied from interface: ITransportContext
    
    Get RequestURL from underlying transport layer. See HttpServletRequest.getRequestURL
    
    Returns:
  - sendError
```
public void sendError(int errorCode,
                      java.lang.String msg)
               throws java.io.IOException
```
    Description copied from interface: ITransportContext
    
    Sends Error using underlying transport layer See HttpServletResponse.sendError
    
    Throws:
    
    java.io.IOException
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Description copied from interface: ITransportContext
    
    Get cookies from underlying transport layer See HttpServletRequest.getCookies
    
    Returns:
  - getServerName
```
public java.lang.String getServerName()
```
    Description copied from interface: ITransportContext
    
    Get server name from underlying transport layer See HttpServletRequest.getServerName
    
    Returns:
  - getServerPort
```
public int getServerPort()
```
    Description copied from interface: ITransportContext
    
    Get server port from underlying transport layer See HttpServletRequest.getServerPort
    
    Returns:
  - getMethod
```
public java.lang.String getMethod()
```
    Description copied from interface: ITransportContext
    
    Get HTTP method from underlying transport layer See HttpServletRequest.getMethod
    
    Returns:
  - isSecure
```
public boolean isSecure()
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.isSecure
    
    Returns:
  - hasRequest
```
public boolean hasRequest()
```
    Description copied from interface: ITransportContext
    
    Checks if request object is null or not. Returns true if not null else false.
    
    Returns:
  - hasResponse
```
public boolean hasResponse()
```
    Description copied from interface: ITransportContext
    
    Checks if response object is null or not Returns true if not null else false.
    
    Returns:
  - getParameter
```
public java.lang.String getParameter(java.lang.String parameter)
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getParameter
    
    Returns:
  - sendRedirect
```
public void sendRedirect(java.lang.String redirectURL)
                  throws java.io.IOException
```
    Description copied from interface: ITransportContext
    
    See HttpServletResponse.sendRedirect
    
    Throws:
    
    java.io.IOException
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getRemoteAddr
    
    Returns:
  - getRemotePort
```
public int getRemotePort()
```
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String name)
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequst.getAttribute
  - setResponseContentLength
```
public void setResponseContentLength(int length)
```
    Description copied from interface: ITransportContext
    
    See HttpServletResponse.setContentLength
  - getQueryString
```
public java.lang.String getQueryString()
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getQueryString
    
    Returns:
  - getContentType
```
public java.lang.String getContentType()
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getContentType
    
    Returns:
  - getHeaderNames
```
public java.util.Enumeration<java.lang.String> getHeaderNames()
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getHeaderNames
    
    Returns:
  - getTransportHeaders
```
public java.util.Enumeration<java.lang.String> getTransportHeaders(java.lang.String name)
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getHeaders
    
    Returns:
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getInputStream
    
    Returns:
    
    Throws:
    
    java.io.IOException
  - getContentLength
```
public int getContentLength()
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getContentLength
    
    Returns:
  - getAuthType
```
public java.lang.String getAuthType()
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getAuthType
    
    Returns:
  - getStatus
```
public int getStatus()
```
    Description copied from interface: ITransportContext
    
    See HttpServletResponse.getStatus
    
    Returns:
  - getScheme
```
public java.lang.String getScheme()
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getScheme()
    
    Returns:
  - setStatus
```
public void setStatus(int status)
```
    Description copied from interface: ITransportContext
    
    See HttpServletResponse.setStatus()
  - setResponseContentType
```
public void setResponseContentType(java.lang.String contentType)
```
    Description copied from interface: ITransportContext
    
    See HttpServletResponse.setContentType()
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
```
    Description copied from interface: ITransportContext
    
    See HttpServletRespons.getOutputStream()
    
    Throws:
    
    java.io.IOException
  - getWriter
```
public java.io.Writer getWriter()
                         throws java.io.IOException
```
    Description copied from interface: ITransportContext
    
    See HttpServletResponse.getWriter()
    
    Throws:
    
    java.io.IOException
  - getPathInfo
```
public java.lang.String getPathInfo()
```
    Description copied from interface: ITransportContext
    
    See HttpServletRequest.getPathInfo()
  - addCookie
```
public void addCookie(java.lang.Object cookie)
```

Class HttpTransportContext

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.wsm.common.sdk.ITransportContext

Field Summary

Fields inherited from interface oracle.wsm.common.sdk.ITransportContext

Constructor Summary

Method Summary

Methods inherited from class oracle.wsm.common.sdk.TransportContext

Methods inherited from class java.lang.Object

Constructor Detail

HttpTransportContext

HttpTransportContext

HttpTransportContext

Method Detail

setHeader

setTransportHeader

setRemoteAddr

setIsSecure

setClientCertificate

getResponseStatus

setResponseStatus

getTransportHeader

getRequestURI

getUserPrincipal

getRequestURL

sendError

getCookies

getServerName

getServerPort

getMethod

isSecure

hasRequest

hasResponse

getParameter

sendRedirect

getRemoteAddr

getRemotePort

getRemoteHost

getAttribute

setResponseContentLength

getQueryString

getContentType

getHeaderNames

getTransportHeaders

getInputStream

getContentLength

getAuthType

getStatus

getScheme

setStatus

setResponseContentType

getOutputStream

getWriter

getPathInfo

addCookie