Skip navigation links

com.convergin.module.imuixussd.smpp34.config
Interface SmppHandlingMBean

public interface SmppHandlingMBean

Inteface for SmppHandlingMBean

Author:

osnat SmppHandlingMBean enables you to configure the IM-UIX USSD SMPP interface. NOTE: this code is autogenerated by createConfigMbeans.pl. Do not change it.

Method Summary

java.lang.String	getDataCoding() The coding scheme used for SM if it is not found as charset parameter on SAL Content-Type header.
java.lang.String	getDefaultSmscAlias() Specifies the SMSC to which the IM sends SMPP requests.
java.lang.String	getDeploymentName() return the Module instance name that this MBean configures
java.lang.String	getPreferredIdentity() Defines the preferred value of SMPP submit_sm destination address.
java.lang.String	getPrivacyIndicator() Specifies the privacy level of the message.
java.lang.String	getReplaceIfPresent() Flag indicating if submitted message should replace an existing message.
java.lang.String	getSmeAcknowledgementRequest() Indicator to signify if an SME acknowledgement is required.
java.lang.String	getSmscDeliveryReceiptRequest() Indicator to signify if an SMSC delivery receipt is required.
int	getSmscReactionIntervalInSeconds() Specifies the time period in seconds during which the IM-UIX USSD waits for the SMSC to confirm USSD request with deliver_sm.
java.lang.String	getSubmitDestinationAddressNumberingPlanIdentification() Defines the numbering plan indicator for the subscriber address if not part of the Request-URI.
java.lang.String	getSubmitDestinationAddressTypeOfNumber() Defines the nature of address for the subscriber address (IMSI/MSISDN) if not part of the Request-URI.
java.lang.String	getSubmitIncludeUserMessageReference() Defines if user message reference will be included in the submitted message.
java.lang.String	getSubmitMessageMode() Defines the message mode of submitted message.
java.lang.String	getSubmitMessageType() Defines the message type of submitted message.
java.lang.String	getSubmitSmPriorityLevel() Defines the priority Level of submitted message.
java.lang.String	getSubmitValidityPeriodFormat() Defines the Validity-Period-Format.
java.lang.String	getSubmitValidityPeriodSource() Defines the source used by the IM to set the Validity-Period set in submit_sm.
int	getSubmitValidityPeriodValue() Defines the value of Validity-Period set in submit_sm in seconds.
java.lang.String	getUssdConfirmationPhase() Defines the phase for which USSD acknowledgement will be sent to the AS.
void	setDataCoding(java.lang.String param) The coding scheme used for SM if it is not found as charset parameter on SAL Content-Type header.
void	setDefaultSmscAlias(java.lang.String param) Specifies the SMSC to which the IM sends SMPP requests.
void	setPreferredIdentity(java.lang.String param) Defines the preferred value of SMPP submit_sm destination address.
void	setPrivacyIndicator(java.lang.String param) Specifies the privacy level of the message.
void	setReplaceIfPresent(java.lang.String param) Flag indicating if submitted message should replace an existing message.
void	setSmeAcknowledgementRequest(java.lang.String param) Indicator to signify if an SME acknowledgement is required.
void	setSmscDeliveryReceiptRequest(java.lang.String param) Indicator to signify if an SMSC delivery receipt is required.
void	setSmscReactionIntervalInSeconds(int param) Specifies the time period in seconds during which the IM-UIX USSD waits for the SMSC to confirm USSD request with deliver_sm.
void	setSubmitDestinationAddressNumberingPlanIdentification(java.lang.String param) Defines the numbering plan indicator for the subscriber address if not part of the Request-URI.
void	setSubmitDestinationAddressTypeOfNumber(java.lang.String param) Defines the nature of address for the subscriber address (IMSI/MSISDN) if not part of the Request-URI.
void	setSubmitIncludeUserMessageReference(java.lang.String param) Defines if user message reference will be included in the submitted message.
void	setSubmitMessageMode(java.lang.String param) Defines the message mode of submitted message.
void	setSubmitMessageType(java.lang.String param) Defines the message type of submitted message.
void	setSubmitSmPriorityLevel(java.lang.String param) Defines the priority Level of submitted message.
void	setSubmitValidityPeriodFormat(java.lang.String param) Defines the Validity-Period-Format.
void	setSubmitValidityPeriodSource(java.lang.String param) Defines the source used by the IM to set the Validity-Period set in submit_sm.
void	setSubmitValidityPeriodValue(int param) Defines the value of Validity-Period set in submit_sm in seconds.
void	setUssdConfirmationPhase(java.lang.String param) Defines the phase for which USSD acknowledgement will be sent to the AS.

Method Detail

getDefaultSmscAlias

java.lang.String getDefaultSmscAlias()
                                     throws java.io.IOException

Specifies the SMSC to which the IM sends SMPP requests. This is an alias to one of the SMSC ids configured in the SMPP SSU. This parameter is used only when the alias is not specifically provided in the To header of the INVITE request.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setDefaultSmscAlias

void setDefaultSmscAlias(java.lang.String param)
                         throws java.io.IOException

Specifies the SMSC to which the IM sends SMPP requests. This is an alias to one of the SMSC ids configured in the SMPP SSU. This parameter is used only when the alias is not specifically provided in the To header of the INVITE request.

Parameters:

param -

Throws:

java.io.IOException

getSubmitDestinationAddressTypeOfNumber

java.lang.String getSubmitDestinationAddressTypeOfNumber()
                                                         throws java.io.IOException

Defines the nature of address for the subscriber address (IMSI/MSISDN) if not part of the Request-URI.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSubmitDestinationAddressTypeOfNumber

void setSubmitDestinationAddressTypeOfNumber(java.lang.String param)
                                             throws java.io.IOException

Defines the nature of address for the subscriber address (IMSI/MSISDN) if not part of the Request-URI.

Parameters:

param -

Throws:

java.io.IOException

getSubmitDestinationAddressNumberingPlanIdentification

java.lang.String getSubmitDestinationAddressNumberingPlanIdentification()
                                                                        throws java.io.IOException

Defines the numbering plan indicator for the subscriber address if not part of the Request-URI.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSubmitDestinationAddressNumberingPlanIdentification

void setSubmitDestinationAddressNumberingPlanIdentification(java.lang.String param)
                                                            throws java.io.IOException

Defines the numbering plan indicator for the subscriber address if not part of the Request-URI.

Parameters:

param -

Throws:

java.io.IOException

getSubmitMessageMode

java.lang.String getSubmitMessageMode()
                                      throws java.io.IOException

Defines the message mode of submitted message.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSubmitMessageMode

void setSubmitMessageMode(java.lang.String param)
                          throws java.io.IOException

Defines the message mode of submitted message.

Parameters:

param -

Throws:

java.io.IOException

getSubmitMessageType

java.lang.String getSubmitMessageType()
                                      throws java.io.IOException

Defines the message type of submitted message.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSubmitMessageType

void setSubmitMessageType(java.lang.String param)
                          throws java.io.IOException

Defines the message type of submitted message.

Parameters:

param -

Throws:

java.io.IOException

getSubmitSmPriorityLevel

java.lang.String getSubmitSmPriorityLevel()
                                          throws java.io.IOException

Defines the priority Level of submitted message. Level 0 is the lowest priority.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSubmitSmPriorityLevel

void setSubmitSmPriorityLevel(java.lang.String param)
                              throws java.io.IOException

Defines the priority Level of submitted message. Level 0 is the lowest priority.

Parameters:

param -

Throws:

java.io.IOException

getSmscDeliveryReceiptRequest

java.lang.String getSmscDeliveryReceiptRequest()
                                               throws java.io.IOException

Indicator to signify if an SMSC delivery receipt is required.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSmscDeliveryReceiptRequest

void setSmscDeliveryReceiptRequest(java.lang.String param)
                                   throws java.io.IOException

Indicator to signify if an SMSC delivery receipt is required.

Parameters:

param -

Throws:

java.io.IOException

getSmeAcknowledgementRequest

java.lang.String getSmeAcknowledgementRequest()
                                              throws java.io.IOException

Indicator to signify if an SME acknowledgement is required.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSmeAcknowledgementRequest

void setSmeAcknowledgementRequest(java.lang.String param)
                                  throws java.io.IOException

Indicator to signify if an SME acknowledgement is required.

Parameters:

param -

Throws:

java.io.IOException

getSubmitValidityPeriodFormat

java.lang.String getSubmitValidityPeriodFormat()
                                               throws java.io.IOException

Defines the Validity-Period-Format.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSubmitValidityPeriodFormat

void setSubmitValidityPeriodFormat(java.lang.String param)
                                   throws java.io.IOException

Defines the Validity-Period-Format.

Parameters:

param -

Throws:

java.io.IOException

getSubmitValidityPeriodSource

java.lang.String getSubmitValidityPeriodSource()
                                               throws java.io.IOException

Defines the source used by the IM to set the Validity-Period set in submit_sm.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSubmitValidityPeriodSource

void setSubmitValidityPeriodSource(java.lang.String param)
                                   throws java.io.IOException

Defines the source used by the IM to set the Validity-Period set in submit_sm.

Parameters:

param -

Throws:

java.io.IOException

getSubmitValidityPeriodValue

int getSubmitValidityPeriodValue()
                                 throws java.io.IOException

Defines the value of Validity-Period set in submit_sm in seconds.

Parameters:

-

Returns:

int

Throws:

java.io.IOException

setSubmitValidityPeriodValue

void setSubmitValidityPeriodValue(int param)
                                  throws java.io.IOException

Defines the value of Validity-Period set in submit_sm in seconds.

Parameters:

param -

Throws:

java.io.IOException

getReplaceIfPresent

java.lang.String getReplaceIfPresent()
                                     throws java.io.IOException

Flag indicating if submitted message should replace an existing message.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setReplaceIfPresent

void setReplaceIfPresent(java.lang.String param)
                         throws java.io.IOException

Flag indicating if submitted message should replace an existing message.

Parameters:

param -

Throws:

java.io.IOException

getDataCoding

java.lang.String getDataCoding()
                               throws java.io.IOException

The coding scheme used for SM if it is not found as charset parameter on SAL Content-Type header.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setDataCoding

void setDataCoding(java.lang.String param)
                   throws java.io.IOException

The coding scheme used for SM if it is not found as charset parameter on SAL Content-Type header.

Parameters:

param -

Throws:

java.io.IOException

getPrivacyIndicator

java.lang.String getPrivacyIndicator()
                                     throws java.io.IOException

Specifies the privacy level of the message.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setPrivacyIndicator

void setPrivacyIndicator(java.lang.String param)
                         throws java.io.IOException

Specifies the privacy level of the message.

Parameters:

param -

Throws:

java.io.IOException

getSubmitIncludeUserMessageReference

java.lang.String getSubmitIncludeUserMessageReference()
                                                      throws java.io.IOException

Defines if user message reference will be included in the submitted message. If it is included, the range will be taken from UserMessageReference allocator.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setSubmitIncludeUserMessageReference

void setSubmitIncludeUserMessageReference(java.lang.String param)
                                          throws java.io.IOException

Defines if user message reference will be included in the submitted message. If it is included, the range will be taken from UserMessageReference allocator.

Parameters:

param -

Throws:

java.io.IOException

getPreferredIdentity

java.lang.String getPreferredIdentity()
                                      throws java.io.IOException

Defines the preferred value of SMPP submit_sm destination address.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setPreferredIdentity

void setPreferredIdentity(java.lang.String param)
                          throws java.io.IOException

Defines the preferred value of SMPP submit_sm destination address.

Parameters:

param -

Throws:

java.io.IOException

getUssdConfirmationPhase

java.lang.String getUssdConfirmationPhase()
                                          throws java.io.IOException

Defines the phase for which USSD acknowledgement will be sent to the AS.

Parameters:

-

Returns:

String

Throws:

java.io.IOException

setUssdConfirmationPhase

void setUssdConfirmationPhase(java.lang.String param)
                              throws java.io.IOException

Defines the phase for which USSD acknowledgement will be sent to the AS.

Parameters:

param -

Throws:

java.io.IOException

getSmscReactionIntervalInSeconds

int getSmscReactionIntervalInSeconds()
                                     throws java.io.IOException

Specifies the time period in seconds during which the IM-UIX USSD waits for the SMSC to confirm USSD request with deliver_sm.

Parameters:

-

Returns:

int

Throws:

java.io.IOException

setSmscReactionIntervalInSeconds

void setSmscReactionIntervalInSeconds(int param)
                                      throws java.io.IOException

Specifies the time period in seconds during which the IM-UIX USSD waits for the SMSC to confirm USSD request with deliver_sm.

Parameters:

param -

Throws:

java.io.IOException

getDeploymentName

java.lang.String getDeploymentName()

return the Module instance name that this MBean configures

Returns:

String

Skip navigation links