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

All Known Implementing Classes:

HttpTransportContext, JmsTransportContext, TransportContext
```
public interface ITransportContext
```
Concrete classes of ITransportContext should wrap underlying transport objects. New transport context classes should be added for each new transport to be supported in OWSM. Particular transport would be used based on ITranportContext object set in message contexts using IMessageContext.setTransportContext() method. These ITransportContext objects can be retrieved using IMessageContext.getTransportContext() method. Underlying transport objects should never be exposed and retrieved from TransportContexts. These classes should implement transport specific behavior and consumers should consume exposed methods instead of directly dealing with transport objects otherwise it would make complete code tied to only that particular transport.

Author:

nihanda

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ITransportContext.TYPE

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ITransportContext.TYPE`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String JMS_MESSAGE_OBJ_NAME

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`JMS_MESSAGE_OBJ_NAME`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCookie(java.lang.Object cookie)`
`java.util.Map<java.lang.String,java.lang.String>`	`getAllHeaders()` Get all headers from local map
`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`
`java.lang.Object[]`	`getCookies()` Get cookies from underlying transport layer See `HttpServletRequest.getCookies`
`java.lang.String`	`getHeader(java.lang.String headerName)`
`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`	`getRequestURI()` Get RequestURI from underlying transport layer.
`java.lang.StringBuffer`	`getRequestURL()` Get RequestURL from underlying transport layer.
`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`
`ITransportContext.TYPE`	`getType()`
`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`	`setHeader(java.lang.String headerName, java.lang.String headerVal)`
`void`	`setResponseContentLength(int length)` See `HttpServletResponse.setContentLength`
`void`	`setResponseContentType(java.lang.String contentType)` See `HttpServletResponse.setContentType()`
`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 - Moved it here from message context objects, earlier it was in each separate message contexts
`void`	`setType(ITransportContext.TYPE type)`

- Field Detail
  - JMS_MESSAGE_OBJ_NAME
```
static final java.lang.String JMS_MESSAGE_OBJ_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setType
```
void setType(ITransportContext.TYPE type)
```
  - getType
```
ITransportContext.TYPE getType()
```
  - getHeader
```
java.lang.String getHeader(java.lang.String headerName)
```
  - setHeader
```
void setHeader(java.lang.String headerName,
               java.lang.String headerVal)
```
  - getAllHeaders
```
java.util.Map<java.lang.String,java.lang.String> getAllHeaders()
```
    Get all headers from local map
    
    Returns:
  - setTransportHeader
```
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 - Moved it here from message context objects, earlier it was in each separate message contexts
    
    Parameters:
    
    headerName -
    
    headerVal -
    
    agentFunction -
    
    Throws:
    
    WSMException
  - getTransportHeader
```
java.lang.String getTransportHeader(java.lang.String headerName)
```
    Get the header value from underlying transport layer
    
    Parameters:
    
    headerName -
    
    Returns:
  - getRequestURI
```
java.lang.String getRequestURI()
```
    Get RequestURI from underlying transport layer. See HttpServletRequest.getRequestURI
    
    Returns:
  - getRequestURL
```
java.lang.StringBuffer getRequestURL()
```
    Get RequestURL from underlying transport layer. See HttpServletRequest.getRequestURL
    
    Returns:
  - sendError
```
void sendError(int errorCode,
               java.lang.String msg)
        throws java.io.IOException
```
    Sends Error using underlying transport layer See HttpServletResponse.sendError
    
    Parameters:
    
    errorCode -
    
    msg -
    
    Throws:
    
    java.io.IOException
  - getCookies
```
java.lang.Object[] getCookies()
```
    Get cookies from underlying transport layer See HttpServletRequest.getCookies
    
    Returns:
  - getServerName
```
java.lang.String getServerName()
```
    Get server name from underlying transport layer See HttpServletRequest.getServerName
    
    Returns:
  - getServerPort
```
int getServerPort()
```
    Get server port from underlying transport layer See HttpServletRequest.getServerPort
    
    Returns:
  - getMethod
```
java.lang.String getMethod()
```
    Get HTTP method from underlying transport layer See HttpServletRequest.getMethod
    
    Returns:
  - isSecure
```
boolean isSecure()
```
    See HttpServletRequest.isSecure
    
    Returns:
  - hasRequest
```
boolean hasRequest()
```
    Checks if request object is null or not. Returns true if not null else false.
    
    Returns:
  - hasResponse
```
boolean hasResponse()
```
    Checks if response object is null or not Returns true if not null else false.
    
    Returns:
  - getParameter
```
java.lang.String getParameter(java.lang.String parameter)
```
    See HttpServletRequest.getParameter
    
    Parameters:
    
    parameter -
    
    Returns:
  - sendRedirect
```
void sendRedirect(java.lang.String redirectURL)
           throws java.io.IOException
```
    See HttpServletResponse.sendRedirect
    
    Parameters:
    
    redirectURL -
    
    Throws:
    
    java.io.IOException
  - getRemoteAddr
```
java.lang.String getRemoteAddr()
```
    See HttpServletRequest.getRemoteAddr
    
    Returns:
  - getAttribute
```
java.lang.Object getAttribute(java.lang.String name)
```
    See HttpServletRequst.getAttribute
  - setResponseContentLength
```
void setResponseContentLength(int length)
```
    See HttpServletResponse.setContentLength
    
    Parameters:
    
    length -
  - getQueryString
```
java.lang.String getQueryString()
```
    See HttpServletRequest.getQueryString
    
    Returns:
  - getContentType
```
java.lang.String getContentType()
```
    See HttpServletRequest.getContentType
    
    Returns:
  - getHeaderNames
```
java.util.Enumeration<java.lang.String> getHeaderNames()
```
    See HttpServletRequest.getHeaderNames
    
    Returns:
  - getTransportHeaders
```
java.util.Enumeration<java.lang.String> getTransportHeaders(java.lang.String name)
```
    See HttpServletRequest.getHeaders
    
    Returns:
  - getInputStream
```
java.io.InputStream getInputStream()
                            throws java.io.IOException
```
    See HttpServletRequest.getInputStream
    
    Returns:
    
    Throws:
    
    java.io.IOException
  - getContentLength
```
int getContentLength()
```
    See HttpServletRequest.getContentLength
    
    Returns:
  - getAuthType
```
java.lang.String getAuthType()
```
    See HttpServletRequest.getAuthType
    
    Returns:
  - getStatus
```
int getStatus()
```
    See HttpServletResponse.getStatus
    
    Returns:
  - getScheme
```
java.lang.String getScheme()
```
    See HttpServletRequest.getScheme()
    
    Returns:
  - setStatus
```
void setStatus(int status)
```
    See HttpServletResponse.setStatus()
    
    Parameters:
    
    status -
  - setResponseContentType
```
void setResponseContentType(java.lang.String contentType)
```
    See HttpServletResponse.setContentType()
    
    Parameters:
    
    status -
  - getOutputStream
```
java.io.OutputStream getOutputStream()
                              throws java.io.IOException
```
    See HttpServletRespons.getOutputStream()
    
    Parameters:
    
    status -
    
    Throws:
    
    java.io.IOException
  - getWriter
```
java.io.Writer getWriter()
                  throws java.io.IOException
```
    See HttpServletResponse.getWriter()
    
    Parameters:
    
    status -
    
    Throws:
    
    java.io.IOException
  - getPathInfo
```
java.lang.String getPathInfo()
```
    See HttpServletRequest.getPathInfo()
    
    Parameters:
    
    status -
  - addCookie
```
void addCookie(java.lang.Object cookie)
```

Interface ITransportContext

Nested Class Summary

Field Summary

Method Summary

Field Detail

JMS_MESSAGE_OBJ_NAME

Method Detail

setType

getType

getHeader

setHeader

getAllHeaders

setTransportHeader

getTransportHeader

getRequestURI

getRequestURL

sendError

getCookies

getServerName

getServerPort

getMethod

isSecure

hasRequest

hasResponse

getParameter

sendRedirect

getRemoteAddr

getAttribute

setResponseContentLength

getQueryString

getContentType

getHeaderNames

getTransportHeaders

getInputStream

getContentLength

getAuthType

getStatus

getScheme

setStatus

setResponseContentType

getOutputStream

getWriter

getPathInfo

addCookie