org.jsmpp.bean
Class AbstractSmCommand

java.lang.Object
  extended by org.jsmpp.bean.Command
      extended by org.jsmpp.bean.AbstractSmCommand
Direct Known Subclasses:
DataSm, MessageRequest

public class AbstractSmCommand
extends Command

Author:
uudashr

Field Summary
protected  byte dataCoding
           
protected  java.lang.String destAddress
           
protected  byte destAddrNpi
           
protected  byte destAddrTon
           
protected  byte esmClass
           
protected  OptionalParameter[] optionalParametes
           
protected  byte registeredDelivery
           
protected  java.lang.String serviceType
           
protected  java.lang.String sourceAddr
           
protected  byte sourceAddrNpi
           
protected  byte sourceAddrTon
           
 
Fields inherited from class org.jsmpp.bean.Command
commandId, commandLength, commandStatus, sequenceNumber
 
Constructor Summary
AbstractSmCommand()
           
 
Method Summary
protected static byte cleanMessageType(byte esmClass)
          Clean the Message Type or clean the ESM Class at bits 5 - 2.
protected static byte cleanMessagingMode(byte esmClass)
          Clean the Messaging Mode or clean the ESM Class at bits 1 - 0.
protected static byte cleanSmeAck(byte registeredDelivery)
           
protected static byte cleanSmscDeliveryReceipt(byte registeredDelivery)
           
protected static byte cleanSpecificFeatures(byte esmClass)
          Clean the Specific Features or ESM Class at bits 7 - 6.
static byte composeDefaultMessageType(byte esmClass)
          Message Type.
protected static byte composeMessageType(byte esmClass, byte messageTypeValue)
          Compose the Message Type.
protected static byte composeMessagingMode(byte esmClass, byte messagingModeValue)
          Compose the Messaging Mode.
static byte composeReplyPath(byte esmClass)
          Specific Features.
protected static byte composeSmeAck(byte registeredDelivery, byte smeOriginatedValue)
           
protected static byte composeSmscDelReceipt(byte registeredDelivery, byte smscDeliveryReceiptValue)
           
protected static byte composeSpecificFeatures(byte esmClass, byte specificFeaturesValue)
          Compose Specific Features.
static byte composeUdhi(byte esmClass)
          Specific Features.
static byte composeUdhiAndReplyPath(byte esmClass)
          Specific Features.
 boolean equals(java.lang.Object obj)
           
 byte getDataCoding()
           
 java.lang.String getDestAddress()
           
 byte getDestAddrNpi()
           
 byte getDestAddrTon()
           
 byte getEsmClass()
           
 OptionalParameter[] getOptionalParametes()
           
 byte getRegisteredDelivery()
           
 java.lang.String getServiceType()
           
 java.lang.String getSourceAddr()
           
 byte getSourceAddrNpi()
           
 byte getSourceAddrTon()
           
 int hashCode()
           
 boolean isDefaultMessageType()
          Message Type.
static boolean isDefaultMessageType(byte esmClass)
          Message Type.
protected static boolean isMessageType(byte esmClass, byte messageTypeValue)
           
protected static boolean isMessagingMode(byte esmClass, byte messagingModeValue)
           
 boolean isReplyPath()
          Specific Features.
static boolean isReplyPath(byte esmClass)
          Specific Features.
protected static boolean isSmeAck(byte registeredDeliery, byte smeOriginatedAckValue)
          SME originated Acknowledgement.
protected static boolean isSmscDeliveryReceipt(byte registeredDelivery, byte smscDeliveryReceiptValue)
          SMSC Delivery Receipt.
protected static boolean isSpecificFeatures(byte esmClass, byte specificFeaturesValue)
           
 boolean isUdhi()
          Specific Features.
static boolean isUdhi(byte esmClass)
          Specific Features.
 boolean isUdhiAndReplyPath()
          Specific Features.
static boolean isUdhiAndReplyPath(byte esmClass)
          Specific Features.
 void setDataCoding(byte dataCoding)
           
 void setDefaultMessageType()
          Message Type.
 void setDestAddress(java.lang.String destAddress)
           
 void setDestAddrNpi(byte destAddrNpi)
           
 void setDestAddrTon(byte destAddrTon)
           
 void setEsmClass(byte esmClass)
           
 void setOptionalParametes(OptionalParameter... optionalParametes)
           
 void setRegisteredDelivery(byte registeredDelivery)
           
 void setReplyPath()
          Specific Features.
 void setServiceType(java.lang.String serviceType)
           
 void setSourceAddr(java.lang.String sourceAddr)
           
 void setSourceAddrNpi(byte sourceAddrNpi)
           
 void setSourceAddrTon(byte sourceAddrTon)
           
 void setUdhi()
          Specific Features.
 void setUdhiAndReplyPath()
          Specific Features.
 
Methods inherited from class org.jsmpp.bean.Command
getCommandId, getCommandIdAsHex, getCommandLength, getCommandStatus, getCommandStatusAsHex, getSequenceNumber, setCommandId, setCommandLength, setCommandStatus, setSequenceNumber, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

serviceType

protected java.lang.String serviceType

sourceAddrTon

protected byte sourceAddrTon

sourceAddrNpi

protected byte sourceAddrNpi

sourceAddr

protected java.lang.String sourceAddr

destAddrTon

protected byte destAddrTon

destAddrNpi

protected byte destAddrNpi

destAddress

protected java.lang.String destAddress

esmClass

protected byte esmClass

registeredDelivery

protected byte registeredDelivery

dataCoding

protected byte dataCoding

optionalParametes

protected OptionalParameter[] optionalParametes
Constructor Detail

AbstractSmCommand

public AbstractSmCommand()
Method Detail

isDefaultMessageType

public boolean isDefaultMessageType()
Message Type.

Returns:

setDefaultMessageType

public void setDefaultMessageType()
Message Type.


isUdhi

public boolean isUdhi()
Specific Features.

Returns:

setUdhi

public void setUdhi()
Specific Features.


isReplyPath

public boolean isReplyPath()
Specific Features.

Returns:

setReplyPath

public void setReplyPath()
Specific Features.


isUdhiAndReplyPath

public boolean isUdhiAndReplyPath()
Specific Features.

Returns:

setUdhiAndReplyPath

public void setUdhiAndReplyPath()
Specific Features.


getDataCoding

public byte getDataCoding()
Returns:
the dataCoding

setDataCoding

public void setDataCoding(byte dataCoding)
Parameters:
dataCoding - the dataCoding to set

getDestAddrTon

public byte getDestAddrTon()

setDestAddrTon

public void setDestAddrTon(byte destAddrTon)

getDestAddrNpi

public byte getDestAddrNpi()

setDestAddrNpi

public void setDestAddrNpi(byte destAddrNpi)

getDestAddress

public java.lang.String getDestAddress()

setDestAddress

public void setDestAddress(java.lang.String destAddress)

getEsmClass

public byte getEsmClass()
Returns:
the esmClass

setEsmClass

public void setEsmClass(byte esmClass)
Parameters:
esmClass - the esmClass to set

getRegisteredDelivery

public byte getRegisteredDelivery()
Returns:
the registeredDelivery

setRegisteredDelivery

public void setRegisteredDelivery(byte registeredDelivery)
Parameters:
registeredDelivery - the registeredDelivery to set

getServiceType

public java.lang.String getServiceType()
Returns:
the serviceType

setServiceType

public void setServiceType(java.lang.String serviceType)
Parameters:
serviceType - the serviceType to set

getOptionalParametes

public OptionalParameter[] getOptionalParametes()

setOptionalParametes

public void setOptionalParametes(OptionalParameter... optionalParametes)

getSourceAddrTon

public byte getSourceAddrTon()

setSourceAddrTon

public void setSourceAddrTon(byte sourceAddrTon)

getSourceAddrNpi

public byte getSourceAddrNpi()

setSourceAddrNpi

public void setSourceAddrNpi(byte sourceAddrNpi)

getSourceAddr

public java.lang.String getSourceAddr()

setSourceAddr

public void setSourceAddr(java.lang.String sourceAddr)

isDefaultMessageType

public static boolean isDefaultMessageType(byte esmClass)
Message Type. Default message Type.

Parameters:
esmClass -
Returns:
true if esmClass indicate delivery receipt

composeDefaultMessageType

public static byte composeDefaultMessageType(byte esmClass)
Message Type. Compose the esm_class as with default message Type.

Parameters:
esmClass -
Returns:

isUdhi

public static boolean isUdhi(byte esmClass)
Specific Features.

Parameters:
esmClass -
Returns:

composeUdhi

public static byte composeUdhi(byte esmClass)
Specific Features.

Parameters:
esmClass -
Returns:

isReplyPath

public static boolean isReplyPath(byte esmClass)
Specific Features.

Parameters:
esmClass -
Returns:

composeReplyPath

public static byte composeReplyPath(byte esmClass)
Specific Features.

Parameters:
esmClass -
Returns:

isUdhiAndReplyPath

public static boolean isUdhiAndReplyPath(byte esmClass)
Specific Features.

Parameters:
esmClass -
Returns:

composeUdhiAndReplyPath

public static byte composeUdhiAndReplyPath(byte esmClass)
Specific Features.

Parameters:
esmClass -
Returns:

isMessagingMode

protected static final boolean isMessagingMode(byte esmClass,
                                               byte messagingModeValue)

composeMessagingMode

protected static final byte composeMessagingMode(byte esmClass,
                                                 byte messagingModeValue)
Compose the Messaging Mode. Messaging Mode encoded on ESM Class at bits 1 - 0.

Parameters:
esmClass - current/old ESM class.
messagingModeValue -
Returns:
the encoded messaging mode at ESM class

cleanMessagingMode

protected static final byte cleanMessagingMode(byte esmClass)
Clean the Messaging Mode or clean the ESM Class at bits 1 - 0.

Parameters:
esmClass -
Returns:

isMessageType

protected static final boolean isMessageType(byte esmClass,
                                             byte messageTypeValue)

composeMessageType

protected static final byte composeMessageType(byte esmClass,
                                               byte messageTypeValue)
Compose the Message Type. Message Type encoded on ESM Class at bits 5 - 2.

Parameters:
esmClass -
messageTypeValue -
Returns:

cleanMessageType

protected static final byte cleanMessageType(byte esmClass)
Clean the Message Type or clean the ESM Class at bits 5 - 2.

Parameters:
esmClass -
Returns:

isSpecificFeatures

protected static final boolean isSpecificFeatures(byte esmClass,
                                                  byte specificFeaturesValue)

composeSpecificFeatures

protected static final byte composeSpecificFeatures(byte esmClass,
                                                    byte specificFeaturesValue)
Compose Specific Features. Specific Features encoded on ESM Class at bits 7 - 6.

Parameters:
esmClass -
specificFeaturesValue -
Returns:

cleanSpecificFeatures

protected static final byte cleanSpecificFeatures(byte esmClass)
Clean the Specific Features or ESM Class at bits 7 - 6.

Parameters:
esmClass -
Returns:

isSmscDeliveryReceipt

protected static final boolean isSmscDeliveryReceipt(byte registeredDelivery,
                                                     byte smscDeliveryReceiptValue)
SMSC Delivery Receipt.

Parameters:
registeredDelivery -
smscDeliveryReceiptValue -
Returns:

composeSmscDelReceipt

protected static final byte composeSmscDelReceipt(byte registeredDelivery,
                                                  byte smscDeliveryReceiptValue)

cleanSmscDeliveryReceipt

protected static final byte cleanSmscDeliveryReceipt(byte registeredDelivery)

isSmeAck

protected static final boolean isSmeAck(byte registeredDeliery,
                                        byte smeOriginatedAckValue)
SME originated Acknowledgement.

Parameters:
registeredDeliery -
smeOriginatedAckValue -
Returns:

composeSmeAck

protected static final byte composeSmeAck(byte registeredDelivery,
                                          byte smeOriginatedValue)

cleanSmeAck

protected static final byte cleanSmeAck(byte registeredDelivery)

hashCode

public int hashCode()
Overrides:
hashCode in class Command

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class Command