Oracle® Communications Services Gatekeeper Accounts and SLAs Guide Release 5.0 Part Number E16617-02 |
|
|
View PDF |
This chapter describes how application instances are managed and provisioned in Services Gatekeeper:
See "Reference: ApplicationInstances" for information about finding the operations in the Administration Console and for the name of the MBean.
Prior to 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.
Table 2-1 Tasks Related to Application Instances
Task | Operation to Use |
---|---|
Get information about the number of application instances |
|
Add, remove and get information about an application instance |
|
List registered application instances |
|
Define additional properties for an application instance |
setApplicationInstancePassword setApplicationInstanceProperties |
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 Oracle Communications Services Gatekeeper. The account is still valid and the state can be transitional by the Oracle Communications Services Gatekeeper Administrator using:
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 at:
http://download.oracle.com/docs/cd/E15523_01/web.1111/e13749/utils.htm
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 > 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.
All operations are reachable from:
Oracle Communications Services Gatekeeper Administration Console Managed Object: Container Services > AccountService > ApplicationInstances
MBean: com.bea.wlcp.wlng.account.management.ApplicationInstanceMBean
Following is a list of operations for management.
The addApplicationInstance operation adds an application instance. Each instance is always connected to a service provider/application account combination.
Domain
addApplicationInstance(ApplicationInstanceName: String, Password: String, ApplicationIdentifier: String, ServiceProviderIdentifier: String, Reference: String)
ID for the new application instance. Used by an application to authenticate. Must be unique.
Password for the application instance.
ID of the application account the application instance shall belong to.
ID of the service provider the application instance shall belong to.
Must be unique.
The countApplicationInstances operation displays the number of registered application instances for a service provider/application account/application instance combinations. Can be filtered by state.
Domain
countApplicationInstances(ApplicationIdentifier: String, ServiceProviderIdentifier: String, State: String)
ID of the application account.
Optional. Leave empty to match all.
ID of the service provider account.
Optional. Leave empty to match all.
State of application instance.
Valid values:
Optional. Leave empty to match all.
ACTIVATED
DEACTIVATED
The getApplicationInstance operation gets information about a registered application instance. The information includes:
ID of the application account to which the application instance belongs.
ID of the service provider account to which the application instance belongs.
State: See "States of Application Instances".
Reference: See "Account References".
Properties: See "Account Properties".
Domain
getApplicationInstance(ApplicationInstanceName: String)
ID of the application instance to get information about.
The listApplicationInstances operation displays a list of registered application instances for a specific service provider/application account/application instance state combination.
The list contains application instance IDs.
Domain
listApplicationInstances(ApplicationIdentifier: String, ServiceProviderIdentifier: String, State: String, Offset: int, Size: int)
ID of the application account to list application instances for.
Optional. Leave empty to match all.
ID of the service provider account to list application instances for.
Optional. Leave empty to match all.
State of application instance.
Valid values:
ACTIVATED
DEACTIVATED
Optional. Leave empty to match all.
Offset in the list. Starts with 0 (zero)
Size of the list.
For no restrictions on the size of the list, use 0 (zero).
The removeApplicationInstance operation removes a registered application instance.
The account must be in DEACTIVATED state.
Domain
removeApplicationInstance(ApplicationInstanceName: String)
ID of the application instance to remove.
The setApplicationInstancePassword operation defines a new password for an application instance.
Domain
setApplicationInstancePassword( ApplicationInstanceName: String, Password: String)
ID of the application instance.
New password.
The setApplicationInstanceProperties operation specifies properties for an application instance. See "Account Properties".
Note:
This application is applicable only when the MBean is accessed directly.Domain
setApplicationInstanceProperties(ApplicationInstanceName: String, Properties: Set<Map.Entry<String, String>>)
ID of the application instance to set properties for.
See "Account Properties".
The setApplicationInstanceReference operation specifies a reference for an application instance. See "Account References".
Domain
setApplicationInstanceReference(ApplicationInstanceName: String, Reference: String)
ID of the application instance to set the reference for.
See "Account References".
The setApplicationInstanceState operation performs a state transition for an application instance. See "States of Application Instances".
Domain
setApplicationInstanceState(ApplicationInstanceName: String, State: String)
ID of the application instance to change state for.
One of:
ACTIVATED
DEACTIVATED