Skip navigation links

oracle.ocsg.plugin.subscription.management
Interface SubscriptionPluginMBean

public interface SubscriptionPluginMBean

This interface defines the network facing connection attributes of the Subscription plug-in. It extends the common SMPP plug-in attributes interface.

Field Summary

static boolean	activeStatus The current active status of the SMPP plug-in.
static int	expiryPeriod An expiry timer scans for expired subscription with this interval.
static int	MODE_RECEIVER MODE_RECEIVER.
static int	MODE_TRANCEIVER MODE_TRANCEIVER.
static int	MODE_TRANSMITTER MODE_TRANSMITTER.
static String	trustedApplicationInstances A list of application instances that are allowed to invoke following REST operations using basic authorization: createSubscription deleteSubscriptionById suspendSubscription unsuspendSubscription Any application not trusted will require an OAuth token to invoke these operations.

Method Summary

void	connect() Connects to the SMSC.
boolean	getActiveStatus() Checks the current active status of the SMPP plug-in.
int	getExpiryPeriod()
String	getTrustedApplicationInstances() Scope: Cluster
void	loadAppSubscriptionsXml(String xml) Loads the AppSubscriptions configuration from XML content.
String	retrieveAppSubscirptionsList() Retrieves the AppSubscriptions configuration detailed content.
String	retrieveAppSubscriptionsXml() Retrieves the AppSubscriptions configuration XML content.
void	setExpiryPeriod(int period)
void	setTrustedApplicationInstances(String trusted) Scope: Cluster

Field Detail

activeStatus

public static final boolean activeStatus

The current active status of the SMPP plug-in. Is true if the connection has been successfully bound.

Scope: Cluster

See Also:

Constant Field Values

expiryPeriod

public static final int expiryPeriod

An expiry timer scans for expired subscription with this interval. Value is entered in minutes. Note that the timer is started at managed server startup and changing the interval will take effect on next startup.

Scope: Cluster

See Also:

Constant Field Values

MODE_RECEIVER

public static final int MODE_RECEIVER

MODE_RECEIVER.

See Also:

Constant Field Values

MODE_TRANCEIVER

public static final int MODE_TRANCEIVER

MODE_TRANCEIVER.

See Also:

Constant Field Values

MODE_TRANSMITTER

public static final int MODE_TRANSMITTER

MODE_TRANSMITTER.

See Also:

Constant Field Values

trustedApplicationInstances

public static final String trustedApplicationInstances

A list of application instances that are allowed to invoke following REST operations using basic authorization:

• createSubscription
• deleteSubscriptionById
• suspendSubscription
• unsuspendSubscription

Any application not trusted will require an OAuth token to invoke these operations. The format is comma separated values (eg subinst1,subinst1). If left empty OAuth token is required for all applications. Note that an application instance cannot create a subscription for itself.

Scope: Cluster

See Also:

Constant Field Values

Method Detail

connect

public void connect()
             throws ManagementException

Connects to the SMSC.

Scope: Cluster

Throws:

ManagementException

getActiveStatus

public boolean getActiveStatus()

Checks the current active status of the SMPP plug-in. Will return true if the connection has been successfully bound.

Scope: Cluster

getExpiryPeriod

public int getExpiryPeriod()
                    throws ManagementException

Throws:

ManagementException

getTrustedApplicationInstances

public String getTrustedApplicationInstances()
                                      throws ManagementException

Scope: Cluster

Throws:

ManagementException - if there is issue accessing configuration store

See Also:

trustedApplicationInstances

loadAppSubscriptionsXml

public void loadAppSubscriptionsXml(String xml)
                             throws ManagementException

Loads the AppSubscriptions configuration from XML content.

Scope: Cluster

The following table provides information on each of the XML elements:

Element Name	Unique	Description	Required
serviceNumber	Y	The target telephone number if subscribed by SMS. The number can be a service provider number, or an application number.When using a service provider number, multiple application registrations share the same number, but must use different subscription short message text.	Y
appInstanceId	Y	The application's instance ID.	Y
applicationName	Y	The application's name.	Y
endpoint	N	The application's endpoint where Services Gatekeeper sends subscription notifications.	Y
reqLimit	N	The maximum request time limit.	N
expirePeriod	N	The number of seconds a subscription is valid.	Y
subscriptionChannel	N	The subscription channel. Supported values are ALL, WEB_RESTFUL or SMS.	N
metaInfo.key	N	The new added EDR attribute key.	N
metaInfo.value	N	The new added EDR attribute value.	N
subscribeInfo.text	N	A regular expression describing accepted SMS subscribe request format.	Y
subscribeInfo.notification	N	The notification SMS text after subscription confirmation.	Y
unsubscribeInfo.text	N	A regular expression describing accepted SMS unsubscribe request format.	Y
unsubscribeInfo.notification	N	The notification SMS text after unsubscription confirmation.	Y
suspendInfo.text	N	A regular expression describing accepted SMS suspendInfo request format.	Y
suspendInfo.notification	N	The notification SMS text after a subscription suspension.	Y
unsespendInfo.text	N	A regular expression describing accepted SMS unsuspendInfo request format.	Y
unsuspendInfo.notification	N	The notification SMS text after a subscription unsuspension.	Y
resourceId	N	The value mapped to the OAuth scopeId.	N

Parameters:

xml - XML content.

Throws:

ManagementException

retrieveAppSubscirptionsList

public String retrieveAppSubscirptionsList()
                                    throws ManagementException

Retrieves the AppSubscriptions configuration detailed content.

Scope: Cluster

Throws:

ManagementException

retrieveAppSubscriptionsXml

public String retrieveAppSubscriptionsXml()
                                   throws ManagementException

Retrieves the AppSubscriptions configuration XML content.

Scope: Cluster

Throws:

ManagementException

setExpiryPeriod

public void setExpiryPeriod(int period)
                     throws ManagementException

Throws:

ManagementException

setTrustedApplicationInstances

public void setTrustedApplicationInstances(String trusted)
                                    throws ManagementException

Scope: Cluster

Throws:

ManagementException - if there is issue accessing configuration store

See Also:

trustedApplicationInstances

Skip navigation links