Introduction
The SMS Transport will allow send and receive
messages in the form of SMSs used in mobile phones.Using this transport
the users will be able to invoke webservices using a SMS and get the
responce.SMS Transport is mainly focus on enableing SMPP protocal support
for the Axis2 so that It can connect with a SMSC to send/receive SMS.It
will also have a GSM implimentation that will enable users to connect a
GSM modem and send/receive sms s using that.The configuration parameters
will be different depend on the implimentaion that the user will be using
(SMPP/ GSM) Follwoing up section will be discuss more details about the
configuration ,usage and Extenting of the SMS Transport
Transport Listener
Configuration
<transportReceiver name="sms"
class="org.apache.axis2.transport.sms.SMSMessageReciever">In
order to use the sms Transport Listener It must be Configured in the
Axis2.xml.It will be having set of parameters to be configured depending
on the implementation that a user needed.(SMPP/GSM)
Parameters Needed for the SMPP and GSM implementation are Explined
bellow.
SMPP Configuration
When using the SMPP
implimentaiton It will connect with a SMSC (Short Message Service center)
and Listening to the incomming messsages on a TCP connection.This
implimentaion can be used when the data traffic is so high.
| Parameter |
Required |
Description |
|---|
| systemType |
No |
To inform the binding SMSC about the system Type That connecting
to it.The Default value is "cp". .Some SMSC s does not require this
to connect.
|
| systemId |
Yes |
The system_id parameter is used to identify an ESME (In this
case Axis2 )or an SMSC at bind time. An ESME system_id identifies
the ESME or ESME agent to the SMSC. The SMSC system_id provides an
identification of the SMSC to the ESME.
|
| Password |
Yes |
The password parameter is used by the SMSC to authenticate the
identity of the binding ESME (In this Case Axis2). The Service
Provider may require ESME?s to provide a password when binding to
the SMSC. This password is normally issued by the SMSC system
administrator.
|
| host |
No |
The IP address of the host that SMSC is located.The default is
Local host - 127.0.0.1
|
| port |
No |
The port Number that Axis2 must connect with the SMSC.The
Default port is 2775
|
| phoneNumber |
No |
The phone Number that Axis2 Application given from the Service
provider.
|
GSM Configuration
GSM implementation can be
used to send receive SMS using a GSM modem connected.Its use the
SMSLib
library so that all SMSLib supported
GSM modems will be working with the GSM implimentation.This implementation
can only be used when the Data Traffic is very low (about 6 messages per
minute) since The Message Send / receive rate supported by GSM modems is
normally very low.Other than Following Parameters in the table to use the
GSMImplimentation User must specify the implementation Class of the GSM
implementation as a Parameter
<parameter name="smsImplClass">org.apache.axis2.transport.sms.gsm.GSMImplManager</parameter>
| Parameter |
Required |
Description |
|---|
| gateway_id |
Yes |
Gateway id is the Id that is used to identify the device that
you are going to use as the gateway.
|
| com_port |
Yes |
The communication port that the device is connected.As a Example
in a Linux machine if the device is connected through a USB the port
will be some thing like "/dev/ttyUSB0"
|
| baud_rate |
Yes |
The Baud rate of the device.This can be found out by looking in
to device details.
|
| manufacturer |
Yes |
The Name of the Manufacturer that the device manufactured
by.Example manufactures are "NOKIA" , "HUAWEI"
|
| model |
Yes |
The model id of the device. |
| modem_poll_interval |
No |
This is the interval that the application will poll the devices
message storage to get the incoming messages.The default value is 5
seconds.
|
TransportSender
Configuration
<transportSender name="sms"
class="org.apache.axis2.transport.sms.SMSSender">In
order to use the sms Sender It must be Configured in the Axis2.xml.It will
be having set of parameters to be configured depending on the
implementation that a user needed.(SMPP/GSM)
The Configuration
Parameters for the GSM and SMPP implimentations are same as the above
discribed for the Transport Listender.
Extending SMS Transport
The SMS Transport is Designed to
be extended to use with Other SMS implementations as well.It has two
logical layers one is the SMS Layer which has all Axis2 dependent code and
Other one is The Implementation layer which only contain the
implementation logic related to the specific implimentation.So the
Developers who need to write a another implementation can reuse the SMS
layer and focus oly about thire implementation logic.
SMSMessageBuilder
SMSMessageBuilder determines the message format
that Axis2 accepting from the incoming SMS.In the Default
SMSMessageBuilder implementation its supported for the RPC type SMS format
for the incoming SMS to invoke a Webservice its :
"ServiceName":"Operation Name":
"Parameter_1=value_1":......:"Parameter_N=value_N".Developers can add
another Builder to accept another formats by implementing the
SMSMessageBuilder interface and Specifying it as a Parameter in the
TransportListener
<parameter name="builderClass">Class Name</parameter>
SMSMessageFormatter
SMSMessageFormatter
formats the out put SMS Message Form the Axis2 MessageContext.Developers
can Add a custom MessageFormatter by Implementing the SMSMessageFormatter
interface and Specifying it as a Parameter in the TransportSender.
<parameter name="formatterClass">Class Name</parameter>
Implimentation
SMS Trasnport also allows Developers to add another
SMS implementations to the SMS Transport.To Add a another Implementation
It should have an Implementation manager that implements the
SMSImplManager interface.In that Implementation Developers can add their
custom implementation logic without worring about the Axis2
Dependensies.To add a Implementation Manager It must be Specified as a
parameter in Transport Receiver and sender
<parameter name="smsImplClass">Class Name</parameter>
