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

All Superinterfaces:

IContext, java.io.Serializable

All Known Subinterfaces:

IHttpMessageContext, INormalizedMessageContext, IRESTHttpMessageContext, ISOAPBindingMessageContext, IURLMessageContext

All Known Implementing Classes:

MessageContext, NormalizedMessageContext, RESTHttpMessageContext, SOAPBindingMessageContext, URLMessageContext, XMLMessageContext
```
public interface IMessageContext
extends IContext
```
MessageContext used while executing a Policy

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IMessageContext.AgentTypeEnum` ENUM Definition for Agent type - Client, Service
`static class`	`IMessageContext.AuthMethodEnum` ENUM Definition for Authentication Methods
`static class`	`IMessageContext.ReqOriginEnum` ENUM Definition for Request Origin type.
`static class`	`IMessageContext.REQUEST_TYPE` ENUM Definition for Request Types from Client
`static class`	`IMessageContext.STAGE` ENUM Definition for MessageContext Stage values
`static class`	`IMessageContext.TYPE` ENUM Definition for MessageContext types.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AGENT_CONTEXT`
`static java.lang.String`	`ASYNC_ORIGINAL_HTTP_REQUEST_HEADERS`
`static java.lang.String`	`ASYNC_REQ_REPLYTO_ELEM`
`static java.lang.String`	`AUTHN_METHOD`
`static java.lang.String`	`EMPTY_STRING`
`static java.lang.String`	`FAULT_PROCESSED_HEADERS`
`static java.lang.String`	`HTTP_SERVLET_REQUEST`
`static java.lang.String`	`IDENTITY_CONTEXT`
`static java.lang.String`	`IDENTITY_CONTEXT_ID`
`static java.lang.String`	`IDENTITY_CONTEXT_KEY`
`static java.lang.String`	`INITIALIZATION_CONTEXT_ENDPOINT_ADDRESS`
`static java.lang.String`	`IS_CLIENT_ACCESS_TOKEN`
`static java.lang.String`	`LEGACY_POLICY_OPERATION_MAP`
`static java.lang.String`	`LEGACY_POLICY_SET`
`static java.lang.String`	`LEGACYPOLICY_ENABLED`
`static java.lang.String`	`MESSAGE_CONTEXT_PROCESSED`
`static java.lang.String`	`OAUTH2_TOKEN_API_APPLICATION`
`static java.lang.String`	`OAUTH2_TOKEN_API_MODULE`
`static java.lang.String`	`OAUTH2_TOKEN_API_PATH`
`static java.lang.String`	`OAUTH2_TOKEN_API_REQUEST`
`static java.lang.String`	`OAUTH2_TOKEN_RESPONSE`
`static java.lang.String`	`OAUTH2_TOKEN_TOBE_CACHED`
`static java.lang.String`	`OPERATION_ID`
`static java.lang.String`	`OPERATION_NAME`
`static java.lang.String`	`POLICY_REFERENCES_MAP`
`static java.lang.String`	`POLICY_SET`
`static java.lang.String`	`REMOTE_IP`
`static java.lang.String`	`REQUEST_BODY_ENCRYPTED`
`static java.lang.String`	`REQUEST_PROCESSED_HEADERS`
`static java.lang.String`	`REQUEST_URI`
`static java.lang.String`	`RESPONSE_PROCESSED_HEADERS`
`static java.lang.String`	`REST_PROCESS_CLIENT_RESPONSE`
`static java.lang.String`	`REST_PROCESS_RESPONSE`
`static java.lang.String`	`REST_REQUEST_CONTEXT`
`static java.lang.String`	`REST_RESPONSE_AUTH_HEADER`
`static java.lang.String`	`REST_RESPONSE_CONTEXT`
`static java.lang.String`	`SECURITY_SUBJECT`
`static java.lang.String`	`SESSION_ID`
`static java.lang.String`	`SESSION_SCT_TOKEN`
`static java.lang.String`	`USER_NAME`
`static java.lang.String`	`VIRTUAL_HOST_TYPE`
`static java.lang.String`	`WSDL_DEFINTION`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IMessageContext.AuthMethodEnum`	`getAuthenticationMethod()` This method returns the authentication method used to authentication.
`java.lang.String`	`getGUID()`
`InvocationStatus`	`getInvocationStatus()`
`java.lang.String`	`getRemoteAddr()`
`IMessageContext.ReqOriginEnum`	`getRequestOrigin()` This method returns the origin of the request.
`IMessageContext.REQUEST_TYPE`	`getRequestType()`
`java.lang.String`	`getServiceID()`
`java.lang.String`	`getServiceURL()`
`IMessageContext.STAGE`	`getStage()`
`long`	`getStartTime()`
`ITransportContext`	`getTransportContext()` Get transport context from the message context.
`IMessageContext.TYPE`	`getType()`
`void`	`setRemoteAddr(java.lang.String remoteAddr)`
`void`	`setRequestType(IMessageContext.REQUEST_TYPE requestType)`
`void`	`setServiceID(java.lang.String id)`
`void`	`setServiceURL(java.lang.String serviceURL)`
`void`	`setStage(IMessageContext.STAGE stage)`
`void`	`setStartTime(long time)`
`void`	`setTransportContext(ITransportContext transCtx)` Set transport Context to the message context.
`void`	`setType(IMessageContext.TYPE type)`

Methods inherited from interface oracle.wsm.common.sdk.IContext
getAllProperties, getProperty, setAllProperties, setProperty

- Field Detail
  - HTTP_SERVLET_REQUEST
```
static final java.lang.String HTTP_SERVLET_REQUEST
```
    See Also:
    
    Constant Field Values
  - REQUEST_PROCESSED_HEADERS
```
static final java.lang.String REQUEST_PROCESSED_HEADERS
```
    See Also:
    
    Constant Field Values
  - RESPONSE_PROCESSED_HEADERS
```
static final java.lang.String RESPONSE_PROCESSED_HEADERS
```
    See Also:
    
    Constant Field Values
  - FAULT_PROCESSED_HEADERS
```
static final java.lang.String FAULT_PROCESSED_HEADERS
```
    See Also:
    
    Constant Field Values
  - POLICY_SET
```
static final java.lang.String POLICY_SET
```
    See Also:
    
    Constant Field Values
  - OPERATION_NAME
```
static final java.lang.String OPERATION_NAME
```
    See Also:
    
    Constant Field Values
  - SECURITY_SUBJECT
```
static final java.lang.String SECURITY_SUBJECT
```
    See Also:
    
    Constant Field Values
  - IDENTITY_CONTEXT
```
static final java.lang.String IDENTITY_CONTEXT
```
    See Also:
    
    Constant Field Values
  - IDENTITY_CONTEXT_ID
```
static final java.lang.String IDENTITY_CONTEXT_ID
```
    See Also:
    
    Constant Field Values
  - IDENTITY_CONTEXT_KEY
```
static final java.lang.String IDENTITY_CONTEXT_KEY
```
    See Also:
    
    Constant Field Values
  - ASYNC_REQ_REPLYTO_ELEM
```
static final java.lang.String ASYNC_REQ_REPLYTO_ELEM
```
    See Also:
    
    Constant Field Values
  - ASYNC_ORIGINAL_HTTP_REQUEST_HEADERS
```
static final java.lang.String ASYNC_ORIGINAL_HTTP_REQUEST_HEADERS
```
    See Also:
    
    Constant Field Values
  - USER_NAME
```
static final java.lang.String USER_NAME
```
    See Also:
    
    Constant Field Values
  - AUTHN_METHOD
```
static final java.lang.String AUTHN_METHOD
```
    See Also:
    
    Constant Field Values
  - AGENT_CONTEXT
```
static final java.lang.String AGENT_CONTEXT
```
    See Also:
    
    Constant Field Values
  - MESSAGE_CONTEXT_PROCESSED
```
static final java.lang.String MESSAGE_CONTEXT_PROCESSED
```
    See Also:
    
    Constant Field Values
  - POLICY_REFERENCES_MAP
```
static final java.lang.String POLICY_REFERENCES_MAP
```
    See Also:
    
    Constant Field Values
  - SESSION_SCT_TOKEN
```
static final java.lang.String SESSION_SCT_TOKEN
```
    See Also:
    
    Constant Field Values
  - SESSION_ID
```
static final java.lang.String SESSION_ID
```
    See Also:
    
    Constant Field Values
  - REQUEST_BODY_ENCRYPTED
```
static final java.lang.String REQUEST_BODY_ENCRYPTED
```
    See Also:
    
    Constant Field Values
  - LEGACY_POLICY_SET
```
static final java.lang.String LEGACY_POLICY_SET
```
    See Also:
    
    Constant Field Values
  - LEGACY_POLICY_OPERATION_MAP
```
static final java.lang.String LEGACY_POLICY_OPERATION_MAP
```
    See Also:
    
    Constant Field Values
  - OPERATION_ID
```
static final java.lang.String OPERATION_ID
```
    See Also:
    
    Constant Field Values
  - WSDL_DEFINTION
```
static final java.lang.String WSDL_DEFINTION
```
    See Also:
    
    Constant Field Values
  - REMOTE_IP
```
static final java.lang.String REMOTE_IP
```
    See Also:
    
    Constant Field Values
  - LEGACYPOLICY_ENABLED
```
static final java.lang.String LEGACYPOLICY_ENABLED
```
    See Also:
    
    Constant Field Values
  - VIRTUAL_HOST_TYPE
```
static final java.lang.String VIRTUAL_HOST_TYPE
```
    See Also:
    
    Constant Field Values
  - INITIALIZATION_CONTEXT_ENDPOINT_ADDRESS
```
static final java.lang.String INITIALIZATION_CONTEXT_ENDPOINT_ADDRESS
```
    See Also:
    
    Constant Field Values
  - OAUTH2_TOKEN_API_REQUEST
```
static final java.lang.String OAUTH2_TOKEN_API_REQUEST
```
    See Also:
    
    Constant Field Values
  - OAUTH2_TOKEN_RESPONSE
```
static final java.lang.String OAUTH2_TOKEN_RESPONSE
```
    See Also:
    
    Constant Field Values
  - OAUTH2_TOKEN_API_APPLICATION
```
static final java.lang.String OAUTH2_TOKEN_API_APPLICATION
```
    See Also:
    
    Constant Field Values
  - OAUTH2_TOKEN_API_MODULE
```
static final java.lang.String OAUTH2_TOKEN_API_MODULE
```
    See Also:
    
    Constant Field Values
  - OAUTH2_TOKEN_API_PATH
```
static final java.lang.String OAUTH2_TOKEN_API_PATH
```
    See Also:
    
    Constant Field Values
  - OAUTH2_TOKEN_TOBE_CACHED
```
static final java.lang.String OAUTH2_TOKEN_TOBE_CACHED
```
    See Also:
    
    Constant Field Values
  - REST_PROCESS_RESPONSE
```
static final java.lang.String REST_PROCESS_RESPONSE
```
    See Also:
    
    Constant Field Values
  - REST_PROCESS_CLIENT_RESPONSE
```
static final java.lang.String REST_PROCESS_CLIENT_RESPONSE
```
    See Also:
    
    Constant Field Values
  - REST_RESPONSE_CONTEXT
```
static final java.lang.String REST_RESPONSE_CONTEXT
```
    See Also:
    
    Constant Field Values
  - REST_REQUEST_CONTEXT
```
static final java.lang.String REST_REQUEST_CONTEXT
```
    See Also:
    
    Constant Field Values
  - REST_RESPONSE_AUTH_HEADER
```
static final java.lang.String REST_RESPONSE_AUTH_HEADER
```
    See Also:
    
    Constant Field Values
  - EMPTY_STRING
```
static final java.lang.String EMPTY_STRING
```
    See Also:
    
    Constant Field Values
  - REQUEST_URI
```
static final java.lang.String REQUEST_URI
```
    See Also:
    
    Constant Field Values
  - IS_CLIENT_ACCESS_TOKEN
```
static final java.lang.String IS_CLIENT_ACCESS_TOKEN
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setType
```
void setType(IMessageContext.TYPE type)
```
  - getType
```
IMessageContext.TYPE getType()
```
  - setStage
```
void setStage(IMessageContext.STAGE stage)
```
  - getStage
```
IMessageContext.STAGE getStage()
```
  - setServiceID
```
void setServiceID(java.lang.String id)
```
  - getServiceID
```
java.lang.String getServiceID()
```
  - setRemoteAddr
```
void setRemoteAddr(java.lang.String remoteAddr)
```
  - getRemoteAddr
```
java.lang.String getRemoteAddr()
```
  - setServiceURL
```
void setServiceURL(java.lang.String serviceURL)
```
  - getServiceURL
```
java.lang.String getServiceURL()
```
  - setStartTime
```
void setStartTime(long time)
```
  - getStartTime
```
long getStartTime()
```
  - setRequestType
```
void setRequestType(IMessageContext.REQUEST_TYPE requestType)
```
  - getRequestType
```
IMessageContext.REQUEST_TYPE getRequestType()
```
  - getGUID
```
java.lang.String getGUID()
```
  - getInvocationStatus
```
InvocationStatus getInvocationStatus()
```
  - getAuthenticationMethod
```
IMessageContext.AuthMethodEnum getAuthenticationMethod()
```
    This method returns the authentication method used to authentication. if security token used for authentication was saml sender vouches, SAML_SV will be returned. if security token used for authentication was saml bearer, SAML_BEARER will be returned. if security token used for authentication was saml holder of key, SAML_HOK will be returned. if security token used for authentication was kerberos, KERBEROS will be returned. if security token used for authentication was username, USERNAME_TOKEN will be returned.
    
    Returns:
    
    the authenticationMethod
  - getRequestOrigin
```
IMessageContext.ReqOriginEnum getRequestOrigin()
```
    This method returns the origin of the request. If the request came from the internal private network, internal will be returned, else external or null will be returned. This feature will work only if there is an Oracle Http Server is present.
    
    Returns:
    
    the requestOrigin The request origin
  - setTransportContext
```
void setTransportContext(ITransportContext transCtx)
```
    Set transport Context to the message context. For Interceptor to call to set the appropriate transport context for both inbound and outbound
  - getTransportContext
```
ITransportContext getTransportContext()
```
    Get transport context from the message context. This method should be implemented in concrete message contexts and should return default message context if member object is null.
    
    Returns:
    
    object that implements ITransportContext

Interface IMessageContext

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface oracle.wsm.common.sdk.IContext

Field Detail

HTTP_SERVLET_REQUEST

REQUEST_PROCESSED_HEADERS

RESPONSE_PROCESSED_HEADERS

FAULT_PROCESSED_HEADERS

POLICY_SET

OPERATION_NAME

SECURITY_SUBJECT

IDENTITY_CONTEXT

IDENTITY_CONTEXT_ID

IDENTITY_CONTEXT_KEY

ASYNC_REQ_REPLYTO_ELEM

ASYNC_ORIGINAL_HTTP_REQUEST_HEADERS

USER_NAME

AUTHN_METHOD

AGENT_CONTEXT

MESSAGE_CONTEXT_PROCESSED

POLICY_REFERENCES_MAP

SESSION_SCT_TOKEN

SESSION_ID

REQUEST_BODY_ENCRYPTED

LEGACY_POLICY_SET

LEGACY_POLICY_OPERATION_MAP

OPERATION_ID

WSDL_DEFINTION

REMOTE_IP

LEGACYPOLICY_ENABLED

VIRTUAL_HOST_TYPE

INITIALIZATION_CONTEXT_ENDPOINT_ADDRESS

OAUTH2_TOKEN_API_REQUEST

OAUTH2_TOKEN_RESPONSE

OAUTH2_TOKEN_API_APPLICATION

OAUTH2_TOKEN_API_MODULE

OAUTH2_TOKEN_API_PATH

OAUTH2_TOKEN_TOBE_CACHED

REST_PROCESS_RESPONSE

REST_PROCESS_CLIENT_RESPONSE

REST_RESPONSE_CONTEXT

REST_REQUEST_CONTEXT

REST_RESPONSE_AUTH_HEADER

EMPTY_STRING

REQUEST_URI

IS_CLIENT_ACCESS_TOKEN

Method Detail

setType

getType

setStage

getStage

setServiceID

getServiceID

setRemoteAddr

getRemoteAddr

setServiceURL

getServiceURL

setStartTime

getStartTime

setRequestType

getRequestType

getGUID

getInvocationStatus

getAuthenticationMethod

getRequestOrigin

setTransportContext

getTransportContext