IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.clientserver
Interface ChannelContext

All Known Implementing Classes:
DSEChannelContext

public interface ChannelContext

The channel context interface provides a single object to store all the required information during the lifetime of the request. This is the interface for any request to the Multichannel Interface that is to be used to access the required state

Any object implementing this interface will have to provide:

  1. - The channel request
  2. - The channel response
  3. - The chanel driver
  4. - The channel session
  5. - The request data
  6. - The client device type


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.Object getChannelDriver()
          Returns the value of the channelDriver property.
 java.lang.Object getChannelRequest()
          Returns the value of the channelRequest property.
 java.lang.Object getChannelResponse()
          Returns the value of the channelResponse property.
 java.lang.Object getChannelSession()
          Returns the value of the channelSession property.
 java.lang.String getDeviceType()
          Returns the value of the deviceType property.
 KeyedCollection getRequestData()
          Returns the value of the requestData property.
 void setChannelDriver(java.lang.Object channelDriver)
          Sets the value of the channelDriver property.
 void setChannelSession(java.lang.Object channelSession)
          Sets the value of the channelSession property.
 void setDeviceType(java.lang.String device)
          Sets the value of the deviceType property.
 void setRequestData(KeyedCollection kColl)
          Sets the value of the kColl property.
 

Field Detail

COPYRIGHT

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

getChannelDriver

public java.lang.Object getChannelDriver()
Returns the value of the channelDriver property.

Returns:
Object - The current value of channelDriver.

getChannelRequest

public java.lang.Object getChannelRequest()
Returns the value of the channelRequest property.

Returns:
Object - The current value of channelRequest.

getChannelResponse

public java.lang.Object getChannelResponse()
Returns the value of the channelResponse property.

Returns:
Object - The current value of channelResponse.

getChannelSession

public java.lang.Object getChannelSession()
Returns the value of the channelSession property.

Returns:
Object - The current value of channelSession.

getDeviceType

public java.lang.String getDeviceType()
Returns the value of the deviceType property.

Returns:
String - The current value of deviceType.

getRequestData

public KeyedCollection getRequestData()
Returns the value of the requestData property.

Returns:
com.ibm.btt.base.KeyedCollection - The current value of requestData.

setChannelDriver

public void setChannelDriver(java.lang.Object channelDriver)
Sets the value of the channelDriver property.

Parameters:
channelDriver - Object The new value of the property.

setChannelSession

public void setChannelSession(java.lang.Object channelSession)
Sets the value of the channelSession property.

Parameters:
channelSession - Object The new value of the property.

setDeviceType

public void setDeviceType(java.lang.String device)
Sets the value of the deviceType property.

Parameters:
device - String The new value of the property.

setRequestData

public void setRequestData(KeyedCollection kColl)
Sets the value of the kColl property.

The request data should contain a keyed collection of request header information and request data information. Each of which is a keyed collection.

Parameters:
kColl - com.ibm.btt.base.KeyedCollection The new value of the reqwuest data.

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005