2 Managing Application Instances

This chapter describes how application instances are managed and provisioned in Services Gatekeeper:

• Summary of Tasks Related to Application Instances

• States of Application Instances

• Web Services Security

• Password Encryption

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.

Summary of Tasks Related to Application Instances

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	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

States of Application Instances

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:

setApplicationInstanceState

Web Services Security

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.

Table 2-2 Credential Mapping

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.

Password Encryption

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:

1. Select Security realms > myrealm.

2. Click the Providers tab.

3. Click the Authentication tab.

4. Click WLNG Application Authenticator.

5. In the Settings for WLNG Application Authenticator screen, click the Configuration tab.

6. Click the Provider Specific tab.

7. In the Encryption Key field, enter your key.

8. In Please type again To confirm field, enter your key again for verification.

Reference: ApplicationInstances

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.

• addApplicationInstance

• countApplicationInstances

• getApplicationInstance

• listApplicationInstances

• removeApplicationInstance

• setApplicationInstancePassword

• setApplicationInstanceProperties

• setApplicationInstanceReference

• setApplicationInstanceState

---

addApplicationInstance

The addApplicationInstance operation adds an application instance. Each instance is always connected to a service provider/application account combination.

Scope

Domain

Signature

addApplicationInstance(ApplicationInstanceName: String, Password: String, ApplicationIdentifier: String, ServiceProviderIdentifier: String, Reference: String)

Parameters

ApplicationInstanceName

ID for the new application instance. Used by an application to authenticate. Must be unique.

Password

Password for the application instance.

ApplicationIdentifier

ID of the application account the application instance shall belong to.

ServiceProviderIdentifier

ID of the service provider the application instance shall belong to.

Reference

"Account References"

Must be unique.

---

countApplicationInstances

The countApplicationInstances operation displays the number of registered application instances for a service provider/application account/application instance combinations. Can be filtered by state.

Scope

Domain

Signature

countApplicationInstances(ApplicationIdentifier: String, ServiceProviderIdentifier: String, State: String)

Parameters

ApplicationIdentifier

ID of the application account.

Optional. Leave empty to match all.

ServiceProviderIdentifier

ID of the service provider account.

Optional. Leave empty to match all.

State

State of application instance.

Valid values:

Optional. Leave empty to match all.

• ACTIVATED

• DEACTIVATED

---

getApplicationInstance

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".

Scope

Domain

Signature

getApplicationInstance(ApplicationInstanceName: String)

Parameters

ApplicationInstanceName

ID of the application instance to get information about.

---

listApplicationInstances

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.

Scope

Domain

Signature

listApplicationInstances(ApplicationIdentifier: String, ServiceProviderIdentifier: String, State: String, Offset: int, Size: int)

Parameters

ApplicationIdentifier

ID of the application account to list application instances for.

Optional. Leave empty to match all.

ServiceProviderIdentifier

ID of the service provider account to list application instances for.

Optional. Leave empty to match all.

State

State of application instance.

Valid values:

• ACTIVATED

• DEACTIVATED

Optional. Leave empty to match all.

Offset

Offset in the list. Starts with 0 (zero)

Size

Size of the list.

For no restrictions on the size of the list, use 0 (zero).

---

removeApplicationInstance

The removeApplicationInstance operation removes a registered application instance.

The account must be in DEACTIVATED state.

Scope

Domain

Signature

removeApplicationInstance(ApplicationInstanceName: String)

Parameters

ApplicationInstanceName

ID of the application instance to remove.

---

setApplicationInstancePassword

The setApplicationInstancePassword operation defines a new password for an application instance.

Scope

Domain

Signature

setApplicationInstancePassword( ApplicationInstanceName: String, Password: String)

Parameters

ApplicationInstanceName

ID of the application instance.

Password

New password.

---

setApplicationInstanceProperties

The setApplicationInstanceProperties operation specifies properties for an application instance. See "Account Properties".

Note:

This application is applicable only when the MBean is accessed directly.

Scope

Domain

Signature

setApplicationInstanceProperties(ApplicationInstanceName: String, Properties: Set<Map.Entry<String, String>>)

Parameters

ApplicationInstanceName

ID of the application instance to set properties for.

Properties

See "Account Properties".

---

setApplicationInstanceReference

The setApplicationInstanceReference operation specifies a reference for an application instance. See "Account References".

Scope

Domain

Signature

setApplicationInstanceReference(ApplicationInstanceName: String, Reference: String)

Parameters

ApplicationInstanceName

ID of the application instance to set the reference for.

Reference

See "Account References".

---

setApplicationInstanceState

The setApplicationInstanceState operation performs a state transition for an application instance. See "States of Application Instances".

Scope

Domain

Signature

setApplicationInstanceState(ApplicationInstanceName: String, State: String)

Parameters

ApplicationInstanceName

ID of the application instance to change state for.

State

One of:

• ACTIVATED

• DEACTIVATED

See "States of Application Instances".