This chapter describes how application instances are managed and provisioned in Oracle Communications Services Gatekeeper:
See ApplicationInstanceMBean in the ”All Classes” section of the Services Gatekeeper OAM Java API Reference or information for details on this MBean.
Before registering application instances, service provider and application accounts must have been created. See "Managing Service Provider and Application Accounts" for more information.
Table 2-1 lists the tasks related to application instances and the operations you use to perform those tasks. The operations belong to ApplicationInstanceMBean. For detailed information on this MBean, see the "All Classes" section of Services Gatekeeper OAM Java API Reference..
Table 2-1 Tasks Related to ApplicationInstanceMBean
Task | ApplicationInstanceMBean Operation |
---|---|
Get information about the number of application instances |
countApplicationInstances |
Add, remove and get information about an application instance |
addApplicationInstance removeApplicationInstance getApplicationInstance |
List registered application instances |
listApplicationInstances |
Define additional properties for an application instance |
setApplicationInstancePassword setApplicationInstanceProperties setApplicationInstanceReference setApplicationInstanceState |
Application instances have states. Two states are possible:
ACTIVATED
DEACTIVATED
In ACTIVATED state, the application using this application instance ID is in normal operation.
In DEACTIVATED state, the application using this application instance ID is not allowed to send traffic through Services Gatekeeper. The account is still valid and the state can be transitional by the Services Gatekeeper Administrator using the setApplicationInstanceState operation of the ApplicationInstanceMBean.
When Web Services Security is being used as authentication for the application instance, its credentials must be set up, as described in Table 2-2.
ApplicationInstance | UserNameToken | X.509 | SAML |
---|---|---|---|
ApplicationInstanceName |
userName |
CN |
CN |
Password |
password |
Not applicable |
Not applicable |
In addition, if X.509 or SAML are being used, the certificates and private keys must be provisioned in the WebLogic Server keystore. For example, ImportPrivateKey utility can be used to load the key and digital certificate files into the keystore. See "ImportPrivateKey" in Oracle Fusion Middleware Command Reference for Oracle WebLogic Server for a description of ImportPrivateKey.
Application instance passwords are encrypted using 3DES algorithm and stored in persistent storage. If no encryption key is configured, a default encryption key is used, but best practice to use your own key. It should be 24 Bytes.
To configure the encryption key, from the Administration Console:
Select Security realms, and then, myrealm.
Click the Providers tab.
Click the Authentication tab.
Click WLNG Application Authenticator.
In the Settings for WLNG Application Authenticator screen, click the Configuration tab.
Click the Provider Specific tab.
In the Encryption Key field, enter your key.
In Please type again To confirm field, enter your key again for verification.
For information on the ApplicationInstanceMBean methods and fields, see the "All Classes" section of Services Gatekeeper OAM Java API Reference.