SMPPSession

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jsmpp.session
Class SMPPSession

java.lang.Object
  org.jsmpp.session.AbstractSession
      org.jsmpp.session.SMPPSession

All Implemented Interfaces:: ClientSession, Session

public class SMPPSession
extends AbstractSession
implements ClientSession
extends AbstractSession
implements ClientSession

This is an object that used to communicate with SMPP Server or SMSC. It hide all un-needed SMPP operation that might harm if the user code use it such as :

DELIVER_SM_RESP, should be called only as response to DELIVER_SM
UNBIND_RESP, should be called only as response to UNBIND_RESP
DATA_SM_RESP, should be called only as response to DATA_SM
ENQUIRE_LINK_RESP, should be called only as response to ENQUIRE_LINK
GENERIC_NACK, should be called only as response to GENERIC_NACK

All SMPP operation (request-response) is blocking, for an example: SUBMIT_SM will be blocked until SUBMIT_SM_RESP received or timeout. This looks like synchronous communication, but the SMPPClient implementation give ability to the asynchronous way by executing the SUBMIT_SM operation parallel on a different thread. The very simple implementation by using Thread pool, ExecutorService will do. To receive the incoming message such as DELIVER_SM or DATA_SM will be managed by internal thread. User code only have to set listener MessageReceiverListener.

Author:: uudashr

Nested Class Summary
`private class`	`SMPPSession.BoundSessionStateListener` Session state listener for internal class use.
`private class`	`SMPPSession.PDUReaderWorker` Worker to read the PDU.
`private class`	`SMPPSession.ResponseHandlerImpl`

Nested classes/interfaces inherited from class org.jsmpp.session.AbstractSession
`AbstractSession.EnquireLinkSender`

Field Summary
`private Connection`	`conn`
`private ConnectionFactory`	`connFactory`
`private java.io.DataInputStream`	`in`
`private static org.slf4j.Logger`	`logger`
`private MessageReceiverListener`	`messageReceiverListener`
`private java.io.OutputStream`	`out`
`private PDUReader`	`pduReader`
`private SMPPSession.PDUReaderWorker`	`pduReaderWorker`
`private ResponseHandler`	`responseHandler`
`private SMPPSessionContext`	`sessionContext`
`private SMPPSession.BoundSessionStateListener`	`sessionStateListener`

Fields inherited from class org.jsmpp.session.AbstractSession
`enquireLinkSender`

Constructor Summary
`SMPPSession()` Default constructor of `SMPPSession`.
`SMPPSession(PDUSender pduSender, PDUReader pduReader, ConnectionFactory connFactory)`
`SMPPSession(java.lang.String host, int port, BindParameter bindParam)`
`SMPPSession(java.lang.String host, int port, BindParameter bindParam, PDUSender pduSender, PDUReader pduReader, ConnectionFactory connFactory)`

Method Summary
`void`	`cancelShortMessage(java.lang.String serviceType, java.lang.String messageId, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, java.lang.String sourceAddr, TypeOfNumber destAddrTon, NumberingPlanIndicator destAddrNpi, java.lang.String destinationAddress)` Cancel the previous submitted short message.
`void`	`close()` Forced close connection without sending UNBIND command to Message Center.
`java.lang.String`	`connectAndBind(java.lang.String host, int port, BindParameter bindParam)` Open connection and bind immediately.
`java.lang.String`	`connectAndBind(java.lang.String host, int port, BindParameter bindParam, long timeout)` Open connection and bind immediately.
`void`	`connectAndBind(java.lang.String host, int port, BindType bindType, java.lang.String systemId, java.lang.String password, java.lang.String systemType, TypeOfNumber addrTon, NumberingPlanIndicator addrNpi, java.lang.String addressRange)` Open connection and bind immediately.
`void`	`connectAndBind(java.lang.String host, int port, BindType bindType, java.lang.String systemId, java.lang.String password, java.lang.String systemType, TypeOfNumber addrTon, NumberingPlanIndicator addrNpi, java.lang.String addressRange, long timeout)` Open connection and bind immediately with specified timeout.
`protected Connection`	`connection()`
`protected void`	`finalize()`
`private void`	`fireAcceptAlertNotification(AlertNotification alertNotification)`
`private void`	`fireAcceptDeliverSm(DeliverSm deliverSm)`
`MessageReceiverListener`	`getMessageReceiverListener()` Get the current message receiver listener that is currently registered for this smpp session.
`protected GenericMessageReceiverListener`	`messageReceiverListener()`
`QuerySmResult`	`queryShortMessage(java.lang.String messageId, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, java.lang.String sourceAddr)` Query previous submitted short message based on it's message_id and message_id.
`void`	`replaceShortMessage(java.lang.String messageId, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, java.lang.String sourceAddr, java.lang.String scheduleDeliveryTime, java.lang.String validityPeriod, RegisteredDelivery registeredDelivery, byte smDefaultMsgId, byte[] shortMessage)` Replace the previous submitted short message.
`private java.lang.String`	`sendBind(BindType bindType, java.lang.String systemId, java.lang.String password, java.lang.String systemType, InterfaceVersion interfaceVersion, TypeOfNumber addrTon, NumberingPlanIndicator addrNpi, java.lang.String addressRange, long timeout)` Sending bind.
`protected AbstractSessionContext`	`sessionContext()`
`void`	`setMessageReceiverListener(MessageReceiverListener messageReceiverListener)` Sets a message receiver listener for this smpp session.
`SubmitMultiResult`	submitMultiple(java.lang.String serviceType, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, java.lang.String sourceAddr, Address[] destinationAddresses, ESMClass esmClass, byte protocolId, byte priorityFlag, java.lang.String scheduleDeliveryTime, java.lang.String validityPeriod, RegisteredDelivery registeredDelivery, ReplaceIfPresentFlag replaceIfPresentFlag, DataCoding dataCoding, byte smDefaultMsgId, byte[] shortMessage, OptionalParameter... optionalParameters) Submit short message to multiple destination address.
`java.lang.String`	submitShortMessage(java.lang.String serviceType, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, java.lang.String sourceAddr, TypeOfNumber destAddrTon, NumberingPlanIndicator destAddrNpi, java.lang.String destinationAddr, ESMClass esmClass, byte protocolId, byte priorityFlag, java.lang.String scheduleDeliveryTime, java.lang.String validityPeriod, RegisteredDelivery registeredDelivery, byte replaceIfPresentFlag, DataCoding dataCoding, byte smDefaultMsgId, byte[] shortMessage, OptionalParameter... optionalParameters) Submit a short message to specified destination address.

Methods inherited from class org.jsmpp.session.AbstractSession
`addSessionStateListener, dataShortMessage, ensureReceivable, ensureTransmittable, ensureTransmittable, executeSendCommand, fireAcceptDataSm, getEnquireLinkTimer, getLastActivityTimestamp, getPduProcessorDegree, getSessionId, getSessionState, getTransactionTimer, isReadPdu, pduSender, removePendingResponse, removeSessionStateListener, sendEnquireLink, sequence, setEnquireLinkTimer, setPduProcessorDegree, setTransactionTimer, unbindAndClose`

Methods inherited from class org.jsmpp.session.AbstractSession

addSessionStateListener, dataShortMessage, ensureReceivable, ensureTransmittable, ensureTransmittable, executeSendCommand, fireAcceptDataSm, getEnquireLinkTimer, getLastActivityTimestamp, getPduProcessorDegree, getSessionId, getSessionState, getTransactionTimer, isReadPdu, pduSender, removePendingResponse, removeSessionStateListener, sendEnquireLink, sequence, setEnquireLinkTimer, setPduProcessorDegree, setTransactionTimer, unbindAndClose

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.jsmpp.session.Session
`addSessionStateListener, dataShortMessage, getEnquireLinkTimer, getLastActivityTimestamp, getSessionId, getSessionState, getTransactionTimer, removeSessionStateListener, setEnquireLinkTimer, setTransactionTimer, unbindAndClose`

Field Detail

logger

private static final org.slf4j.Logger logger

pduReader

private final PDUReader pduReader

connFactory

private final ConnectionFactory connFactory

conn

private Connection conn

in

private java.io.DataInputStream in

out

private java.io.OutputStream out

pduReaderWorker

private SMPPSession.PDUReaderWorker pduReaderWorker

responseHandler

private final ResponseHandler responseHandler

messageReceiverListener

private MessageReceiverListener messageReceiverListener

sessionStateListener

private SMPPSession.BoundSessionStateListener sessionStateListener

sessionContext

private SMPPSessionContext sessionContext

Constructor Detail

SMPPSession

public SMPPSession()

Default constructor of SMPPSession. The next action might be connect and bind to a destination message center.

See Also:: connectAndBind(String, int, BindType, String, String, String, TypeOfNumber, NumberingPlanIndicator, String)

SMPPSession

public SMPPSession(PDUSender pduSender,
                   PDUReader pduReader,
                   ConnectionFactory connFactory)

SMPPSession

public SMPPSession(java.lang.String host,
                   int port,
                   BindParameter bindParam,
                   PDUSender pduSender,
                   PDUReader pduReader,
                   ConnectionFactory connFactory)
            throws java.io.IOException

Throws:: java.io.IOException

SMPPSession

public SMPPSession(java.lang.String host,
                   int port,
                   BindParameter bindParam)
            throws java.io.IOException

Throws:: java.io.IOException

Method Detail

connectAndBind

public void connectAndBind(java.lang.String host,
                           int port,
                           BindType bindType,
                           java.lang.String systemId,
                           java.lang.String password,
                           java.lang.String systemType,
                           TypeOfNumber addrTon,
                           NumberingPlanIndicator addrNpi,
                           java.lang.String addressRange)
                    throws java.io.IOException

Open connection and bind immediately.

Specified by:: connectAndBind in interface ClientSession

Parameters:: host - is the SMSC host address.; port - is the SMSC listen port.; bindType - is the bind type.; systemId - is the system id.; password - is the password.; systemType - is the system type.; addrTon - is the address TON.; addrNpi - is the address NPI.; addressRange - is the address range.
Throws:: java.io.IOException - if there is an IO error found.

connectAndBind

public void connectAndBind(java.lang.String host,
                           int port,
                           BindType bindType,
                           java.lang.String systemId,
                           java.lang.String password,
                           java.lang.String systemType,
                           TypeOfNumber addrTon,
                           NumberingPlanIndicator addrNpi,
                           java.lang.String addressRange,
                           long timeout)
                    throws java.io.IOException

Open connection and bind immediately with specified timeout. The default timeout is 1 minutes.

Specified by:: connectAndBind in interface ClientSession

Parameters:: host - is the SMSC host address.; port - is the SMSC listen port.; bindType - is the bind type.; systemId - is the system id.; password - is the password.; systemType - is the system type.; addrTon - is the address TON.; addrNpi - is the address NPI.; addressRange - is the address range.; timeout - is the timeout.
Throws:: java.io.IOException - if there is an IO error found.

connectAndBind

public java.lang.String connectAndBind(java.lang.String host,
                                       int port,
                                       BindParameter bindParam)
                                throws java.io.IOException

Open connection and bind immediately.

Specified by:: connectAndBind in interface ClientSession

Parameters:: host - is the SMSC host address.; port - is the SMSC listen port.; bindParam - is the bind parameters.
Returns:: the SMSC system id.
Throws:: java.io.IOException - if there is an IO error found.

connectAndBind

public java.lang.String connectAndBind(java.lang.String host,
                                       int port,
                                       BindParameter bindParam,
                                       long timeout)
                                throws java.io.IOException

Open connection and bind immediately.

Specified by:: connectAndBind in interface ClientSession

Parameters:: host - is the SMSC host address.; port - is the SMSC listen port.; bindParam - is the bind parameters.; timeout - is the timeout.
Returns:: the SMSC system id.
Throws:: java.io.IOException - if there is an IO error found.

sendBind

private java.lang.String sendBind(BindType bindType,
                                  java.lang.String systemId,
                                  java.lang.String password,
                                  java.lang.String systemType,
                                  InterfaceVersion interfaceVersion,
                                  TypeOfNumber addrTon,
                                  NumberingPlanIndicator addrNpi,
                                  java.lang.String addressRange,
                                  long timeout)
                           throws PDUException,
                                  ResponseTimeoutException,
                                  InvalidResponseException,
                                  NegativeResponseException,
                                  java.io.IOException

Sending bind.

Parameters:: bindType - is the bind type.; systemId - is the system id.; password - is the password.; systemTypeis - the system type.; interfaceVersion - is the interface version.; addrTon - is the address TON.; addrNpi - is the address NPI.; addressRange - is the address range.; timeout - is the max time waiting for bind response.
Returns:: SMSC system id.
Throws:: PDUException - if we enter invalid bind parameter(s).; ResponseTimeoutException - if there is no valid response after defined millisecond.; InvalidResponseException - if there is invalid response found.; NegativeResponseException - if we receive negative response.; java.io.IOException - if there is an IO error occur.