IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.clientserver
Interface ChannelDriver

All Known Implementing Classes:
BTTChannelDriver

public interface ChannelDriver

The ChannelDriver interface This is the interface to be used as a template for all new device types that are to use the Multichannel Interface This interface should also detail the extension points for all channel drivers.

Any object implementing this interface will have to provide:

  1. - Create the ChannelContext
  2. - Create the ChannelHandler
  3. - Parse the channel specific request header into request data
  4. - Parse the channel specific request data into request data
  5. - Perform any pre pocessing (Session Management)
  6. - Handle any exceptions thrown by the interface


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 ChannelContext createChannelContext(ChannelRequest req, ChannelResponse res)
          Creates a ChannelContext object with the req, res, driver attributes.
 void createChannelHandler(ChannelContext channelContext)
          Creates a ChannelHandler object with the channelContext attribute.
 void parseRequestData(ChannelContext channelContext)
          Parse the request data from the ChannelContext channel request Parse to the request data into the KeyedCollection at the data element
 void parseRequestHeader(ChannelContext channelContext)
          Parse the request header from the ChannelContext channel request Parse to the request header into the KeyedCollection at the header element
 void preProcessRequest(ChannelContext channelContext)
          Perform any session management/control required at the device level.
 void service(ChannelContext channelContext)
          Execute the channel framework logic
 

Field Detail

COPYRIGHT

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

createChannelContext

ChannelContext createChannelContext(ChannelRequest req,
                                    ChannelResponse res)
Creates a ChannelContext object with the req, res, driver attributes.

The parameters are passed as objects to support all potential channel drivers

Parameters:
req - java.lang.Object
res - java.lang.Object
driver - java.lang.Object
Returns:
com.ibm.btt.clientserver.ChannelContext - An instance of ChannelContext.

createChannelHandler

void createChannelHandler(ChannelContext channelContext)
                          throws java.lang.Exception
Creates a ChannelHandler object with the channelContext attribute.

Cache the ChannelHandler into the HandlerRegistry singleton. Use the device type and the btt.xml file to determine the handlers for the device

Parameters:
channelContext - com.ibm.btt.clientserver.ChannelContext
Throws:
java.lang.Exception

parseRequestData

void parseRequestData(ChannelContext channelContext)
                      throws java.lang.Exception
Parse the request data from the ChannelContext channel request

Parse to the request data into the KeyedCollection at the data element

Parameters:
channelContext - com.ibm.btt.clientserver.ChannelContext
Throws:
java.lang.Exception

parseRequestHeader

void parseRequestHeader(ChannelContext channelContext)
                        throws java.lang.Exception
Parse the request header from the ChannelContext channel request

Parse to the request header into the KeyedCollection at the header element

Parameters:
channelContext - com.ibm.btt.clientserver.ChannelContext
Throws:
java.lang.Exception

preProcessRequest

void preProcessRequest(ChannelContext channelContext)
                       throws DSECSSessionNotEstablishedException
Perform any session management/control required at the device level.

Insert the channel session into the ChannelContext

Parameters:
channelContext - com.ibm.btt.clientserver.ChannelContext
Throws:
DSECSSessionNotEstablishedException

service

void service(ChannelContext channelContext)
Execute the channel framework logic

Parameters:
channelContext -

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010