4 Application Subscription Management

Deploying Application Subscription Management Packages

To deploy the necessary packages:

1. Log into the Administration Console.

2. Click Deployments under Domain Structure.

3. If needed, enter the path to the applications directory in Path.

   The default location for the applications directory is Oracle_home/ocsg_release_level/applications.

4. Click Install.

5. Select wlng_at_app_subscription_rest.ear.

6. Click Next.

7. Select Install this deployment as an application.

8. Click Next.

9. Select any optional settings that are needed in your environment. For more information on deployment settings, see the overview of deployment types in Services Gatekeeper System Administrator's Guide.

10. Click Next.

11. Review your deployment choices and click Finish.

12. Repeat steps 1 through 11 for the wlng_nt_app_subscription.ear application file.

Creating an Application Subscription Management plug-in Instance

You must create one or more instances of the Application Subscription Management plug-in to manage subscription requests. Create an instance of the Application Subscription Management plug-in as follows:

1. Log into the Administration Console.

2. Expand OCSG in the Domain Structure pane.

3. click the name of the administration or managed server you want to create the Application Subscription Management plug-in instance on.

4. Expand the Container Services node in the Oracle Communications Services Gatekeeper pane.

5. Select PluginManager.

6. Click the Operations tab.

7. In the Select An wlngOption pull down menu, select createPluginInstance.

8. Enter Plugin_app_subscription in the PluginServiceId field.

9. Enter a unique name in the PluginInstanceId field.

10. Click Invoke.

11. Add a route to the ASM plug-in using the pluginManager Mbean.

The Platform Test Environment MBean interface can also be used to create and manage Application Subscription Management plugins. For information on using the Platform Test Environment, see Services Gatekeeper Platform Test Environment User's Guide.

Editing Application Subscription Management Attributes

Each instance of the Application Subscription Management plug-in can be configured with its own attributes.

For example, you can configure an instance of the plug-in for each type of SMSC used in your environment. To do so, set field values and use the methods from the Administration Console SubscriptionPluginMBean or a Java application. For information on the methods and fields of the MBean, see the "All Classes" section of Services Gatekeeper OAM Java API Reference.

To configure the Application Subscription Management plug-in attributes:

1. Log into the Administration Console.

2. Expand the OCSG node in Domain Structure.

3. Select the administration or managed server where you created the Application Subscription Management plug-in.

4. Expand Communication Services in Oracle Communications Services Gatekeeper.

5. Select the Application Subscription Management plug-in instance to configure.

6. Click Attributes.

7. Select the checkboxes of the attributes you wish to change.

8. Enter the new values for the attribute(s).

9. Click Update Attributes.

Loading Application Subscription Configuration Files

Create and manage subscription configurations for application services using the loadAppSubscriptionsXml method of SubscriptionPluginMBean. For more information on the fields and methods of this MBean, see the "All Classes" section of Services Gatekeeper OAM Java API Reference.

Table 4-3 lists the configuration file elements available for use with loadAppSubscriptionsXml the operation configuration file.

Example 4-1 shows a sample subscription management XML configuration file used to load application subscription data into Services Gatekeeper.

<?xml version="1.0" encoding="UTF-8"?>
<subscriptions xmlns="http://oracle/ocsg/appSubscription/types" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  
  <!-- SP code -->
  <subscription serviceNumber="tel:1234">
        <application  appInstanceId="domain_user" applicationName="Oracle News" 
                      endpoint="http://www.oracle.com" expirePeriod="36000000" subscriptionChannel="ALL">
           <metaInfo key="key1" value="value1"/>
           <metaInfo key="key2" value="value2"/>
           <subscribeInfo text="Subscribe 123" notification="You have subscribed Oracle News successfully"/>
           <unsubscribeInfo text="Un-Subscribe 123" notification="You have unsubscribed Oracle News successfully"/>
           <suspendInfo text="Suspend 123" notification="You have suspended Oracle News successfully"/>
           <unsuspendInfo text="Un-Suspend 123" notification="You have unsuspended Oracle News successfully"/>
           <resourceId>createoutboundMessage</resourceId>
        </application>
        
        <application  appInstanceId="domain_user_1" applicationName="Oracle Jokes" 
                      endpoint="http://www.oracle.com" expirePeriod="36000000" subscriptionChannel="WEB_RESTFUL">
           <subscribeInfo text="Subscribe 456" notification="You have subscribed Oracle Jokes successfully"/>
           <unsubscribeInfo text="Un-Subscribe 456" notification="You have unsubscribed Oracle Jokes successfully"/>
           <suspendInfo text="Suspend 456" notification="You have suspended Oracle Jokes successfully"/>
           <unsuspendInfo text="Un-Suspend 456" notification="You have unsuspended Oracle Jokes successfully"/>
           <resourceId>createoutboundMessage</resourceId>
        </application>
  </subscription>
  
  <!--App code-->
  <subscription serviceNumber="tel:5678">
    <application  appInstanceId="domain_user_2" applicationName="Google Weather" 
                      endpoint="http://www.google.com" expirePeriod="36000000" subscriptionChannel="SMS">
           <subscribeInfo text="Subscribe" notification="You have subscribed Google Weather successfully"/>
           <unsubscribeInfo text="Un-Subscribe" notification="You have unsubscribed Google Weather successfully"/>
           <suspendInfo text="Suspend" notification="You have suspended Oracle Jokes successfully"/>
           <unsuspendInfo text="Un-Suspend" notification="You have unsuspended Oracle Jokes successfully"/>
           <resourceId>createoutboundMessage</resourceId>
        </application>
  </subscription>
  
</subscriptions>

Load the new or update an existing application subscription configuration using the following procedure:

1. Log into the Administration Console.

2. Expand OCSG under Domain Structure.

3. Click the name of the administration or managed server you want to create the application subscription configuration on.

4. Expand Communication Services.

5. Select the Application Subscription Management plug-in instance to configure.

6. Click Operations.

7. In the Select An Operation pull down menu select loadAppSubscriptionsXml.

8. Copy and paste your XML configuration file contents in the xml field.

9. Click Invoke.

For more information on the fields and methods of the SubscriptionPluginMBean MBean, see the ”All Classes” section of Services Gatekeeper OAM Java API Reference.

Loading Trusted Applications

Enter a comma-separated list of trusted applications to the TrustedApplicationInstances attribute. The list takes effect when you restart the domain servers. An application can not create a subscription for itself.

Trusted applications are applications that you allow to perform these operations using only basic authorization:

• createSubscription

• deleteSubscriptionById

• suspendSubscription

• unsuspendSubscription

Applications not on the trusted list must provide OAuth tokens to invoke these operations.

1. Log into the Administration Console.

2. In the Change Center, click Lock & Edit.

3. Expand OCSG under Domain Structure.

4. Click the name of the administration or managed server from where you want to retrieve the subscription configuration.

5. Expand Communication Services.

6. Select an Application Subscription Management plug-in instance.

7. Click Attributes

8. Check the box next to the TrustedApplicationsInstances field.

9. Enter a comma-separated list of trusted applications.

10. Click Update Attributes.

11. In the Change Center, click Release Configuration.

Cleaning Up Pending Requests and Expired Subscriptions

You use the ExpiryPeriod attribute to SubscriptionPluginMBean to specify how often Services Gatekeeper searches for and cleans up pending requests for subscriptions. The expiration time is also checked each time an operation tries to retrieve it. This also prevents an expired subscription from being used.

You set a value for ExpiryPeriod in minutes, which specifies how often Services Gatekeeper searches for:

• Application request for subscriptions a pending state (waiting to be created or deleted). If the time limit in the appendingexpiry column has been exceeded, the request is removed.

• Whether the expiry timer has expired. This timer applies to the subscription regardless of state.

If either the appendinexpiry or expiry time limits are exceeded, Services Gatekeeper removes the request.

1. Log into the Administration Console.

2. In the Change Center, click Lock & Edit.

3. Expand OCSG under Domain Structure.

4. Click the name of the administration or managed server from where you want to retrieve the subscription configuration.

5. Expand Communication Services.

6. Select an Application Subscription Management plug-in instance.

7. Click Attributes.

8. Check the box next to the ExpiryPeriod field.

9. Enter a timer value in minutes.

10. Click Update Attributes.

11. In the Change Center, click Release Configuration.

Retrieving Application Subscription Configuration Files

Retrieve the current application subscription configuration in a plug-in instance using the following procedure:

1. Log into the Administration Console.

2. Expand OCSG under Domain Structure.

3. Click the name of the administration or managed server from where you want to retrieve the subscription configuration.

4. Expand Communication Services.

5. Select the Application Subscription Management plug-in instance you want to retrieve the subscription configuration from.

6. Click Operations.

7. In the Select An Operation pull down menu select retrieveAppSubscriptionsXml.

8. Click Invoke.

Retrieving Application Subscription Lists

Retrieve a list of application subscriptions in Services Gatekeeper using the following procedure:

1. Log into the Administration Console.

2. Expand OCSG under Domain Structure.

3. Click the name of the administration or managed server from where you want to retrieve the subscription list.

4. Expand Communication Services.

5. Select the Application Subscription Management plug-in instance you want to retrieve the subscription list from.

6. Click Operations.

7. In the Select An Option pull down menu, select retrieveAppSubscriptionsList.

8. Click Invoke.

Configure Application OAuth Scope

You must configure application scope when using OAuth authentication with Application Subscription Management.

Configure the application's resourceId as an OAuth scopeId in Services Gatekeeper using the loadAppSubscriptionResourceXml method in the OAuthResourceMbean. For more information on the fields and methods of this MBean, see the "All Classes" section of Services Gatekeeper OAM Java API Reference.

To configure application OAuth scope:

1. Log into the Administration Console.

2. Expand OCSG under Domain Structure.

3. Click the name of the administration or managed server where the OAuth container service is hosted.

4. Expand Container Services.

5. Expand OAuthService.

6. Select OAuthResourceMBean.

7. Click Operations.

8. In the Select an Option pull down menu, select loadAppSubscriptionResourceXml.

9. Enter the XML string as shown in Example 4-2. Set the resource id to the same value used when loading the application subscription configuration. See "Loading Application Subscription Configuration Files" for more information. Set the interfaceName, methodName and tokenExpirePeriod as required.

<?xml version="1.0" encoding="UTF-8"?>
<resources xmlns="http://oracle/ocsg/oauth2/management/xml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <!-- amountTransaction  -->
  <resource id="OneAPIMMS" name="mms" 
        interfaceName="oracle.ocsg.parlayrest.plugin.MmsPlugin" methodName="sendMessage"
        tokenExpirePeriod="3600">
  </resource>
</resources>

Connecting to an SMSC

Application Subscription Management plug-in instances must connect to an SMSC to accept and confirm subscription requests by SMS. Connect each plug-in instance to its SMSC using the following procedure:

1. Log into the Administration Console.

2. Expand OCSG under Domain Structure.

3. Click the name of the administration or managed server where the Application Subscription Management plug-in to connect to an SMSC is hosted.

4. Expand Communication Services.

5. Select the Application Subscription Management plug-in instance you want to connect to an SMSC. The plug-in Attributes tab contains the SMSC connection information. See "Editing Application Subscription Management Attributes" for more information on configuring SMSC connection attributes.

6. Click Operations.

7. In the Select An Operation pull down menu select connect.

8. Click Invoke.

9. Click Attributes and check the ActiveStatus value. A true value indicates successful connection to the configured SMSC.