org.jsmpp

Class DefaultPDUSender

java.lang.Object

org.jsmpp.DefaultPDUSender

All Implemented Interfaces:

PDUSender

public class DefaultPDUSender
extends Object
implements PDUSender

The SMPP PDU reader class.

Since:

1.0

Version:

1.1

Author:

uudashr

Constructor Summary

Constructors

Constructor and Description
DefaultPDUSender() Default constructor.
DefaultPDUSender(PDUComposer pduComposer) Construct with specified PDU composer.

Method Summary

Modifier and Type	Method and Description
byte[]	sendAlertNotification(OutputStream os, int sequenceNumber, byte sourceAddrTon, byte sourceAddrNpi, String sourceAddr, byte esmeAddrTon, byte esmeAddrNpi, String esmeAddr, OptionalParameter... optionalParameters)
byte[]	sendBind(OutputStream os, BindType bindType, int sequenceNumber, String systemId, String password, String systemType, InterfaceVersion interfaceVersion, TypeOfNumber addrTon, NumberingPlanIndicator addrNpi, String addressRange) Send bind command.
byte[]	sendBindResp(OutputStream os, int commandId, int sequenceNumber, String systemId) Send bind response command.
byte[]	sendCancelSm(OutputStream os, int sequenceNumber, String serviceType, String messageId, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, String sourceAddr, TypeOfNumber destAddrTon, NumberingPlanIndicator destAddrNpi, String destinationAddr) Send cancel short message command.
byte[]	sendCancelSmResp(OutputStream os, int sequenceNumber) Send cancel short message response command.
byte[]	sendDataSm(OutputStream os, int sequenceNumber, String serviceType, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, String sourceAddr, TypeOfNumber destAddrTon, NumberingPlanIndicator destAddrNpi, String destinationAddr, ESMClass esmClass, RegisteredDelivery registeredDelivery, DataCoding dataCoding, OptionalParameter... optionalParameters) Send the data short message command.
byte[]	sendDataSmResp(OutputStream os, int sequenceNumber, String messageId, OptionalParameter... optionalParameters) Send data short message response command.
byte[]	sendDeliverSm(OutputStream os, int sequenceNumber, String serviceType, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, String sourceAddr, TypeOfNumber destAddrTon, NumberingPlanIndicator destAddrNpi, String destinationAddr, ESMClass esmClass, byte protocoId, byte priorityFlag, RegisteredDelivery registeredDelivery, DataCoding dataCoding, byte[] shortMessage, OptionalParameter... optionalParameters) Send the deliver short message command.
byte[]	sendDeliverSmResp(OutputStream os, int sequenceNumber) Send the deliver short message response.
byte[]	sendEnquireLink(OutputStream os, int sequenceNumber) Send enquire link command.
byte[]	sendEnquireLinkResp(OutputStream os, int sequenceNumber) Send enquire link response command.
byte[]	sendGenericNack(OutputStream os, int commandStatus, int sequenceNumber) Send generic non-acknowledge command.
byte[]	sendHeader(OutputStream os, int commandId, int commandStatus, int sequenceNumber) Send only the PDU header.
byte[]	sendQuerySm(OutputStream os, int sequenceNumber, String messageId, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, String sourceAddr) Send query short message command.
byte[]	sendQuerySmResp(OutputStream os, int sequenceNumber, String messageId, String finalDate, MessageState messageState, byte errorCode) Send query short message response command.
byte[]	sendReplaceSm(OutputStream os, int sequenceNumber, String messageId, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, String sourceAddr, String scheduleDeliveryTime, String validityPeriod, RegisteredDelivery registeredDelivery, byte smDefaultMsgId, byte[] shortMessage)
byte[]	sendReplaceSmResp(OutputStream os, int sequenceNumber)
byte[]	sendSubmiMulti(OutputStream os, int sequenceNumber, String serviceType, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, String sourceAddr, DestinationAddress[] destinationAddresses, ESMClass esmClass, byte protocolId, byte priorityFlag, String scheduleDeliveryTime, String validityPeriod, RegisteredDelivery registeredDelivery, ReplaceIfPresentFlag replaceIfPresentFlag, DataCoding dataCoding, byte smDefaultMsgId, byte[] shortMessage, OptionalParameter... optionalParameters)
byte[]	sendSubmitMultiResp(OutputStream os, int sequenceNumber, String messageId, UnsuccessDelivery... unsuccessDeliveries)
byte[]	sendSubmitSm(OutputStream os, int sequenceNumber, String serviceType, TypeOfNumber sourceAddrTon, NumberingPlanIndicator sourceAddrNpi, String sourceAddr, TypeOfNumber destAddrTon, NumberingPlanIndicator destAddrNpi, String destinationAddr, ESMClass esmClass, byte protocoId, byte priorityFlag, String scheduleDeliveryTime, String validityPeriod, RegisteredDelivery registeredDelivery, byte replaceIfPresent, DataCoding dataCoding, byte smDefaultMsgId, byte[] shortMessage, OptionalParameter... optionalParameters) Send submit short message command.
byte[]	sendSubmitSmResp(OutputStream os, int sequenceNumber, String messageId) Send submit short message response command.
byte[]	sendUnbind(OutputStream os, int sequenceNumber) Send unbind command.
byte[]	sendUnbindResp(OutputStream os, int commandStatus, int sequenceNumber) Send unbind response command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPDUSender

public DefaultPDUSender()

Default constructor.

DefaultPDUSender

public DefaultPDUSender(PDUComposer pduComposer)

Construct with specified PDU composer.

Parameters:

pduComposer - is the PDU composer.

Method Detail

sendHeader

public byte[] sendHeader(OutputStream os,
                         int commandId,
                         int commandStatus,
                         int sequenceNumber)
                  throws IOException

Description copied from interface: PDUSender

Send only the PDU header.

Specified by:

sendHeader in interface PDUSender

Parameters:

os - is the OutputStream

commandId - is the SMPP command_id.

commandStatus - is the SMPP command_status.

sequenceNumber - is the SMPP sequence_number.

Returns:

the composed bytes.

Throws:

IOException - if an I/O error occur.

sendBind

public byte[] sendBind(OutputStream os,
                       BindType bindType,
                       int sequenceNumber,
                       String systemId,
                       String password,
                       String systemType,
                       InterfaceVersion interfaceVersion,
                       TypeOfNumber addrTon,
                       NumberingPlanIndicator addrNpi,
                       String addressRange)
                throws PDUStringException,
                       IOException

Description copied from interface: PDUSender

Send bind command.

Specified by:

sendBind in interface PDUSender

Parameters:

os - is the OutputStream

bindType - is the bind type that determine the command_id.

sequenceNumber - is the sequence_number.

systemId - is the system_id.

password - is the password.

systemType - is the system_type.

interfaceVersion - is the interface_version.

addrTon - is the addr_ton.

addrNpi - is the addr_npi.

addressRange - is the address_range.

Returns:

the composed bytes.

Throws:

PDUStringException - if there is an invalid string constraint found.

IOException - if an I/O error occur.

sendBindResp

public byte[] sendBindResp(OutputStream os,
                           int commandId,
                           int sequenceNumber,
                           String systemId)
                    throws PDUStringException,
                           IOException

Description copied from interface: PDUSender

Send bind response command.

Specified by:

sendBindResp in interface PDUSender

Parameters:

os - is the OutputStream.

commandId - is the command_id.

sequenceNumber - is the sequence_number.

systemId - is the system_id.

Returns:

the composed bytes.

Throws:

PDUStringException

IOException - if an IO error occur.

sendUnbind

public byte[] sendUnbind(OutputStream os,
                         int sequenceNumber)
                  throws IOException

Description copied from interface: PDUSender

Send unbind command.

Specified by:

sendUnbind in interface PDUSender

Parameters:

os - is the OutputStream .

sequenceNumber - is the sequence_number.

Returns:

the composed bytes.

Throws:

IOException - if an IO error occur.

sendGenericNack

public byte[] sendGenericNack(OutputStream os,
                              int commandStatus,
                              int sequenceNumber)
                       throws IOException

Description copied from interface: PDUSender

Send generic non-acknowledge command.

Specified by:

sendGenericNack in interface PDUSender

Parameters:

os - is the OutputStream

commandStatus - is the command_status.

sequenceNumber - is the sequence_number.

Returns:

the composed bytes.

Throws:

IOException - if an IO error occur.

sendUnbindResp

public byte[] sendUnbindResp(OutputStream os,
                             int commandStatus,
                             int sequenceNumber)
                      throws IOException

Description copied from interface: PDUSender

Send unbind response command.

Specified by:

sendUnbindResp in interface PDUSender

Parameters:

os - is the OutputStream.

commandStatus - is the command_status.

sequenceNumber - is the sequence_number.

Returns:

the composed bytes.

Throws:

IOException - if an IO error occur.

sendEnquireLink

public byte[] sendEnquireLink(OutputStream os,
                              int sequenceNumber)
                       throws IOException

Description copied from interface: PDUSender

Send enquire link command.

Specified by:

sendEnquireLink in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - is the sequence_number.

Returns:

the composed bytes.

Throws:

IOException - if an IO error occur.

sendEnquireLinkResp

public byte[] sendEnquireLinkResp(OutputStream os,
                                  int sequenceNumber)
                           throws IOException

Description copied from interface: PDUSender

Send enquire link response command.

Specified by:

sendEnquireLinkResp in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - is the sequenceNumber.

Returns:

the composed bytes.

Throws:

IOException - if an IO error occur.

sendSubmitSm

public byte[] sendSubmitSm(OutputStream os,
                           int sequenceNumber,
                           String serviceType,
                           TypeOfNumber sourceAddrTon,
                           NumberingPlanIndicator sourceAddrNpi,
                           String sourceAddr,
                           TypeOfNumber destAddrTon,
                           NumberingPlanIndicator destAddrNpi,
                           String destinationAddr,
                           ESMClass esmClass,
                           byte protocoId,
                           byte priorityFlag,
                           String scheduleDeliveryTime,
                           String validityPeriod,
                           RegisteredDelivery registeredDelivery,
                           byte replaceIfPresent,
                           DataCoding dataCoding,
                           byte smDefaultMsgId,
                           byte[] shortMessage,
                           OptionalParameter... optionalParameters)
                    throws PDUStringException,
                           IOException

Description copied from interface: PDUSender

Send submit short message command.

Specified by:

sendSubmitSm in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - is the sequence_number.

serviceType - is the service_type.

sourceAddrTon - is the source_addr_ton.

sourceAddrNpi - is the source_addr_npi.

sourceAddr - is the source_addr.

destAddrTon - is the dest_addr_ton.

destAddrNpi - is the dest_addr_npi.

destinationAddr - is the destination_addr.

esmClass - is the esm_class.

protocoId - is the protocol_id.

priorityFlag - is the priority_flag.

scheduleDeliveryTime - is the schedule_delivery_time

validityPeriod - is the validity_period.

registeredDelivery - is the registered_delivery.

replaceIfPresent - is the replace_if_present_flag.

dataCoding - is the data_coding.

smDefaultMsgId - is the sm_default_msg_id.

shortMessage - is the short_message.

optionalParameters - is the optional parameters.

Returns:

the composed bytes.

Throws:

PDUStringException - if there is an invalid string constraint found.

IOException - if there is an IO error occur.

sendSubmitSmResp

public byte[] sendSubmitSmResp(OutputStream os,
                               int sequenceNumber,
                               String messageId)
                        throws PDUStringException,
                               IOException

Description copied from interface: PDUSender

Send submit short message response command.

Specified by:

sendSubmitSmResp in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - is the sequence_number.

messageId - is the message_id.

Returns:

the composed bytes.

Throws:

PDUStringException - if there is an invalid string constraint found.

IOException - if there is an IO error occur.

sendQuerySm

public byte[] sendQuerySm(OutputStream os,
                          int sequenceNumber,
                          String messageId,
                          TypeOfNumber sourceAddrTon,
                          NumberingPlanIndicator sourceAddrNpi,
                          String sourceAddr)
                   throws PDUStringException,
                          IOException

Description copied from interface: PDUSender

Send query short message command.

Specified by:

sendQuerySm in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - is the sequence_number.

messageId - is the message_id.

sourceAddrTon - is the source_addr_ton.

sourceAddrNpi - is the source_addr_npi.

sourceAddr - is the source_addr.

Returns:

the composed bytes.

Throws:

PDUStringException - if there is an invalid constraint found.

IOException - if there is an IO error occur.

sendQuerySmResp

public byte[] sendQuerySmResp(OutputStream os,
                              int sequenceNumber,
                              String messageId,
                              String finalDate,
                              MessageState messageState,
                              byte errorCode)
                       throws PDUStringException,
                              IOException

Description copied from interface: PDUSender

Send query short message response command.

Specified by:

sendQuerySmResp in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - is the sequence_number.

messageId - is the message_id.

finalDate - is the final_date.

messageState - is the message_state.

errorCode - is the error_code.

Returns:

the composed bytes.

Throws:

PDUStringException - if there is an invalid constraint found.

IOException - if there is an IO error occur.

sendDeliverSm

public byte[] sendDeliverSm(OutputStream os,
                            int sequenceNumber,
                            String serviceType,
                            TypeOfNumber sourceAddrTon,
                            NumberingPlanIndicator sourceAddrNpi,
                            String sourceAddr,
                            TypeOfNumber destAddrTon,
                            NumberingPlanIndicator destAddrNpi,
                            String destinationAddr,
                            ESMClass esmClass,
                            byte protocoId,
                            byte priorityFlag,
                            RegisteredDelivery registeredDelivery,
                            DataCoding dataCoding,
                            byte[] shortMessage,
                            OptionalParameter... optionalParameters)
                     throws PDUStringException,
                            IOException

Description copied from interface: PDUSender

Send the deliver short message command.

Specified by:

sendDeliverSm in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - the sequence_number.

serviceType - the service_type.

sourceAddrTon - is the source_addr_ton.

sourceAddrNpi - is the source_addr_npi.

sourceAddr - is the source_addr.

destAddrTon - is the dest_addr_ton.

destAddrNpi - is the dest_addr_npi.

destinationAddr - is the destination_addr.

esmClass - is the esm_class.

protocoId - is the protocol_id.

priorityFlag - is the priority_flag.

registeredDelivery - is the registered_delivery.

dataCoding - is the data_coding.

shortMessage - is the short_message.

optionalParameters - is the optional parameters.

Returns:

the composed bytes.

Throws:

PDUStringException - if there is an invalid string constraint found.

IOException - if there is an IO error occur.

sendDeliverSmResp

public byte[] sendDeliverSmResp(OutputStream os,
                                int sequenceNumber)
                         throws IOException

Description copied from interface: PDUSender

Send the deliver short message response.

Specified by:

sendDeliverSmResp in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - is the sequence_number.

Returns:

the composed bytes.

Throws:

IOException - if there is an IO error occur.

sendDataSm

public byte[] sendDataSm(OutputStream os,
                         int sequenceNumber,
                         String serviceType,
                         TypeOfNumber sourceAddrTon,
                         NumberingPlanIndicator sourceAddrNpi,
                         String sourceAddr,
                         TypeOfNumber destAddrTon,
                         NumberingPlanIndicator destAddrNpi,
                         String destinationAddr,
                         ESMClass esmClass,
                         RegisteredDelivery registeredDelivery,
                         DataCoding dataCoding,
                         OptionalParameter... optionalParameters)
                  throws PDUStringException,
                         IOException

Description copied from interface: PDUSender

Send the data short message command.

Specified by:

sendDataSm in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - the sequence_number.

serviceType - the service_type.

sourceAddrTon - is the source_addr_ton.

sourceAddrNpi - is the source_addr_npi.

sourceAddr - is the source_addr.

destAddrTon - is the dest_addr_ton.

destAddrNpi - is the dest_addr_npi.

destinationAddr - is the destination_addr.

esmClass - is the esm_class.

registeredDelivery - is the registered_delivery.

dataCoding - is the data_coding.

optionalParameters - is the optional parameters.

Returns:

the composed bytes.

Throws:

PDUStringException - if there is an invalid string constraint found.

IOException - if there is an IO error occur.

sendDataSmResp

public byte[] sendDataSmResp(OutputStream os,
                             int sequenceNumber,
                             String messageId,
                             OptionalParameter... optionalParameters)
                      throws PDUStringException,
                             IOException

Description copied from interface: PDUSender

Send data short message response command.

Specified by:

sendDataSmResp in interface PDUSender

Parameters:

os - is the OutputStream.

sequenceNumber - is the sequence_number.

messageId - is the message_id.

optionalParameters - is the optional parameters.

Returns:

the composed bytes.

Throws:

PDUStringException - if there is an invalid string constraint found.

IOException - if there is an IO error occur.

sendCancelSm

public byte[] sendCancelSm(OutputStream os,
                           int sequenceNumber,
                           String serviceType,
                           String messageId,
                           TypeOfNumber sourceAddrTon,
                           NumberingPlanIndicator sourceAddrNpi,
                           String sourceAddr,
                           TypeOfNumber destAddrTon,
                           NumberingPlanIndicator destAddrNpi,
                           String destinationAddr)
                    throws PDUStringException,
                           IOException

Description copied from interface: PDUSender

Send cancel short message command.

Specified by:

sendCancelSm in interface PDUSender

Returns:

Throws:

PDUStringException

IOException

sendCancelSmResp

public byte[] sendCancelSmResp(OutputStream os,
                               int sequenceNumber)
                        throws IOException

Description copied from interface: PDUSender

Send cancel short message response command.

Specified by:

sendCancelSmResp in interface PDUSender

Returns:

Throws:

IOException

sendReplaceSm

public byte[] sendReplaceSm(OutputStream os,
                            int sequenceNumber,
                            String messageId,
                            TypeOfNumber sourceAddrTon,
                            NumberingPlanIndicator sourceAddrNpi,
                            String sourceAddr,
                            String scheduleDeliveryTime,
                            String validityPeriod,
                            RegisteredDelivery registeredDelivery,
                            byte smDefaultMsgId,
                            byte[] shortMessage)
                     throws PDUStringException,
                            IOException

Specified by:

sendReplaceSm in interface PDUSender

Throws:

PDUStringException

IOException

sendReplaceSmResp

public byte[] sendReplaceSmResp(OutputStream os,
                                int sequenceNumber)
                         throws IOException

Specified by:

sendReplaceSmResp in interface PDUSender

Throws:

IOException

sendSubmiMulti

public byte[] sendSubmiMulti(OutputStream os,
                             int sequenceNumber,
                             String serviceType,
                             TypeOfNumber sourceAddrTon,
                             NumberingPlanIndicator sourceAddrNpi,
                             String sourceAddr,
                             DestinationAddress[] destinationAddresses,
                             ESMClass esmClass,
                             byte protocolId,
                             byte priorityFlag,
                             String scheduleDeliveryTime,
                             String validityPeriod,
                             RegisteredDelivery registeredDelivery,
                             ReplaceIfPresentFlag replaceIfPresentFlag,
                             DataCoding dataCoding,
                             byte smDefaultMsgId,
                             byte[] shortMessage,
                             OptionalParameter... optionalParameters)
                      throws PDUStringException,
                             InvalidNumberOfDestinationsException,
                             IOException

Specified by:

sendSubmiMulti in interface PDUSender

Throws:

PDUStringException

InvalidNumberOfDestinationsException

IOException

sendSubmitMultiResp

public byte[] sendSubmitMultiResp(OutputStream os,
                                  int sequenceNumber,
                                  String messageId,
                                  UnsuccessDelivery... unsuccessDeliveries)
                           throws PDUStringException,
                                  IOException

Specified by:

sendSubmitMultiResp in interface PDUSender

Throws:

PDUStringException

IOException

sendAlertNotification

public byte[] sendAlertNotification(OutputStream os,
                                    int sequenceNumber,
                                    byte sourceAddrTon,
                                    byte sourceAddrNpi,
                                    String sourceAddr,
                                    byte esmeAddrTon,
                                    byte esmeAddrNpi,
                                    String esmeAddr,
                                    OptionalParameter... optionalParameters)
                             throws PDUStringException,
                                    IOException

Specified by:

sendAlertNotification in interface PDUSender

Throws:

PDUStringException

IOException