IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.cs.sessionpropagation
Interface SessionPropagation

All Known Implementing Classes:
SessionPropagationForJavaClient, SessionPropagationForJavaClientWithWorkArea, SessionPropagationWithSystemData, SessionPropagationWithWorkArea

public interface SessionPropagation

Session propagation will leverage on WebSphere Enterprise 5.0 Shared Work Area service. The work area service allows the developer to create a work area, insert data into it, and have it propagated to the next layer where the data can be used, ignored, or added even further for the next receiving layer. At the originating end, the client terminates the work area when processing is done.

And customer can turnoff the WorkArea when the application is running under WAS Base Edtion. To access and back-end BP service, the session ID and sub-sessionID will be encapsulated as System Data object into WSIFMessage. The key of System Data will be defined in WSDL file (end-user must follow the system data definition). When BP side receives the WSIFMessage, it will get the System Data from WSIFMessage using constant key at first if WorkArea is not available, and then retrieve the context data. This SessionPropagation Interface just encapsulate the Session Propagation operations; using WorkArea, then open WorkArea and set value into it; without WorkArea, generate SystemDatam object.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 BTTSystemData beginSessionPropagation()
          Begin SessionPropagation.
 void endSessionPropagation()
          End SessionPropagation.
 void setChannelContext(ChannelContext aChannelContext)
          Used to get Session Data from channelContext if context is not available
 void setContext(Context aContext)
          Set Context Object for retrieving session data
 void setHttpSession(javax.servlet.http.HttpSession sessionObject)
          Set HttpSession Object for retrieving session data
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

beginSessionPropagation

public BTTSystemData beginSessionPropagation()
                                      throws java.lang.Exception
Begin SessionPropagation. If using WorkArea, create WorkArea and set the session data into it; If non-WorkArea, generate SystemData object and return it;

Returns:
Object If using WorkArea, nothing should be returned; Otherwise, SystemData Object should be returned.
Throws:
java.lang.Exception - Any Exception when begin Session Propagation.

endSessionPropagation

public void endSessionPropagation()
                           throws java.lang.Exception
End SessionPropagation. If using WorkArea, end WorkArea; If non-WorkArea, nothing to do;

Throws:
java.lang.Exception - Any Exception when close Session Propagation.

setHttpSession

public void setHttpSession(javax.servlet.http.HttpSession sessionObject)
Set HttpSession Object for retrieving session data

Parameters:
sessionObject - session object

setContext

public void setContext(Context aContext)
Set Context Object for retrieving session data

Parameters:
aContext - Automaton Context

setChannelContext

public void setChannelContext(ChannelContext aChannelContext)
Used to get Session Data from channelContext if context is not available

Parameters:
aChannelContext - Channel Context including session data

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005