IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.channel.sms.config
Class OutboundHandlerConfiguration

java.lang.Object
  extended by com.ibm.btt.channel.sms.config.OutboundHandlerConfiguration

public class OutboundHandlerConfiguration
extends java.lang.Object

Configuration for Outbound Handler. Data bean can be initialized by the configuration file of element factory.


Field Summary
(package private)  java.lang.String account
           
(package private)  DLRHandlerConfiguration dlrConfig
           
(package private)  java.lang.String encoding
           
(package private)  java.lang.String from
           
(package private)  java.lang.String hostName
           
(package private)  boolean httpsEnabled
           
(package private)  ParameterNames parameterNames
           
(package private)  java.lang.String password
           
(package private)  java.lang.String port
           
(package private)  java.lang.String programName
           
(package private)  java.util.Map selfDefineParameters
           
(package private)  java.lang.Integer timeout
           
(package private)  java.lang.String to
           
(package private)  boolean xmlHttp
           
 
Constructor Summary
OutboundHandlerConfiguration()
           
 
Method Summary
 java.lang.String getAccount()
          Account ID on SMS gateway
 DLRHandlerConfiguration getDlrConfig()
          Delivery Report configuration.
 java.lang.String getEncoding()
          Char set encoding to encode the request data
 java.lang.String getFrom()
          The originator number who sent the SMS
 java.lang.String getHostName()
          Gateway�s hostname or IP
 boolean getHttpsEnabled()
          If Enable HTTPS (default: false)
 ParameterNames getParameterNames()
          Parameter names uses to build the HTTP URL content.
 java.lang.String getPassword()
          Password of account ID on SMS gateway
 java.lang.String getPort()
          Port number of SMS gateway
 java.lang.String getProgramName()
          Program name of gateway to send message
 java.util.Map getSelfDefineParameters()
          Besides the standard parameter like : from/to number, message etc, Some SMS gateway supports specific parameter, these special parameter is a map.
 java.lang.Integer getTimeout()
           
 java.lang.String getTo()
          The phone number the message is sent to
 boolean getXmlHttp()
          Content type of HTTP request from SMS gateway (default : false)
 void setAccount(java.lang.String account)
          Account ID on SMS gateway
 void setDlrConfig(DLRHandlerConfiguration dlrConfig)
          Delivery Report configuration.
 void setEncoding(java.lang.String encoding)
          Char set encoding to encode the request data
 void setFrom(java.lang.String from)
          The originator number who sent the SMS
 void setHostName(java.lang.String hostName)
          Gateway�s hostname or IP
 void setHttpsEnabled(boolean httpsEnabled)
          Enable HTTPS (default: false)
 void setParameterNames(ParameterNames parameterNames)
          Parameter names uses to build the HTTP URL content.
 void setPassword(java.lang.String password)
          Password of account ID on SMS gateway
 void setPort(java.lang.String port)
          Port number of SMS gateway
 void setProgramName(java.lang.String programName)
          Program name of gateway to send message
 void setSelfDefineParameters(java.util.Map selfDefParam)
          Besides the standard parameter like : from/to number, message etc, Some SMS gateway supports specific parameter, these special parameter is a map.
 void setTimeout(java.lang.Integer timeout)
           
 void setTo(java.lang.String to)
          The phone number the message is sent to
 void setXmlHttp(boolean xmlHttp)
          xml/text content type of HTTP request from SMS gateway
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

httpsEnabled

boolean httpsEnabled

hostName

java.lang.String hostName

port

java.lang.String port

programName

java.lang.String programName

account

java.lang.String account

password

java.lang.String password

to

java.lang.String to

from

java.lang.String from

timeout

java.lang.Integer timeout

encoding

java.lang.String encoding

xmlHttp

boolean xmlHttp

selfDefineParameters

java.util.Map selfDefineParameters

parameterNames

ParameterNames parameterNames

dlrConfig

DLRHandlerConfiguration dlrConfig
Constructor Detail

OutboundHandlerConfiguration

public OutboundHandlerConfiguration()
Method Detail

getTimeout

public java.lang.Integer getTimeout()

setTimeout

public void setTimeout(java.lang.Integer timeout)

getHostName

public java.lang.String getHostName()
Gateway�s hostname or IP

Returns:

setHostName

public void setHostName(java.lang.String hostName)
Gateway�s hostname or IP

Parameters:
hostName -

getPort

public java.lang.String getPort()
Port number of SMS gateway

Returns:

setPort

public void setPort(java.lang.String port)
Port number of SMS gateway

Parameters:
port -

getProgramName

public java.lang.String getProgramName()
Program name of gateway to send message

Returns:

setProgramName

public void setProgramName(java.lang.String programName)
Program name of gateway to send message

Parameters:
programName -

getAccount

public java.lang.String getAccount()
Account ID on SMS gateway

Returns:

setAccount

public void setAccount(java.lang.String account)
Account ID on SMS gateway

Parameters:
account -

getPassword

public java.lang.String getPassword()
Password of account ID on SMS gateway

Returns:

setPassword

public void setPassword(java.lang.String password)
Password of account ID on SMS gateway

Parameters:
password -

getHttpsEnabled

public boolean getHttpsEnabled()
If Enable HTTPS (default: false)

Returns:

setHttpsEnabled

public void setHttpsEnabled(boolean httpsEnabled)
Enable HTTPS (default: false)

Parameters:
httpsEnabled -

getTo

public java.lang.String getTo()
The phone number the message is sent to

Returns:

setTo

public void setTo(java.lang.String to)
The phone number the message is sent to

Parameters:
to -

getFrom

public java.lang.String getFrom()
The originator number who sent the SMS

Returns:

setFrom

public void setFrom(java.lang.String from)
The originator number who sent the SMS

Parameters:
from -

getXmlHttp

public boolean getXmlHttp()
Content type of HTTP request from SMS gateway (default : false)

Returns:
true if content type is xml/text

setXmlHttp

public void setXmlHttp(boolean xmlHttp)
xml/text content type of HTTP request from SMS gateway

Parameters:
xmlHttp -

getEncoding

public java.lang.String getEncoding()
Char set encoding to encode the request data

Returns:

setEncoding

public void setEncoding(java.lang.String encoding)
Char set encoding to encode the request data

Parameters:
encoding -

getParameterNames

public ParameterNames getParameterNames()
Parameter names uses to build the HTTP URL content. (mandatory in w3-form-url http type).

Returns:

setParameterNames

public void setParameterNames(ParameterNames parameterNames)
Parameter names uses to build the HTTP URL content. (mandatory in w3-form-url http type).

Parameters:
parameterNames -

getSelfDefineParameters

public java.util.Map getSelfDefineParameters()
Besides the standard parameter like : from/to number, message etc, Some SMS gateway supports specific parameter, these special parameter is a map.

Returns:

setSelfDefineParameters

public void setSelfDefineParameters(java.util.Map selfDefParam)
Besides the standard parameter like : from/to number, message etc, Some SMS gateway supports specific parameter, these special parameter is a map.

Parameters:
selfDefParam -

getDlrConfig

public DLRHandlerConfiguration getDlrConfig()
Delivery Report configuration. The dlrConfig is used by the default implementation of handleResponseData(), if application override this method and handle the DLR by itself, dlrConfig is not mandatory.

Returns:

setDlrConfig

public void setDlrConfig(DLRHandlerConfiguration dlrConfig)
Delivery Report configuration. The dlrConfig is used by the default implementation of handleResponseData(), if application override this method and handle the DLR by itself, dlrConfig is not mandatory.

Parameters:
dlrConfig -

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011