org.jsmpp.util
Interface PDUComposer

All Known Implementing Classes:
DefaultComposer

public interface PDUComposer

This is utility to compose the PDU from parameter values to byte.

Author:
uudashr

Method Summary
 byte[] alertNotification(int sequenceNumber, byte sourceAddrTon, byte sourceAddrNpi, java.lang.String sourceAddr, byte esmeAddrTon, byte esmeAddrNpi, java.lang.String esmeAddr, OptionalParameter... optionalParameters)
           
 byte[] bind(int commandId, int sequenceNumber, java.lang.String systemId, java.lang.String password, java.lang.String systemType, byte interfaceVersion, byte addrTon, byte addrNpi, java.lang.String addressRange)
           
 byte[] bindResp(int commandId, int sequenceNumber, java.lang.String systemId, byte scInterfaceVersion)
           
 byte[] bindResp(int commandId, int sequenceNumber, java.lang.String systemId, OptionalParameter... optionalParameters)
           
 byte[] cancelSm(int sequenceNumber, java.lang.String serviceType, java.lang.String messageId, byte sourceAddrTon, byte sourceAddrNpi, java.lang.String sourceAddr, byte destAddrTon, byte destAddrNpi, java.lang.String destinationAddr)
          Compose cancel short message (cancel_sm) PDU.
 byte[] cancelSmResp(int sequenceNumber)
          Compose cancel short message response (cancel_sm_resp) PDU.
 byte[] composeHeader(int commandId, int commandStatus, int sequenceNumber)
           
 byte[] dataSm(int sequenceNumber, java.lang.String serviceType, byte sourceAddrTon, byte sourceAddrNpi, java.lang.String sourceAddr, byte destAddrTon, byte destAddrNpi, java.lang.String destinationAddr, byte esmClass, byte registeredDelivery, byte dataCoding, OptionalParameter... optionalParameters)
          Compose data short message (data_sm) PDU.
 byte[] dataSmResp(int sequenceNumber, java.lang.String messageId, OptionalParameter... optionalParameters)
          Compose data short message response (submit_sm_resp) PDU.
 byte[] deliverSm(int sequenceNumber, java.lang.String serviceType, byte sourceAddrTon, byte sourceAddrNpi, java.lang.String sourceAddr, byte destAddrTon, byte destAddrNpi, java.lang.String destinationAddr, byte esmClass, byte protocolId, byte priorityFlag, byte registeredDelivery, byte dataCoding, byte[] shortMessage, OptionalParameter... optionalParameters)
           
 byte[] deliverSmResp(int sequenceNumber)
           
 byte[] enquireLink(int sequenceNumber)
           
 byte[] enquireLinkResp(int sequenceNumber)
           
 byte[] genericNack(int commandStatus, int sequenceNumber)
           
 byte[] outbind(int sequenceNumber, java.lang.String systemId, java.lang.String password)
           
 byte[] querySm(int sequenceNumber, java.lang.String messageId, byte sourceAddrTon, byte sourceAddrNpi, java.lang.String sourceAddr)
           
 byte[] querySmResp(int sequenceNumber, java.lang.String messageId, java.lang.String finalDate, byte messageState, byte errorCode)
           
 byte[] replaceSm(int sequenceNumber, java.lang.String messageId, byte sourceAddrTon, byte sourceAddrNpi, java.lang.String sourceAddr, java.lang.String scheduleDeliveryTime, java.lang.String validityPeriod, byte registeredDelivery, byte smDefaultMsgId, byte[] shortMessage)
           
 byte[] replaceSmResp(int sequenceNumber)
           
 byte[] submitMulti(int sequenceNumber, java.lang.String serviceType, byte sourceAddrTon, byte sourceAddrNpi, java.lang.String sourceAddr, DestinationAddress[] destinationAddresses, byte esmClass, byte protocolId, byte priorityFlag, java.lang.String scheduleDeliveryTime, java.lang.String validityPeriod, byte registeredDelivery, byte replaceIfPresentFlag, byte dataCoding, byte smDefaultMsgId, byte[] shortMessage, OptionalParameter... optionalParameters)
           
 byte[] submitMultiResp(int sequenceNumber, java.lang.String messageId, UnsuccessDelivery... unsuccessDeliveries)
           
 byte[] submitSm(int sequenceNumber, java.lang.String serviceType, byte sourceAddrTon, byte sourceAddrNpi, java.lang.String sourceAddr, byte destAddrTon, byte destAddrNpi, java.lang.String destinationAddr, byte esmClass, byte protocolId, byte priorityFlag, java.lang.String scheduleDeliveryTime, java.lang.String validityPeriod, byte registeredDelivery, byte replaceIfPresentFlag, byte dataCoding, byte smDefaultMsgId, byte[] shortMessage, OptionalParameter... optionalParameters)
          Submit short message (submit_sm).
 byte[] submitSmResp(int sequenceNumber, java.lang.String messageId)
          Submit short message response (submit_sm_resp).
 byte[] unbind(int sequenceNumber)
           
 byte[] unbindResp(int commandStatus, int sequenceNumber)
           
 

Method Detail

composeHeader

byte[] composeHeader(int commandId,
                     int commandStatus,
                     int sequenceNumber)

bind

byte[] bind(int commandId,
            int sequenceNumber,
            java.lang.String systemId,
            java.lang.String password,
            java.lang.String systemType,
            byte interfaceVersion,
            byte addrTon,
            byte addrNpi,
            java.lang.String addressRange)
            throws PDUStringException
Throws:
PDUStringException

bindResp

byte[] bindResp(int commandId,
                int sequenceNumber,
                java.lang.String systemId,
                OptionalParameter... optionalParameters)
                throws PDUStringException
Throws:
PDUStringException

bindResp

byte[] bindResp(int commandId,
                int sequenceNumber,
                java.lang.String systemId,
                byte scInterfaceVersion)
                throws PDUStringException
Throws:
PDUStringException

unbind

byte[] unbind(int sequenceNumber)

unbindResp

byte[] unbindResp(int commandStatus,
                  int sequenceNumber)

outbind

byte[] outbind(int sequenceNumber,
               java.lang.String systemId,
               java.lang.String password)
               throws PDUStringException
Throws:
PDUStringException

enquireLink

byte[] enquireLink(int sequenceNumber)

enquireLinkResp

byte[] enquireLinkResp(int sequenceNumber)

genericNack

byte[] genericNack(int commandStatus,
                   int sequenceNumber)

submitSm

byte[] submitSm(int sequenceNumber,
                java.lang.String serviceType,
                byte sourceAddrTon,
                byte sourceAddrNpi,
                java.lang.String sourceAddr,
                byte destAddrTon,
                byte destAddrNpi,
                java.lang.String destinationAddr,
                byte esmClass,
                byte protocolId,
                byte priorityFlag,
                java.lang.String scheduleDeliveryTime,
                java.lang.String validityPeriod,
                byte registeredDelivery,
                byte replaceIfPresentFlag,
                byte dataCoding,
                byte smDefaultMsgId,
                byte[] shortMessage,
                OptionalParameter... optionalParameters)
                throws PDUStringException
Submit short message (submit_sm).

Parameters:
sequenceNumber -
serviceType -
sourceAddrTon -
sourceAddrNpi -
sourceAddr -
destAddrTon -
destAddrNpi -
destinationAddr -
esmClass -
protocolId -
priorityFlag -
scheduleDeliveryTime -
validityPeriod -
registeredDelivery -
replaceIfPresentFlag -
dataCoding -
smDefaultMsgId -
shortMessage -
optionalParameters -
Returns:
the composed byte values.
Throws:
PDUStringException

submitSmResp

byte[] submitSmResp(int sequenceNumber,
                    java.lang.String messageId)
                    throws PDUStringException
Submit short message response (submit_sm_resp).

Parameters:
sequenceNumber -
messageId -
Returns:
the composed byte values.
Throws:
PDUStringException

querySm

byte[] querySm(int sequenceNumber,
               java.lang.String messageId,
               byte sourceAddrTon,
               byte sourceAddrNpi,
               java.lang.String sourceAddr)
               throws PDUStringException
Throws:
PDUStringException

querySmResp

byte[] querySmResp(int sequenceNumber,
                   java.lang.String messageId,
                   java.lang.String finalDate,
                   byte messageState,
                   byte errorCode)
                   throws PDUStringException
Throws:
PDUStringException

deliverSm

byte[] deliverSm(int sequenceNumber,
                 java.lang.String serviceType,
                 byte sourceAddrTon,
                 byte sourceAddrNpi,
                 java.lang.String sourceAddr,
                 byte destAddrTon,
                 byte destAddrNpi,
                 java.lang.String destinationAddr,
                 byte esmClass,
                 byte protocolId,
                 byte priorityFlag,
                 byte registeredDelivery,
                 byte dataCoding,
                 byte[] shortMessage,
                 OptionalParameter... optionalParameters)
                 throws PDUStringException
Throws:
PDUStringException

deliverSmResp

byte[] deliverSmResp(int sequenceNumber)

dataSm

byte[] dataSm(int sequenceNumber,
              java.lang.String serviceType,
              byte sourceAddrTon,
              byte sourceAddrNpi,
              java.lang.String sourceAddr,
              byte destAddrTon,
              byte destAddrNpi,
              java.lang.String destinationAddr,
              byte esmClass,
              byte registeredDelivery,
              byte dataCoding,
              OptionalParameter... optionalParameters)
              throws PDUStringException
Compose data short message (data_sm) PDU.

Parameters:
sequenceNumber -
serviceType -
sourceAddrTon -
sourceAddrNpi -
sourceAddr -
destAddrTon -
destAddrNpi -
destinationAddr -
esmClass -
registeredDelivery -
dataCoding -
optionalParameters -
Returns:
Throws:
PDUStringException

dataSmResp

byte[] dataSmResp(int sequenceNumber,
                  java.lang.String messageId,
                  OptionalParameter... optionalParameters)
                  throws PDUStringException
Compose data short message response (submit_sm_resp) PDU.

Parameters:
sequenceNumber - is the sequence number.
messageId - is the the message identifier.
optionalParameters - is the optional parameter(s).
Returns:
the composed byte values.
Throws:
PDUStringException

cancelSm

byte[] cancelSm(int sequenceNumber,
                java.lang.String serviceType,
                java.lang.String messageId,
                byte sourceAddrTon,
                byte sourceAddrNpi,
                java.lang.String sourceAddr,
                byte destAddrTon,
                byte destAddrNpi,
                java.lang.String destinationAddr)
                throws PDUStringException
Compose cancel short message (cancel_sm) PDU.

Parameters:
sequenceNumber -
serviceType -
messageId -
sourceAddrTon -
sourceAddrNpi -
sourceAddr -
destAddrTon -
destAddrNpi -
destinationAddr -
Returns:
the composed byte values.
Throws:
PDUStringException

cancelSmResp

byte[] cancelSmResp(int sequenceNumber)
Compose cancel short message response (cancel_sm_resp) PDU.

Parameters:
sequenceNumber -
Returns:
the composed byte values.

replaceSm

byte[] replaceSm(int sequenceNumber,
                 java.lang.String messageId,
                 byte sourceAddrTon,
                 byte sourceAddrNpi,
                 java.lang.String sourceAddr,
                 java.lang.String scheduleDeliveryTime,
                 java.lang.String validityPeriod,
                 byte registeredDelivery,
                 byte smDefaultMsgId,
                 byte[] shortMessage)
                 throws PDUStringException
Throws:
PDUStringException

replaceSmResp

byte[] replaceSmResp(int sequenceNumber)

submitMulti

byte[] submitMulti(int sequenceNumber,
                   java.lang.String serviceType,
                   byte sourceAddrTon,
                   byte sourceAddrNpi,
                   java.lang.String sourceAddr,
                   DestinationAddress[] destinationAddresses,
                   byte esmClass,
                   byte protocolId,
                   byte priorityFlag,
                   java.lang.String scheduleDeliveryTime,
                   java.lang.String validityPeriod,
                   byte registeredDelivery,
                   byte replaceIfPresentFlag,
                   byte dataCoding,
                   byte smDefaultMsgId,
                   byte[] shortMessage,
                   OptionalParameter... optionalParameters)
                   throws PDUStringException,
                          InvalidNumberOfDestinationsException
Throws:
PDUStringException
InvalidNumberOfDestinationsException

submitMultiResp

byte[] submitMultiResp(int sequenceNumber,
                       java.lang.String messageId,
                       UnsuccessDelivery... unsuccessDeliveries)
                       throws PDUStringException
Throws:
PDUStringException

alertNotification

byte[] alertNotification(int sequenceNumber,
                         byte sourceAddrTon,
                         byte sourceAddrNpi,
                         java.lang.String sourceAddr,
                         byte esmeAddrTon,
                         byte esmeAddrNpi,
                         java.lang.String esmeAddr,
                         OptionalParameter... optionalParameters)
                         throws PDUStringException
Throws:
PDUStringException