com.ibm.wsspi.session

Interface ContextService


Deprecated.
  1. @Deprecated
  2. public interface ContextService
The ContextService interface represents the programming model for the context service in BPM. The BPM context service provides the ability to access and modify the execution context, and propagate the execution context to the downstream.

This interface is used by all WPS internal components. It includes not only all methods in the ContextService API, but also the methods which are available for the internal components.

See Also:
com.ibm.bpm.context.ContextService

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT
Deprecated. Copyright
  1. static
  2. ContextService
INSTANCE
Deprecated. The singleton to access ContextService.

Method Summary

Modifier and Type Method and Description
  1. com.ibm.websphere.sibx.smobo.ContextType
getContext()
Deprecated. Get the user context data from the current execution context.
  1. com.ibm.websphere.sibx.smobo.HeadersType
getHeaders()
Deprecated. Get the protocol headers in the current execution context The protocol headers type is represented by HeadersType.
  1. void
restoreUserContext(java.io.Serializable userContext)
Deprecated. Restore the UserContext to the current work area from a serializable object.
  1. void
restoreUserContextFromString(java.lang.String value)
Deprecated. Restore the UserContext to the current work area from a serailzed string.
  1. java.io.Serializable
saveUserContext()
Deprecated. Save the UserContext to a serializable object.
  1. java.lang.String
saveUserContextToString()
Deprecated. Save the UserContext in the current work area to a serialized string .
  1. void
setContext(com.ibm.websphere.sibx.smobo.ContextType context)
Deprecated. Set user context data to the current execution context.
  1. void
setHeaders(com.ibm.websphere.sibx.smobo.HeadersType headers)
Deprecated. Set the protocol headers to the current execution context.

Field Detail

  1. static final java.lang.String COPYRIGHT
Deprecated.
Copyright
See Also:

INSTANCE

  1. static final ContextService INSTANCE
Deprecated.
The singleton to access ContextService.

Method Detail

saveUserContextToString

  1. java.lang.String saveUserContextToString( )
Deprecated.
Save the UserContext in the current work area to a serialized string . It is used by the non-SCA bindings when they transforms the UserContext to the outbound message.
Returns:
the serialized string

restoreUserContextFromString

  1. void restoreUserContextFromString( java.lang.String value)
Deprecated.
Restore the UserContext to the current work area from a serailzed string. It is used by the non-SCA bindings when they transforms the inbound message to the UserContext.
Parameters:
value -

saveUserContext

  1. java.io.Serializable saveUserContext( )
Deprecated.
Save the UserContext to a serializable object. It is used by JMS/MQ bindings to improve performance when they save the user context to async response message.
Returns:
serializable user context

restoreUserContext

  1. void restoreUserContext(java.io.Serializable userContext)
Deprecated.
Restore the UserContext to the current work area from a serializable object. It is used by JMS/MQ bindings to improve performance when they restore the user context from async response message.
Parameters:
userContext -

getHeaders

  1. com.ibm.websphere.sibx.smobo.HeadersType getHeaders( )
Deprecated.
Get the protocol headers in the current execution context

The protocol headers type is represented by HeadersType.

Returns:
the protocol headers in current execution context
See Also:
HeadersType

setHeaders

  1. void setHeaders(com.ibm.websphere.sibx.smobo.HeadersType headers)
Deprecated.
Set the protocol headers to the current execution context.

If the input headers value is null, the protocol headers in current execution context will be removed.

The context service does not guarantee to propagate the context data if it is not set to current execution context.

Parameters:
headers - the protocol headers.
See Also:
HeadersType

getContext

  1. com.ibm.websphere.sibx.smobo.ContextType getContext( )
Deprecated.
Get the user context data from the current execution context.

The user context type is presented by ContextType

Returns:
the user context data in current execution context
See Also:
ContextType

setContext

  1. void setContext(com.ibm.websphere.sibx.smobo.ContextType context)
Deprecated.
Set user context data to the current execution context.

If the input context value is null, the user context data in the current context will be removed.

The context service does not guarantee to propagate the context data if it is not set to current execution context.

Parameters:
context - the user context data.