|
Oracle Communications Services Gatekeeper OAM Java API Reference 6.0 E55516-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines the attributes and operations of the SMPP plug-in 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 boolean |
deactivateOnCommandStatus Set to true to allow a plug-in unbinding its connections to an SMSC when it receives a specific command status in submitSMResp, submitMultiSmResp or dataSmResp from the SMSC. |
static int |
defaultDataCoding Sets 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 boolean |
forwardXParams Specifies if tunneled parameters are forwarded to applications for network-triggered requests. |
static int |
maxBatchSize The system allowed max batch size in the OneAPI operation of getting received messages. |
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 Sets the Mobile Country Code for sending an operator logo. |
static int |
mobileNetworkCode Sets the Mobile Network Code for sending an 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. |
static int |
requestDeliveryReports This attribute determines if the SMPP plugin shall request delivery receipt from SMSC or not. |
static boolean |
resetSMPPConnectionsOnRequestTimeout Indicates if the plug-in shall reset its connections to the SMSC in case of a submitSM, submitMultiSM or dataSM request timeout. |
static int |
segmentsLimit Maximum number of SMPP segments an application is allowed to send when using the Extended Web Services Binary SMS interface. |
static int |
sequenceNumberRangeEndId End ID of the sequence number range. |
static int |
sequenceNumberRangeStartId Start ID of the sequence number range. |
static int |
SMSCDefaultAlphabet The SMSC Default Alphabet. |
static String |
smscGroupId ID used to group plug-in instances to the same logical SMSC. |
static boolean |
smscGroupIdEnabled The SmscGroupId and SmscGroupIdEnabled attributes are used when multiple ParlayX 2.1 SMPP plug-in instances connect to different network interfaces that are part of a single logical SMSC. |
static boolean |
useMessagePayload If true, the message is carried in the optional message_payload field in the SMPP PDU. |
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. |
void |
configureDeactivateOnCommandStatus(String smscCommandStatus, int waitTimeBeforeReconnect) Set to true to allow a plug-in unbinding its connections to an SMSC when it receives a specific command status in submitSMResp, submitMultiSmResp or dataSmResp from the SMSC. |
boolean |
getActiveStatus() Checks the current active status of the SMPP plugin. |
boolean |
getDataSm() |
boolean |
getDeactivateOnCommandStatus() |
int |
getDefaultDataCoding() |
int |
getDestinationAddressNpi() |
int |
getDestinationAddressTon() |
boolean |
getForwardXParams() |
int |
getMaxBatchSize() |
int |
getMaxKeywordLimit() |
int |
getMessagingMode() |
int |
getMobileCountryCode() |
int |
getMobileNetworkCode() |
String |
getModuleId() Returns the module id. |
int |
getOriginatingAddressNpi() |
int |
getOriginatingAddressTon() |
int |
getReceiveSegmentsWaitTime() |
boolean |
getReceiveSmsIgnoreMissingSegments() |
int |
getRequestDeliveryReports() |
boolean |
getResetSMPPConnectionsOnRequestTimeout() |
int |
getSegmentsLimit() |
int |
getSequenceNumberRangeEndId() |
int |
getSequenceNumberRangeStartId() |
String |
getSMSCDefaultAlphabet() |
String |
getSmscGroupId() |
boolean |
getSmscGroupIdEnabled() |
boolean |
getUseMessagePayload() |
int |
getUserTextMaxLength() |
String |
listDeactivateOnCommandStatusConfiguration() Lists the configuration for this specific plug-in instance, related to the feature of plug-in unbinding its connections to SMSC when it receives a specific command status in submitSMResp, submitMultiSmResp or dataSmResp from an SMSC. |
String[] |
listDestinationAddressTypeMappings() Returns a list of all destination address type mappings. |
String[] |
listOriginatingAddressTypeMappings() Returns a list of all originating address type mappings.. |
void |
removeDestinationAddressTypeMapping(String type) Removes an existing TON or NPI address type mapping for a specified destination address type. |
void |
removeOriginatingAddressTypeMapping(String type) Removes an existing TON or NPI address type mapping for a specified originating address type. |
void |
setDataSm(boolean value) |
void |
setDeactivateOnCommandStatus(boolean deactivateOnCommandStatus) |
void |
setDefaultDataCoding(int dataCoding) |
void |
setDestinationAddressNpi(int npi) |
void |
setDestinationAddressTon(int ton) |
void |
setForwardXParams(boolean _value) |
void |
setMaxBatchSize(int maxBatchSize) |
void |
setMaxKeywordLimit(int maxKeywordLimit) Sets the maximum number of keywords that can be used to match in a short message to determine whether the application receives a notification. |
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(int requestDeliveryReports) |
void |
setResetSMPPConnectionsOnRequestTimeout(boolean resetSMPPConnectionsOnRequestTimeout) |
void |
setSegmentsLimit(int limit) |
void |
setSequenceNumberRangeEndId(int endId) |
void |
setSequenceNumberRangeStartId(int startId) |
void |
setSMSCDefaultAlphabet(String characterEncodingScheme) |
void |
setSmscGroupId(String smscId) |
void |
setSmscGroupIdEnabled(boolean value) |
void |
setUseMessagePayload(boolean useMessagePayload) |
void |
setUserTextMaxLength(int userTextMaxLength) |
int |
translateDestinationAddressNpi(String type) Gets the ESME Numbering Plan Indicator (NPI) of the destination address mapping added for the specified type. |
int |
translateDestinationAddressTon(String type) Gets the ESME Type of Number (TON) of the destination address mapping added for the specified type. |
int |
translateOriginatingAddressNpi(String type) Gets the ESME Numbering Plan Indicator (NPI) of the originating address mapping added for the specified type. |
int |
translateOriginatingAddressTon(String type) Gets the ESME Type of Number (TON) of the originating address mapping added for the specified type. |
Field Detail |
public static final boolean activeStatus
Scope: Server
public static final boolean dataSm
Scope: Server
public static final boolean deactivateOnCommandStatus
Scope: Server
public static final int defaultDataCoding
Scope: Server
public static final int destinationAddressNpi
Scope: Server
public static final int destinationAddressTon
Scope: Server
public static final boolean forwardXParams
Scope: Server
public static final int maxBatchSize
Scope: Server
public static final int maxKeywordLimit
Scope: Server
public static final int messagingMode
Scope: Server
public static final int mobileCountryCode
Scope: Server
public static final int mobileNetworkCode
Scope: Server
public static final int originatingAddressNpi
Scope: Server
public static final int originatingAddressTon
Scope: Server
public static final int receiveSegmentsWaitTime
Scope: Server
public static final boolean receiveSmsIgnoreMissingSegments
Scope: Server
public static final int requestDeliveryReports
Scope: Server
public static final boolean resetSMPPConnectionsOnRequestTimeout
Scope: Server
public static final int segmentsLimit
Scope: Server
public static final int sequenceNumberRangeEndId
Scope: Server
public static final int sequenceNumberRangeStartId
Scope: Server
public static final int SMSCDefaultAlphabet
Scope: Server
public static final String smscGroupId
Scope: Server
public static final boolean smscGroupIdEnabled
Scope: Server
public static final boolean useMessagePayload
Scope: Server
public static final int userTextMaxLength
Scope: Server
Method Detail |
public void addDestinationAddressTypeMapping(String type, int ton, int npi) throws ManagementException
Scope: Server
ManagementException
public void addOriginatingAddressTypeMapping(String type, int ton, int npi) throws ManagementException
Scope: Server
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.ManagementException
public void configureDeactivateOnCommandStatus(String smscCommandStatus, int waitTimeBeforeReconnect) throws ManagementException
Scope: Server
smscCommandStatus
- The command status that will trigger the plugin to unbind its connections. You can specify one single value or a comma separated list of values. The values are specified as the decimal value of the CommandStatus. For example, specifying smscCommandStatus: 8,20 indicates that the plug-in will act when command status in response from SMSC is decimal 8 (0x00000008 - ESME_RSYSERR) or decimal 20 (0x00000014 - ESME_RMSGQFUL).waitTimeBeforeReconnect
- Specifies a timeperiod, in seconds, before the plug-in will make an attempt to reconnect to the SMSC. Set the timeperiod to 0 to disable the reconnect feature. If the reconnect feature is disabled, invoking MBean operation resetSMPPConnection is a must to have the plug-in reconnect to SMSC again. This configuration is plug-in instance specific.ManagementException
public boolean getActiveStatus()
Scope: Server
public boolean getDataSm() throws ManagementException
ManagementException
public boolean getDeactivateOnCommandStatus() throws ManagementException
ManagementException
public int getDefaultDataCoding() throws ManagementException
ManagementException
public int getDestinationAddressNpi() throws ManagementException
ManagementException
public int getDestinationAddressTon() throws ManagementException
ManagementException
public boolean getForwardXParams() throws ManagementException
ManagementException
public int getMaxBatchSize() throws ManagementException
ManagementException
public int getMaxKeywordLimit() throws ManagementException
ManagementException
public int getMessagingMode() throws ManagementException
ManagementException
public int getMobileCountryCode() throws ManagementException
ManagementException
public int getMobileNetworkCode() throws ManagementException
ManagementException
public String getModuleId() throws ManagementException
Scope: Server
ManagementException
public int getOriginatingAddressNpi() throws ManagementException
ManagementException
public int getOriginatingAddressTon() throws ManagementException
ManagementException
public int getReceiveSegmentsWaitTime() throws ManagementException
ManagementException
public boolean getReceiveSmsIgnoreMissingSegments() throws ManagementException
ManagementException
public int getRequestDeliveryReports() throws ManagementException
ManagementException
public boolean getResetSMPPConnectionsOnRequestTimeout() throws ManagementException
ManagementException
public int getSegmentsLimit() throws ManagementException
ManagementException
public int getSequenceNumberRangeEndId() throws ManagementException
ManagementException
public int getSequenceNumberRangeStartId() throws ManagementException
ManagementException
public String getSMSCDefaultAlphabet() throws ManagementException
ManagementException
public String getSmscGroupId() throws ManagementException
ManagementException
public boolean getSmscGroupIdEnabled() throws ManagementException
ManagementException
public boolean getUseMessagePayload() throws ManagementException
ManagementException
public int getUserTextMaxLength() throws ManagementException
ManagementException
public String listDeactivateOnCommandStatusConfiguration() throws ManagementException
Scope: Server
ManagementException
public String[] listDestinationAddressTypeMappings() throws ManagementException
Scope: Cluster
ManagementException
public String[] listOriginatingAddressTypeMappings() throws ManagementException
Scope: Cluster
ManagementException
public void removeDestinationAddressTypeMapping(String type) throws ManagementException
Scope: Cluster
ManagementException
public void removeOriginatingAddressTypeMapping(String type) throws ManagementException
Scope: Cluster
type
- originating address type for the mappingManagementException
public void setDataSm(boolean value) throws ManagementException
ManagementException
public void setDeactivateOnCommandStatus(boolean deactivateOnCommandStatus) throws ManagementException
ManagementException
public void setDefaultDataCoding(int dataCoding) throws ManagementException
ManagementException
public void setDestinationAddressNpi(int npi) throws ManagementException
ManagementException
public void setDestinationAddressTon(int ton) throws ManagementException
ManagementException
public void setForwardXParams(boolean _value) throws ManagementException
ManagementException
public void setMaxBatchSize(int maxBatchSize) throws ManagementException
ManagementException
public void setMaxKeywordLimit(int maxKeywordLimit) throws ManagementException
Scope: Server
maxKeywordLimit
- Default is 1.ManagementException
public void setMessagingMode(int mode) throws ManagementException
ManagementException
public void setMobileCountryCode(int mcc) throws ManagementException
ManagementException
public void setMobileNetworkCode(int mnc) throws ManagementException
ManagementException
public void setOriginatingAddressNpi(int npi) throws ManagementException
ManagementException
public void setOriginatingAddressTon(int ton) throws ManagementException
ManagementException
public void setReceiveSegmentsWaitTime(int timeout) throws ManagementException
ManagementException
public void setReceiveSmsIgnoreMissingSegments(boolean b) throws ManagementException
ManagementException
public void setRequestDeliveryReports(int requestDeliveryReports) throws ManagementException
ManagementException
public void setResetSMPPConnectionsOnRequestTimeout(boolean resetSMPPConnectionsOnRequestTimeout) throws ManagementException
ManagementException
public void setSegmentsLimit(int limit) throws ManagementException
ManagementException
public void setSequenceNumberRangeEndId(int endId) throws ManagementException
ManagementException
public void setSequenceNumberRangeStartId(int startId) throws ManagementException
ManagementException
public void setSMSCDefaultAlphabet(String characterEncodingScheme) throws ManagementException
ManagementException
public void setSmscGroupId(String smscId) throws ManagementException
ManagementException
public void setSmscGroupIdEnabled(boolean value) throws ManagementException
ManagementException
public void setUseMessagePayload(boolean useMessagePayload) throws ManagementException
ManagementException
public void setUserTextMaxLength(int userTextMaxLength) throws ManagementException
ManagementException
public int translateDestinationAddressNpi(String type) throws ManagementException
Scope: Cluster
ManagementException
public int translateDestinationAddressTon(String type) throws ManagementException
Scope: Cluster
ManagementException
public int translateOriginatingAddressNpi(String type) throws ManagementException
Scope: Cluster
ManagementException
public int translateOriginatingAddressTon(String type) throws ManagementException
Scope: Cluster
ManagementException
|
Oracle Communications Services Gatekeeper OAM Java API Reference 6.0 E55516-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |