SubmitSmAdapter (ogham 3.1.0-SNAPSHOT API)

java.lang.Object
- fr.sii.ogham.testing.sms.simulator.jsmpp.SubmitSmAdapter

All Implemented Interfaces:

SubmitSm
```
public class SubmitSmAdapter
extends Object
implements SubmitSm
```
Adapts JSMPP SubmitSm into SubmitSm abstraction.

Author:

Aurélien Baudet

Field Summary

Fields
Modifier and Type Field and Description

protected org.jsmpp.bean.SubmitSm original

Fields
Modifier and Type	Field and Description
`protected org.jsmpp.bean.SubmitSm`	`original`

Constructor Summary

Constructors
Constructor and Description

SubmitSmAdapter(org.jsmpp.bean.SubmitSm original)

Constructors
Constructor and Description
`SubmitSmAdapter(org.jsmpp.bean.SubmitSm original)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Command`	`getCommand()` Get information relative to the command (command id, command length, command status and sequence number)
`byte`	`getDataCoding()` Get the 'data_coding' field
`Address`	`getDestAddress()` Specifies the destination SME address.
`byte`	`getEsmClass()` The 'esm_class' parameter is used to indicate special message attributes associated with the short message.
`OptionalParameter`	`getOptionalParameter(Tag tag)` Get Optional Parameter that matches the specified tag.
`List<OptionalParameter>`	`getOptionalParameters()` Get the list of all Optional Parameters.
`byte`	`getPriorityFlag()` The priority_flag parameter allows the originating SME to assign a priority level to the short message.
`byte`	`getProtocolId()` GSM Set according to GSM 03.40 [GSM 03.40] ANSI-136 (TDMA) For mobile terminated messages, this field is not used and is therefore ignored by the SMSC.
`byte`	`getRegisteredDelivery()` The registered_delivery parameter is used to request an SMSC delivery receipt and/or SME originated acknowledgements.
`byte`	`getReplaceIfPresentFlag()` The replace_if_present_flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery.
`String`	`getScheduleDeliveryTime()` This parameter specifies the scheduled time at which the message delivery should be first attempted.
`String`	`getServiceType()` The service_type parameter can be used to indicate the SMS Application service associated with the message.
`byte[]`	`getShortMessage()` The short_message parameter contains the user data.
`int`	`getShortMessageLength()` The sm_length parameter specifies the length of the short_message parameter in octets.
`byte`	`getSmDefaultMsgId()` The sm_default_msg_id parameter specifies the SMSC index of a pre-defined ('canned') message.
`Address`	`getSourceAddress()` Specifies the address of SME which originated this message.
`String`	`getValidityPeriod()` The validity_period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination.
`boolean`	`isUdhi()` Specific Features.

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

- Field Detail
  - original
```
protected final org.jsmpp.bean.SubmitSm original
```
- Constructor Detail
  - SubmitSmAdapter
```
public SubmitSmAdapter(org.jsmpp.bean.SubmitSm original)
```
    Parameters:
    
    original - the JSMPP SubmitSm to adapt
- Method Detail
  - getCommand
```
public Command getCommand()
```
    Description copied from interface: SubmitSm
    
    Get information relative to the command (command id, command length, command status and sequence number)
    
    Specified by:
    
    getCommand in interface SubmitSm
    
    Returns:
    
    the command wrapper
  - getServiceType
```
public String getServiceType()
```
    Description copied from interface: SubmitSm
    The service_type parameter can be used to indicate the SMS Application service associated with the message. Specifying the service_type allows the ESME to:
    - Avail of enhanced messaging services such as message 'replace_if_present' by service type (generic).
    - Control the teleservice used on the air interface (e.g. ANSI-136/TDMA, IS-95/CDMA).
    SMSC's may implicitly associate a "replace if present" function from the indicated service_type in a message submission operation, i.e., the SMSC will always replace an existing message pending delivery, that has the same originating and destination address as the submitted message. For example, an SMSC can ensure that a Voice Mail System using a service_type of 'VMA" has at most one outstanding notification per destination MS by automatically invoking the "replace if present" function.
    Specified by:
    
    getServiceType in interface SubmitSm
    
    Returns:
    
    the serviceType
  - getSourceAddress
```
public Address getSourceAddress()
```
    Description copied from interface: SubmitSm
    
    Specifies the address of SME which originated this message. An ESME which is implemented as a single SME address, may set this field to NULL to allow the SMSC to default the source address of the submitted message.
    
    Specified by:
    
    getSourceAddress in interface SubmitSm
    
    Returns:
    
    source address (TON, NPI and address)
  - getDestAddress
```
public Address getDestAddress()
```
    Description copied from interface: SubmitSm
    
    Specifies the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS.
    
    Specified by:
    
    getDestAddress in interface SubmitSm
    
    Returns:
    
    destination address (TON, NPI and address)
  - getEsmClass
```
public byte getEsmClass()
```
    Description copied from interface: SubmitSm
    
    The 'esm_class' parameter is used to indicate special message attributes associated with the short message.
    
    Specified by:
    
    getEsmClass in interface SubmitSm
    
    Returns:
    
    the 'esm_class' parameter
  - getRegisteredDelivery
```
public byte getRegisteredDelivery()
```
    Description copied from interface: SubmitSm
    
    The registered_delivery parameter is used to request an SMSC delivery receipt and/or SME originated acknowledgements.
    
    Specified by:
    
    getRegisteredDelivery in interface SubmitSm
    
    Returns:
    
    the registered delivery parameter
  - getDataCoding
```
public byte getDataCoding()
```
    Description copied from interface: SubmitSm
    
    Get the 'data_coding' field
    
    Specified by:
    
    getDataCoding in interface SubmitSm
    
    Returns:
    
    the 'data_coding' field
  - getShortMessage
```
public byte[] getShortMessage()
```
    Description copied from interface: SubmitSm
    
    The short_message parameter contains the user data. A maximum of 254 octets can be sent. ESME's should use the optional message_payload parameter in submit_sm, submit_multi, and deliver_sm to send larger user data sizes. Returns the short_message field. It contains the message payload. It also may contain a header (User Data Header).
    
    Specified by:
    
    getShortMessage in interface SubmitSm
    
    Returns:
    
    the short message (header? + payload)
  - getShortMessageLength
```
public int getShortMessageLength()
```
    Description copied from interface: SubmitSm
    
    The sm_length parameter specifies the length of the short_message parameter in octets. The sm_length should be set to 0 in the submit_sm, submit_multi, and deliver_sm PDUs if the message_payload parameter is being used to send user data larger than 254 octets.
    
    Specified by:
    
    getShortMessageLength in interface SubmitSm
    
    Returns:
    
    the sm_length parameter
  - getOptionalParameter
```
public OptionalParameter getOptionalParameter(Tag tag)
```
    Description copied from interface: SubmitSm
    
    Get Optional Parameter that matches the specified tag. Optional Parameters are fields, which may be optionally included in an SMPP message. Optional Parameters must always appear at the end of a message, in the "Optional Parameters" section of the SMPP PDU. However, they may be included in any convenient order within the "Optional Parameters" section of the SMPP PDU and need not be encoded in the order presented in this document. For a particular SMPP PDU, the ESME or SMSC may include some, all or none of the defined optional parameters as required for the particular application context. For example a paging system may in an SMPP submit_sm operation, include only the "callback number" related optional parameters.
    
    Specified by:
    
    getOptionalParameter in interface SubmitSm
    
    Parameters:
    
    tag - the tag of the optional parameter
    
    Returns:
    
    the optional parameter if exists or null
  - getOptionalParameters
```
public List<OptionalParameter> getOptionalParameters()
```
    Description copied from interface: SubmitSm
    
    Get the list of all Optional Parameters. Optional Parameters are fields, which may be optionally included in an SMPP message. Optional Parameters must always appear at the end of a message, in the "Optional Parameters" section of the SMPP PDU. However, they may be included in any convenient order within the "Optional Parameters" section of the SMPP PDU and need not be encoded in the order presented in this document. For a particular SMPP PDU, the ESME or SMSC may include some, all or none of the defined optional parameters as required for the particular application context. For example a paging system may in an SMPP submit_sm operation, include only the "callback number" related optional parameters.
    
    Specified by:
    
    getOptionalParameters in interface SubmitSm
    
    Returns:
    
    the list of parameters
  - getPriorityFlag
```
public byte getPriorityFlag()
```
    Description copied from interface: SubmitSm
    The priority_flag parameter allows the originating SME to assign a priority level to the short message. Four Priority Levels are supported:
    - 0 = Level 0 (lowest) priority
    - 1 = Level 1
    - priority 2 = Level 2
    - priority 3 = Level 3 (highest) priority
    - >3 = Reserved
    Specified by:
    
    getPriorityFlag in interface SubmitSm
    
    Returns:
    
    the priority
  - getProtocolId
```
public byte getProtocolId()
```
    Description copied from interface: SubmitSm
    
    GSM Set according to GSM 03.40 [GSM 03.40] ANSI-136 (TDMA) For mobile terminated messages, this field is not used and is therefore ignored by the SMSC. For ANSI-136 mobile originated messages, the SMSC should set this value to NULL. IS-95 (CDMA) For mobile terminated messages, this field is not used and is therefore ignored by the SMSC. For IS-95 mobile originated messages, the SMSC should set this value to NULL.
    
    Specified by:
    
    getProtocolId in interface SubmitSm
    
    Returns:
    
    the protocolId
  - getReplaceIfPresentFlag
```
public byte getReplaceIfPresentFlag()
```
    Description copied from interface: SubmitSm
    
    The replace_if_present_flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service_type match the same fields in the new message.
    
    Specified by:
    
    getReplaceIfPresentFlag in interface SubmitSm
    
    Returns:
    
    the 'replace_if_present_flag' field
  - getScheduleDeliveryTime
```
public String getScheduleDeliveryTime()
```
    Description copied from interface: SubmitSm
    
    This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in Section 7.1.1.
    
    Specified by:
    
    getScheduleDeliveryTime in interface SubmitSm
    
    Returns:
    
    the scheduleDeliveryTime
  - getSmDefaultMsgId
```
public byte getSmDefaultMsgId()
```
    Description copied from interface: SubmitSm
    
    The sm_default_msg_id parameter specifies the SMSC index of a pre-defined ('canned') message.
    
    Specified by:
    
    getSmDefaultMsgId in interface SubmitSm
    
    Returns:
    
    the sm_default_msg_id
  - getValidityPeriod
```
public String getValidityPeriod()
```
    Description copied from interface: SubmitSm
    
    The validity_period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. It can be defined in absolute time format or relative time format. The encoding of absolute and relative time format is specified in Section 7.1.1.
    
    Specified by:
    
    getValidityPeriod in interface SubmitSm
    
    Returns:
    
    the validityPeriod
  - isUdhi
```
public boolean isUdhi()
```
    Description copied from interface: SubmitSm
    
    Specific Features.
    
    Specified by:
    
    isUdhi in interface SubmitSm
    
    Returns:
    
    if the esmClass contains the User Data Header Indicator

Class SubmitSmAdapter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

original

Constructor Detail

SubmitSmAdapter

Method Detail

getCommand

getServiceType

getSourceAddress

getDestAddress

getEsmClass

getRegisteredDelivery

getDataCoding

getShortMessage

getShortMessageLength

getOptionalParameter

getOptionalParameters

getPriorityFlag

getProtocolId

getReplaceIfPresentFlag

getScheduleDeliveryTime

getSmDefaultMsgId

getValidityPeriod

isUdhi