Skip navigation links

oracle.ocsg.sms.smpp.management
Interface SmsMBean

public interface SmsMBean

This interface defines the attributes and operations of the SMPP plugin that can be managed.

Field Summary

static boolean	activeStatus The current active status of the SMPP plugin.
static boolean	dataSm Use DATA_SM (only when sending binary data)
static int	defaultDataCoding Set the default data coding to use when sending SMS messages.
static int	destinationAddressNpi The ESME Numbering Plan Indicator (NPI).
static int	destinationAddressTon The ESME Type Of Number (TON).
static int	enquireLinkTimerValue The Enquire Link Timer value in seconds.
static boolean	forwardXParams
static int	maxKeywordLimit The maximum number of keywords to use for shortcode mapping search criteria.
static int	messagingMode The ESM_CLASS Messaging Mode for packets.
static int	mobileCountryCode Set the Mobile Country Code for sending operator logo
static int	mobileNetworkCode Set the Mobile Network Code for sending operator logo
static int	originatingAddressNpi The ESME Numbering Plan Indicator (NPI).
static int	originatingAddressTon The ESME Type Of Number (TON).
static int	receiveSegmentsWaitTime Specifies the maxium time in seconds to wait on the arrival of the segments of a concatenated SMS from SMSC since the arrival of the first segment
static boolean	receiveSmsIgnoreMissingSegments This flag determines whether or not to deliver incomplete messages received with missing segments to the application If set to true, the plug-in will re-assemble the received segments and deliver the incomplete message to the application If set to false, the plug-in will not deliver messages to the application unless all segments are received
static boolean	requestDeliveryReports Delivery report flag.
static int	segmentsLimit The limit of number of segmentation allowed.
static int	sequenceNumberRangeEndId Set the end ID of the Sequence Number range.
static int	sequenceNumberRangeStartId Set the start ID of the sequence number range.
static int	SMSCDefaultAlphabet The SMSC Default Alphabet.
static boolean	useMessagePayload Use message payload flag.
static int	userTextMaxLength The User Text Max Length.

Method Summary

void	addDestinationAddressTypeMapping(String type, int ton, int npi) Adds a new TON/NPI mapping for a new Destinationaddress type.
void	addOriginatingAddressTypeMapping(String type, int ton, int npi) Adds a new TON/NPI mapping for a new originatingaddress type.
int	countOfflineNotificationCache() Count the number of entries in the offline notification cache.
int	countOnlineNotificationCache() Count the number of entries in the online notification cache.
int	countSmsCache() Count the number of entries in the sms caches (sum of MT and MO caches).
String	enableReceiveSms(String shortCode, String criteria, String appInstanceID) This method is used to add an offline notification for applications that will poll for MO messages.
boolean	getActiveStatus() Check the current active status of the SMPP plugin.
boolean	getDataSm()
int	getDefaultDataCoding()
int	getDestinationAddressNpi()
int	getDestinationAddressTon()
int	getEnquireLinkTimerValue()
boolean	getForwardXParams()
int	getMaxKeywordLimit()
int	getMessagingMode()
int	getMobileCountryCode()
int	getMobileNetworkCode()
String	getModuleId() return module id
NotificationInfo	getOfflineNotificationInfo(String correlator) Get the notification associated with the specified correlator.
NotificationInfo	getOnlineNotificationInfo(String correlator) Get the notification associated with the specified correlator.
int	getOriginatingAddressNpi()
int	getOriginatingAddressTon()
int	getReceiveSegmentsWaitTime()
boolean	getReceiveSmsIgnoreMissingSegments()
boolean	getRequestDeliveryReports()
int	getSegmentsLimit()
int	getSequenceNumberRangeEndId()
int	getSequenceNumberRangeStartId()
String	getSMSCDefaultAlphabet()
boolean	getUseMessagePayload()
int	getUserTextMaxLength()
String[]	listDestinationAddressTypeMappings()
String[]	listOfflineNotificationInfo() Lists all offline notifications (added using the OAM enableReceiveSms method).
String[]	listOnlineBinaryNotificationInfo() Lists all online Binary notifications (added using startBinarySmsNotification).
String[]	listOnlineNotificationInfo() Lists all online notifications (added using startSmsNotification).
String[]	listOriginatingAddressTypeMappings()
void	modifyOnlineNotificationInfo(String correlator, String endPoint, String shortCode, String criteria, String appInstGroupID) Modify an existing Online sms notification using an existing correlator.
void	removeDestinationAddressTypeMapping(String type)
void	removeOfflineNotificationInfo(String registrationIdentifier) Remove an offline notification that was added using the OAM enableReceiveSms method
void	removeOnlineBinaryNotificationInfo(String correlator) Remove the specified online binary sms notification that was added using OAM interfaces or application interfaces (startBinarySmsNotification).
void	removeOnlineNotificationInfo(String correlator) Remove the specified online notification that was added using OAM interfaces or application interfaces (startSmsNotification).
void	removeOriginatingAddressTypeMapping(String type)
void	setDataSm(boolean value)
void	setDefaultDataCoding(int dataCoding)
void	setDestinationAddressNpi(int npi)
void	setDestinationAddressTon(int ton)
void	setEnquireLinkTimerValue(int timerValue)
void	setForwardXParams(boolean _value)
void	setMaxKeywordLimit(int maxKeywordLimit)
void	setMessagingMode(int mode)
void	setMobileCountryCode(int mcc)
void	setMobileNetworkCode(int mnc)
void	setOriginatingAddressNpi(int npi)
void	setOriginatingAddressTon(int ton)
void	setReceiveSegmentsWaitTime(int timeout)
void	setReceiveSmsIgnoreMissingSegments(boolean b)
void	setRequestDeliveryReports(boolean requestDeliveryReports)
void	setSegmentsLimit(int limit)
void	setSequenceNumberRangeEndId(int endId)
void	setSequenceNumberRangeStartId(int startId)
void	setSMSCDefaultAlphabet(String characterEncodingScheme)
void	setUseMessagePayload(boolean useMessagePayload)
void	setUserTextMaxLength(int userTextMaxLength)
String	startBinarySmsNotification(String endpoint, String shortCode, String appInstanceID) Add an online binary sms notification for applications that for some reason can not (or are not allowed) call the startBinarySmsNotification method.
String	startSmsNotification(String endpoint, String shortCode, String criteria, String appInstanceID) Add an online notification for applications that for some reason can not (or are not allowed) call the startSmsNotification method.
int	translateDestinationAddressNpi(String type)
int	translateDestinationAddressTon(String type)
int	translateOriginatingAddressNpi(String type)
int	translateOriginatingAddressTon(String type)

Field Detail

activeStatus

public static final boolean activeStatus

The current active status of the SMPP plugin. Is true if the transmitter connection has been successfully bound.

See Also:

Constant Field Values

dataSm

public static final boolean dataSm

Use DATA_SM (only when sending binary data)

See Also:

Constant Field Values

defaultDataCoding

public static final int defaultDataCoding

Set the default data coding to use when sending SMS messages. This value will be used if a data coding is not provided by the north bound interface. See data_coding parameter in SMPP specification for valid values. Example values: 0=SMSC Default Alphabet 1=ASCII 8=USC2

See Also:

Constant Field Values

destinationAddressNpi

public static final int destinationAddressNpi

The ESME Numbering Plan Indicator (NPI). Used as a default for destination address.

See Also:

Constant Field Values

destinationAddressTon

public static final int destinationAddressTon

The ESME Type Of Number (TON). Used as a default for destination address. 0=UNKNOWN 1=INTERNATIONAL 2=NATIONAL 3=NETWORK 4=SUBSCRIBER 5=ALPHANUMERIC 6=ABBREVIATED 7=RESERVED_EXTN

See Also:

Constant Field Values

enquireLinkTimerValue

public static final int enquireLinkTimerValue

The Enquire Link Timer value in seconds. The SMPP Plugin will send the Enquire Link Operation to the SMSC to keep the connection alive. The time between enquieries is specified by this timer value. NOTE! To turn off the sending of Enquire Link, set the timer value to zero.

See Also:

Constant Field Values

forwardXParams

public static final boolean forwardXParams

See Also:

Constant Field Values

maxKeywordLimit

public static final int maxKeywordLimit

The maximum number of keywords to use for shortcode mapping search criteria.

See Also:

Constant Field Values

messagingMode

public static final int messagingMode

The ESM_CLASS Messaging Mode for packets. 2 - Forward (i.e. Transaction) mode. Only used when DATA_SM, otherwise Store and Forward mode is used. 3 - Store and Forward mode

See Also:

Constant Field Values

mobileCountryCode

public static final int mobileCountryCode

Set the Mobile Country Code for sending operator logo

See Also:

Constant Field Values

mobileNetworkCode

public static final int mobileNetworkCode

Set the Mobile Network Code for sending operator logo

See Also:

Constant Field Values

originatingAddressNpi

public static final int originatingAddressNpi

The ESME Numbering Plan Indicator (NPI). Used as a default for originating address.

See Also:

Constant Field Values

originatingAddressTon

public static final int originatingAddressTon

The ESME Type Of Number (TON). Used as a default for originating address. 0=UNKNOWN 1=INTERNATIONAL 2=NATIONAL 3=NETWORK 4=SUBSCRIBER 5=ALPHANUMERIC 6=ABBREVIATED 7=RESERVED_EXTN

See Also:

Constant Field Values

receiveSegmentsWaitTime

public static final int receiveSegmentsWaitTime

Specifies the maxium time in seconds to wait on the arrival of the segments of a concatenated SMS from SMSC since the arrival of the first segment

See Also:

Constant Field Values

receiveSmsIgnoreMissingSegments

public static final boolean receiveSmsIgnoreMissingSegments

This flag determines whether or not to deliver incomplete messages received with missing segments to the application If set to true, the plug-in will re-assemble the received segments and deliver the incomplete message to the application If set to false, the plug-in will not deliver messages to the application unless all segments are received

See Also:

Constant Field Values

requestDeliveryReports

public static final boolean requestDeliveryReports

Delivery report flag. This flag will determine if the SMPP plugin shall ask for delivery reports or not. If set to true, delivery reports will be requested. Note that application specific settings may override this flag if this flag is true. Delivery report requesting is calculated as getRequestDeliveryReports() && applicationSpecificFlag. The application specific flag shall be sent in the tunneled parameter: 'com.bea.wlcp.wlng.plugin.sms.RequestDeliveryReportFlag'

See Also:

Constant Field Values

segmentsLimit

public static final int segmentsLimit

The limit of number of segmentation allowed.

See Also:

Constant Field Values

sequenceNumberRangeEndId

public static final int sequenceNumberRangeEndId

Set the end ID of the Sequence Number range. The ID Manager will not generating IDs larger than this value.

See Also:

Constant Field Values

sequenceNumberRangeStartId

public static final int sequenceNumberRangeStartId

Set the start ID of the sequence number range. The ID Manager will start generating IDs beginning with this value.

See Also:

Constant Field Values

SMSCDefaultAlphabet

public static final int SMSCDefaultAlphabet

The SMSC Default Alphabet. This is the default character encoding scheme that is used by the SMSC when encoding the short message. The Plugin needs to use the same character encoding scheme for the characters to be decoded correctly. The following encoding schemes are supported: All encoding schemes supported by JAVA. Example: ASCII (American Standard Code for Information Interchange) Cp1252 (Windows Latin-1) ISO8859_1 (ISO 8859-1, Latin alphabet No. 1) Specify GSM_DEFAULT for default GSM character set.

See Also:

Constant Field Values

useMessagePayload

public static final boolean useMessagePayload

Use message payload flag. This flag indicates whether the message is carried as optional message_payload or as short_message in the SMPP PDU. Current behavior predicates that only segmented messages like ringtones, logos, long sms that have a UDH are carried as optional message_payload. If this flag is set to false, segmented or unsegmented messages are sent in the short_message.

See Also:

Constant Field Values

userTextMaxLength

public static final int userTextMaxLength

The User Text Max Length. This is the maximum number of characters allowed in a message to be sent using the Short Message Service.

See Also:

Constant Field Values

Method Detail

addDestinationAddressTypeMapping

public void addDestinationAddressTypeMapping(String type,
                                             int ton,
                                             int npi)
                                      throws ManagementException

Adds a new TON/NPI mapping for a new Destinationaddress type. The plugin will use the tunneled parameter com.bea.wlcp.wlng.plugin.sms.DestinationAddressType.0...n-1 and do a translation. com.bea.wlcp.wlng.plugin.sms.DestinationAddressType.0 should match the specified type type: The new type for the mapping ton: The TON to use. 0=UNKNOWN 1=INTERNATIONAL 2=NATIONAL 3=NETWORK 4=SUBSCRIBER 5=ALPHANUMERIC 6=ABBREVIATED 7=RESERVED_EXTN npi: The NPI to use. 0=Unknown 1=ISDN(E163/E164) 3=Data(X.121) 4=Telex(F.69) 6=Land Mobile(E.212) 8=National 9=Private 10=ERMES 14=Internet(IP) 18=WAP Client ID

Throws:

ManagementException

addOriginatingAddressTypeMapping

public void addOriginatingAddressTypeMapping(String type,
                                             int ton,
                                             int npi)
                                      throws ManagementException

Adds a new TON/NPI mapping for a new originatingaddress type. The plugin will use the tunneled parameter com.bea.wlcp.wlng.plugin.sms.OriginatingAddressType and do a translation. com.bea.wlcp.wlng.plugin.sms.OriginatingAddressType should match the specified type

Parameters:

type - The new type for the mapping

ton - The TON to use. 0=UNKNOWN 1=INTERNATIONAL 2=NATIONAL 3=NETWORK 4=SUBSCRIBER 5=ALPHANUMERIC 6=ABBREVIATED 7=RESERVED_EXTN

npi - The NPI to use. 0=Unknown 1=ISDN(E163/E164) 3=Data(X.121) 4=Telex(F.69) 6=Land Mobile(E.212) 8=National 9=Private 10=ERMES 14=Internet(IP) 18=WAP Client ID

Throws:

ManagementException

countOfflineNotificationCache

public int countOfflineNotificationCache()

Count the number of entries in the offline notification cache.

countOnlineNotificationCache

public int countOnlineNotificationCache()

Count the number of entries in the online notification cache.

countSmsCache

public int countSmsCache()

Count the number of entries in the sms caches (sum of MT and MO caches).

enableReceiveSms

public String enableReceiveSms(String shortCode,
                               String criteria,
                               String appInstanceID)

This method is used to add an offline notification for applications that will poll for MO messages. MO messages matching this notification will not result in a callback to an application, the application has to use the correlator returned by this method and poll for new messages.

Parameters:

shortCode - The destination address/service activation number of the short message with URI prefixed, e.g. t"el:6001".

criteria - The text to match against to determine the application to receive the notification.

appInstanceID - The applicationInstanceID to associate with this notification.

Returns:

the correlator uniquely identifying the new notification.

getActiveStatus

public boolean getActiveStatus()

Check the current active status of the SMPP plugin. Will return true if the transmitter connection has been successfully bound.

getDataSm

public boolean getDataSm()
                  throws ManagementException

Throws:

ManagementException

getDefaultDataCoding

public int getDefaultDataCoding()
                         throws ManagementException

Throws:

ManagementException

getDestinationAddressNpi

public int getDestinationAddressNpi()
                             throws ManagementException

Throws:

ManagementException

getDestinationAddressTon

public int getDestinationAddressTon()
                             throws ManagementException

Throws:

ManagementException

getEnquireLinkTimerValue

public int getEnquireLinkTimerValue()
                             throws ManagementException

Throws:

ManagementException

getForwardXParams

public boolean getForwardXParams()
                          throws ManagementException

Throws:

ManagementException

getMaxKeywordLimit

public int getMaxKeywordLimit()
                       throws ManagementException

Throws:

ManagementException

getMessagingMode

public int getMessagingMode()
                     throws ManagementException

Throws:

ManagementException

getMobileCountryCode

public int getMobileCountryCode()
                         throws ManagementException

Throws:

ManagementException

getMobileNetworkCode

public int getMobileNetworkCode()
                         throws ManagementException

Throws:

ManagementException

getModuleId

public String getModuleId()
                   throws ManagementException

return module id

Throws:

ManagementException

getOfflineNotificationInfo

public NotificationInfo getOfflineNotificationInfo(String correlator)

Get the notification associated with the specified correlator. An offline notification is a notification that has been added using the OAM enableReceiveSms method.

Parameters:

correlator -

getOnlineNotificationInfo

public NotificationInfo getOnlineNotificationInfo(String correlator)

Get the notification associated with the specified correlator. An online notification is a notification that has been added using startSmsNotification, through OAM interfaces or through an application interface.

Parameters:

correlator -

getOriginatingAddressNpi

public int getOriginatingAddressNpi()
                             throws ManagementException

Throws:

ManagementException

getOriginatingAddressTon

public int getOriginatingAddressTon()
                             throws ManagementException

Throws:

ManagementException

getReceiveSegmentsWaitTime

public int getReceiveSegmentsWaitTime()
                               throws ManagementException

Throws:

ManagementException

getReceiveSmsIgnoreMissingSegments

public boolean getReceiveSmsIgnoreMissingSegments()
                                           throws ManagementException

Throws:

ManagementException

getRequestDeliveryReports

public boolean getRequestDeliveryReports()
                                  throws ManagementException

Throws:

ManagementException

getSegmentsLimit

public int getSegmentsLimit()
                     throws ManagementException

Throws:

ManagementException

getSequenceNumberRangeEndId

public int getSequenceNumberRangeEndId()
                                throws ManagementException

Throws:

ManagementException

getSequenceNumberRangeStartId

public int getSequenceNumberRangeStartId()
                                  throws ManagementException

Throws:

ManagementException

getSMSCDefaultAlphabet

public String getSMSCDefaultAlphabet()
                              throws ManagementException

Throws:

ManagementException

getUseMessagePayload

public boolean getUseMessagePayload()
                             throws ManagementException

Throws:

ManagementException

getUserTextMaxLength

public int getUserTextMaxLength()
                         throws ManagementException

Throws:

ManagementException

listDestinationAddressTypeMappings

public String[] listDestinationAddressTypeMappings()
                                            throws ManagementException

Throws:

ManagementException

listOfflineNotificationInfo

public String[] listOfflineNotificationInfo()

Lists all offline notifications (added using the OAM enableReceiveSms method).

listOnlineBinaryNotificationInfo

public String[] listOnlineBinaryNotificationInfo()

Lists all online Binary notifications (added using startBinarySmsNotification).

listOnlineNotificationInfo

public String[] listOnlineNotificationInfo()

Lists all online notifications (added using startSmsNotification).

listOriginatingAddressTypeMappings

public String[] listOriginatingAddressTypeMappings()
                                            throws ManagementException

Throws:

ManagementException

modifyOnlineNotificationInfo

public void modifyOnlineNotificationInfo(String correlator,
                                         String endPoint,
                                         String shortCode,
                                         String criteria,
                                         String appInstGroupID)

Modify an existing Online sms notification using an existing correlator.

Parameters:

correlator -

removeDestinationAddressTypeMapping

public void removeDestinationAddressTypeMapping(String type)
                                         throws ManagementException

Throws:

ManagementException

removeOfflineNotificationInfo

public void removeOfflineNotificationInfo(String registrationIdentifier)

Remove an offline notification that was added using the OAM enableReceiveSms method

Parameters:

registrationIdentifier -

removeOnlineBinaryNotificationInfo

public void removeOnlineBinaryNotificationInfo(String correlator)

Remove the specified online binary sms notification that was added using OAM interfaces or application interfaces (startBinarySmsNotification).

removeOnlineNotificationInfo

public void removeOnlineNotificationInfo(String correlator)

Remove the specified online notification that was added using OAM interfaces or application interfaces (startSmsNotification).

removeOriginatingAddressTypeMapping

public void removeOriginatingAddressTypeMapping(String type)
                                         throws ManagementException

Throws:

ManagementException

setDataSm

public void setDataSm(boolean value)
               throws ManagementException

Throws:

ManagementException

setDefaultDataCoding

public void setDefaultDataCoding(int dataCoding)
                          throws ManagementException

Throws:

ManagementException

setDestinationAddressNpi

public void setDestinationAddressNpi(int npi)
                              throws ManagementException

Throws:

ManagementException

setDestinationAddressTon

public void setDestinationAddressTon(int ton)
                              throws ManagementException

Throws:

ManagementException

setEnquireLinkTimerValue

public void setEnquireLinkTimerValue(int timerValue)
                              throws ManagementException

Throws:

ManagementException

setForwardXParams

public void setForwardXParams(boolean _value)
                       throws ManagementException

Throws:

ManagementException

setMaxKeywordLimit

public void setMaxKeywordLimit(int maxKeywordLimit)
                        throws ManagementException

Parameters:

maxKeywordLimit - Default is 1.

Throws:

ManagementException

setMessagingMode

public void setMessagingMode(int mode)
                      throws ManagementException

Throws:

ManagementException

setMobileCountryCode

public void setMobileCountryCode(int mcc)
                          throws ManagementException

Throws:

ManagementException

setMobileNetworkCode

public void setMobileNetworkCode(int mnc)
                          throws ManagementException

Throws:

ManagementException

setOriginatingAddressNpi

public void setOriginatingAddressNpi(int npi)
                              throws ManagementException

Throws:

ManagementException

setOriginatingAddressTon

public void setOriginatingAddressTon(int ton)
                              throws ManagementException

Throws:

ManagementException

setReceiveSegmentsWaitTime

public void setReceiveSegmentsWaitTime(int timeout)
                                throws ManagementException

Throws:

ManagementException

setReceiveSmsIgnoreMissingSegments

public void setReceiveSmsIgnoreMissingSegments(boolean b)
                                        throws ManagementException

Throws:

ManagementException

setRequestDeliveryReports

public void setRequestDeliveryReports(boolean requestDeliveryReports)
                               throws ManagementException

Throws:

ManagementException

setSegmentsLimit

public void setSegmentsLimit(int limit)
                      throws ManagementException

Throws:

ManagementException

setSequenceNumberRangeEndId

public void setSequenceNumberRangeEndId(int endId)
                                 throws ManagementException

Throws:

ManagementException

setSequenceNumberRangeStartId

public void setSequenceNumberRangeStartId(int startId)
                                   throws ManagementException

Throws:

ManagementException

setSMSCDefaultAlphabet

public void setSMSCDefaultAlphabet(String characterEncodingScheme)
                            throws ManagementException

Throws:

ManagementException

setUseMessagePayload

public void setUseMessagePayload(boolean useMessagePayload)
                          throws ManagementException

Throws:

ManagementException

setUserTextMaxLength

public void setUserTextMaxLength(int userTextMaxLength)
                          throws ManagementException

Throws:

ManagementException

startBinarySmsNotification

public String startBinarySmsNotification(String endpoint,
                                         String shortCode,
                                         String appInstanceID)

Add an online binary sms notification for applications that for some reason can not (or are not allowed) call the startBinarySmsNotification method.

Parameters:

endpoint - The notification endpoint

shortCode - The destination address/service activation number of the short message

appInstanceID - The applicationInstanceID to associate with this notification.

startSmsNotification

public String startSmsNotification(String endpoint,
                                   String shortCode,
                                   String criteria,
                                   String appInstanceID)

Add an online notification for applications that for some reason can not (or are not allowed) call the startSmsNotification method.

Parameters:

endpoint - The notification endpoint

shortCode - The destination address/service activation number of the short message

criteria - The text to match against to determine the application to receive the notification.

appInstanceID - The applicationInstanceID to associate with this notification.

translateDestinationAddressNpi

public int translateDestinationAddressNpi(String type)
                                   throws ManagementException

Throws:

ManagementException

translateDestinationAddressTon

public int translateDestinationAddressTon(String type)
                                   throws ManagementException

Throws:

ManagementException

translateOriginatingAddressNpi

public int translateOriginatingAddressNpi(String type)
                                   throws ManagementException

Throws:

ManagementException

translateOriginatingAddressTon

public int translateOriginatingAddressTon(String type)
                                   throws ManagementException

Throws:

ManagementException

Skip navigation links