IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.channel
Interface ChannelRequest

All Known Implementing Classes:
AjaxChannelRequest, BTTChannelRequest, ExtendHttpChannelRequest, HttpChannelRequest, JavaAssignChannelRequest, JavaEstablishSessionRequest, JavaHttpChannelRequest, JavaProtocolChannelRequest, JSONHttpChannelRequest, MobileRequest, RemoteChannelRequest, RestChannelRequest, RestEstablishSessionRequest, SMSChannelRequest, XmlHttpChannelRequest

public interface ChannelRequest

The interface used to wrap the request object. So it can make the channel processing logic protocol independent.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.Object getAttribute(java.lang.String name)
          Get the attribute value from the request
 java.lang.String getCharacterEncoding()
           
 java.lang.Object getRequest()
          The channel request is a wrapper, so you can use this to get the underlying request object
 java.lang.String getSessionId(ChannelContext channelContext)
          Get the session id
 java.lang.String getUserType(ChannelContext channelContext)
          Get the user type of the channel, this is used to determine the client type.
 void parseRequestData(ChannelContext channelContext)
          Parse the request data of the request object
 void parseRequestHeader(ChannelContext channelContext)
          Parse the request header of the request object
 void preProcessRequest(ChannelContext channelContext)
          Pre-processing the request object, this can be used to check the session is established or not
 boolean runInSession(ChannelContext channelContext)
           
 void setAttribute(java.lang.String attribute, java.lang.Object value)
          Set the attribute value of the request
 void setCharacterEncoding(java.lang.String encoding)
          Set the character encoding of the request and the response
 

Field Detail

COPYRIGHT

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

getUserType

java.lang.String getUserType(ChannelContext channelContext)
Get the user type of the channel, this is used to determine the client type. So the channel driver use this to determine which channel the request is from.

Parameters:
channelContext - the channel context object
Returns:
the user type of the client

getCharacterEncoding

java.lang.String getCharacterEncoding()
Returns:
the character encoding of the request and the response

setCharacterEncoding

void setCharacterEncoding(java.lang.String encoding)
                          throws java.io.UnsupportedEncodingException
Set the character encoding of the request and the response

Parameters:
encoding - the character encoding
Throws:
java.io.UnsupportedEncodingException - if the encoding isn't supported

parseRequestData

void parseRequestData(ChannelContext channelContext)
                      throws java.lang.Exception
Parse the request data of the request object

Parameters:
channelContext - the channel context object
Throws:
java.lang.Exception - if error occur during parsing

parseRequestHeader

void parseRequestHeader(ChannelContext channelContext)
                        throws java.lang.Exception
Parse the request header of the request object

Parameters:
channelContext - the channel context object
Throws:
java.lang.Exception - if error occur during parsing

preProcessRequest

void preProcessRequest(ChannelContext channelContext)
                       throws DSECSSessionNotEstablishedException
Pre-processing the request object, this can be used to check the session is established or not

Parameters:
channelContext - the channel context object
Throws:
DSECSSessionNotEstablishedException - if the session isn't established

getSessionId

java.lang.String getSessionId(ChannelContext channelContext)
Get the session id

Parameters:
channelContext - the channel context object
Returns:
the session id

runInSession

boolean runInSession(ChannelContext channelContext)
Parameters:
channelContext - the channel context object
Returns:
true if it runs in session

setAttribute

void setAttribute(java.lang.String attribute,
                  java.lang.Object value)
Set the attribute value of the request

Parameters:
attribute - the attribute name
value - the attribute value

getRequest

java.lang.Object getRequest()
The channel request is a wrapper, so you can use this to get the underlying request object

Returns:
the underlying the request object

getAttribute

java.lang.Object getAttribute(java.lang.String name)
Get the attribute value from the request

Parameters:
name - the attribute name
Returns:
the attribute value

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011