oracle.wsm.common.sdk

Class MessageContext

java.lang.Object

oracle.wsm.common.sdk.MessageContext

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IContext, IMessageContext

Direct Known Subclasses:

NormalizedMessageContext, RESTHttpMessageContext, SOAPBindingMessageContext, URLMessageContext, XMLMessageContext

public abstract class MessageContext
extends java.lang.Object
implements IMessageContext, java.lang.Cloneable

See Also:

Serialized Form

Nested Class Summary

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

IMessageContext.AgentTypeEnum, IMessageContext.AuthMethodEnum, IMessageContext.ReqOriginEnum, IMessageContext.REQUEST_TYPE, IMessageContext.STAGE, IMessageContext.TYPE

Field Summary

Fields

Modifier and Type	Field and Description
IMessageContext.AuthMethodEnum	authenticationMethod
protected ITransportContext	m_transportCtx
IMessageContext.ReqOriginEnum	requestOrigin

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

AGENT_CONTEXT, ASYNC_ORIGINAL_HTTP_REQUEST_HEADERS, ASYNC_REQ_REPLYTO_ELEM, AUTHN_METHOD, EMPTY_STRING, FAULT_PROCESSED_HEADERS, HTTP_SERVLET_REQUEST, IDENTITY_CONTEXT, IDENTITY_CONTEXT_ID, IDENTITY_CONTEXT_KEY, INITIALIZATION_CONTEXT_ENDPOINT_ADDRESS, IS_CLIENT_ACCESS_TOKEN, LEGACY_POLICY_OPERATION_MAP, LEGACY_POLICY_SET, LEGACYPOLICY_ENABLED, MESSAGE_CONTEXT_PROCESSED, OAUTH2_TOKEN_API_APPLICATION, OAUTH2_TOKEN_API_MODULE, OAUTH2_TOKEN_API_PATH, OAUTH2_TOKEN_API_REQUEST, OAUTH2_TOKEN_RESPONSE, OPERATION_ID, OPERATION_NAME, POLICY_REFERENCES_MAP, POLICY_SET, REMOTE_IP, REQUEST_BODY_ENCRYPTED, REQUEST_PROCESSED_HEADERS, REQUEST_URI, RESPONSE_PROCESSED_HEADERS, REST_PROCESS_CLIENT_RESPONSE, REST_PROCESS_RESPONSE, REST_REQUEST_CONTEXT, REST_RESPONSE_AUTH_HEADER, REST_RESPONSE_CONTEXT, SECURITY_SUBJECT, SESSION_ID, SESSION_SCT_TOKEN, USER_NAME, VIRTUAL_HOST_TYPE, WSDL_DEFINTION

Constructor Summary

Constructors

Constructor and Description
MessageContext()

Method Summary

Modifier and Type	Method and Description
void	cloneFrom(MessageContext origContext)
java.util.Map<java.lang.String,java.lang.Object>	getAllProperties() Get properties that is used by the execution engine during policy execution
IMessageContext.AuthMethodEnum	getAuthenticationMethod() This method returns the authentication method used to authentication.
java.lang.String	getGUID()
InvocationStatus	getInvocationStatus() InvocationMetric is used to collect system monitoring data.
java.lang.Object	getProperty(java.lang.String name) Get the value of the property identified by name
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()
IMessageContext.TYPE	getType()
void	resetInvocationStatus(InvocationStatus origStatus)
void	setAllProperties(java.util.Map<java.lang.String,java.lang.Object> properties) Set properties that can be used by the execution engine during policy execution
void	setProperty(java.lang.String name, java.lang.Object value) Set the value of the property identified by name
void	setRemoteAddr(java.lang.String remoteAddr)
void	setRequestType(IMessageContext.REQUEST_TYPE type)
void	setServiceID(java.lang.String id)
void	setServiceURL(java.lang.String url)
void	setStage(IMessageContext.STAGE stage)
void	setStartTime(long startTime)
void	setTransportContext(ITransportContext transCtx) Set transport Context to the message context.
void	setType(IMessageContext.TYPE type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getTransportContext

Field Detail

authenticationMethod

public IMessageContext.AuthMethodEnum authenticationMethod

requestOrigin

public IMessageContext.ReqOriginEnum requestOrigin

m_transportCtx

protected ITransportContext m_transportCtx

Constructor Detail

MessageContext

public MessageContext()

Method Detail

setType

public void setType(IMessageContext.TYPE type)

Specified by:

setType in interface IMessageContext

getType

public IMessageContext.TYPE getType()

Specified by:

getType in interface IMessageContext

setStage

public void setStage(IMessageContext.STAGE stage)

Specified by:

setStage in interface IMessageContext

getStage

public IMessageContext.STAGE getStage()

Specified by:

getStage in interface IMessageContext

setRequestType

public void setRequestType(IMessageContext.REQUEST_TYPE type)

Specified by:

setRequestType in interface IMessageContext

getRequestType

public IMessageContext.REQUEST_TYPE getRequestType()

Specified by:

getRequestType in interface IMessageContext

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Description copied from interface: IContext

Set the value of the property identified by name

Specified by:

setProperty in interface IContext

getProperty

public java.lang.Object getProperty(java.lang.String name)

Description copied from interface: IContext

Get the value of the property identified by name

Specified by:

getProperty in interface IContext

setAllProperties

public void setAllProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

Description copied from interface: IContext

Set properties that can be used by the execution engine during policy execution

Specified by:

setAllProperties in interface IContext

getAllProperties

public java.util.Map<java.lang.String,java.lang.Object> getAllProperties()

Description copied from interface: IContext

Get properties that is used by the execution engine during policy execution

Specified by:

getAllProperties in interface IContext

setServiceID

public void setServiceID(java.lang.String id)

Specified by:

setServiceID in interface IMessageContext

getServiceID

public java.lang.String getServiceID()

Specified by:

getServiceID in interface IMessageContext

setServiceURL

public void setServiceURL(java.lang.String url)

Specified by:

setServiceURL in interface IMessageContext

getServiceURL

public java.lang.String getServiceURL()

Specified by:

getServiceURL in interface IMessageContext

setRemoteAddr

public void setRemoteAddr(java.lang.String remoteAddr)

Specified by:

setRemoteAddr in interface IMessageContext

getRemoteAddr

public java.lang.String getRemoteAddr()

Specified by:

getRemoteAddr in interface IMessageContext

setStartTime

public void setStartTime(long startTime)

Specified by:

setStartTime in interface IMessageContext

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface IMessageContext

getGUID

public java.lang.String getGUID()

Specified by:

getGUID in interface IMessageContext

getInvocationStatus

public InvocationStatus getInvocationStatus()

InvocationMetric is used to collect system monitoring data. Pipelines and Steps can fill in the data as the invocation goes tho

Specified by:

getInvocationStatus in interface IMessageContext

Returns:

InvocationMetric

cloneFrom

public void cloneFrom(MessageContext origContext)
               throws WSMException

Throws:

WSMException

resetInvocationStatus

public void resetInvocationStatus(InvocationStatus origStatus)

getAuthenticationMethod

public IMessageContext.AuthMethodEnum getAuthenticationMethod()

Description copied from interface: IMessageContext

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.

Specified by:

getAuthenticationMethod in interface IMessageContext

Returns:

the authenticationMethod

getRequestOrigin

public IMessageContext.ReqOriginEnum getRequestOrigin()

Description copied from interface: IMessageContext

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.

Specified by:

getRequestOrigin in interface IMessageContext

Returns:

the requestOrigin The request origin

setTransportContext

public void setTransportContext(ITransportContext transCtx)

Description copied from interface: IMessageContext

Set transport Context to the message context. For Interceptor to call to set the appropriate transport context for both inbound and outbound

Specified by:

setTransportContext in interface IMessageContext