3 Managing Service Provider and Application Accounts

This chapter describes how service provider and application accounts are managed and provisioned:

• Summary of Tasks Related to Accounts

• States of Accounts

• Account Properties

• Account References

• Reference: Attributes and Operations for ApplicationAccounts

See "Reference: Attributes and Operations for ApplicationAccounts" for information on finding the operations in the Administration Console and for the name of the MBean.

Before you register application accounts, service provider accounts (see "Service Provider Accounts") and application groups (see "Application Groups") must be created.

Before you can register service provider accounts, service provider groups must be created. See "Service Provider Groups" for more information.

Summary of Tasks Related to Accounts

The following is a summary of tasks related to accounts.

Application Accounts

Table 3-1 lists the tasks related to application accounts and the operations you use to perform those tasks.

Table 3-1 Tasks Related to Application Accounts

Task	Operation to Use
Get information about the number of application accounts	countApplicationAccounts
Add, remove and get information about an application account	addApplicationAccount removeApplicationAccount getApplicationAccount
List registered application accounts	listApplicationAccounts
Define additional properties for an application account	setApplicationAccountGroup setApplicationAccountProperties setApplicationAccountReference setApplicationAccountState

Service Provider Accounts

Table 3-2 lists the tasks related to service provider accounts and the operations you use to perform those tasks.

Table 3-2 Tasks Related to Service Provider Accounts

Task	Operation to Use
Get information about the number of service provider accounts	countServiceProviderAccounts
Add, remove and get information about a service provider account	addServiceProviderAccount removeServiceProviderAccount getServiceProviderAccount
List registered service provider accounts	listServiceProviderAccounts
Define additional properties for a service provider account	setServiceProviderAccountGroup setServiceProviderAccountProperties setServiceProviderAccountReference setServiceProviderAccountState

States of Accounts

To provide an easy way to take an application out-of-service temporarily, service provider and application accounts have associated states. States are also used by the Partner Relationship Management module to enforce workflow management.

Accounts can be in either one of the states described in Table 3-3:

Table 3-3 Account State Indicators

Account State	Restriction on Application Belonging to Account
ACTIVATED	An application belonging to such an account is allowed to send requests to the application-facing interfaces exposed by Services Gatekeeper.
DEACTIVATED	An application belonging to such an account is not allowed to send requests to the application-facing interfaces exposed by Oracle Communications Services Gatekeeper.

State transition is provided using:

• setApplicationAccountState

• setServiceProviderAccountState

It is possible to filter on account state in all the following methods:

• countApplicationAccounts

• countServiceProviderAccounts

• listApplicationAccounts

• listServiceProviderAccounts

When an account is created using "addApplicationAccount" or "addServiceProviderAccount", state is always ACTIVATED.

Account Properties

An account can have a set of associated properties. These are generic key-value pairs.You cannot set these using the Administration Console, but you can use MBeans or the PRM Web Services.

The properties are displayed in the following operations:

• getApplicationInstance

• getApplicationAccount

• getApplicationGroup

• getServiceProviderAccount

• getServiceProviderGroup

Account References

An account can have an associated reference. The reference is a form of alias or internal ID for the account. It is used to correlate the account with an operator-internal ID.

The references are defined as parameters in the following operations:

• addApplicationInstance

• setApplicationInstanceReference

• setApplicationInstanceProperties

• addApplicationAccount

• setApplicationAccountReference

• addServiceProviderAccount

• setApplicationAccountReference

They are retrieved as part of the result of:

• getApplicationInstance

• getApplicationAccount

• getServiceProviderAccount

Reference: Attributes and Operations for ApplicationAccounts

Managed object: Container Services > AccountService > ApplicationAccounts

MBean: com.bea.wlcp.wlng.account.management.ApplicationAccountMBean

Following is a list of operations for configuration and maintenance.

• addApplicationAccount

• addServiceProviderAccount

• countApplicationAccounts

• countServiceProviderAccounts

• getApplicationAccount

• getServiceProviderAccount

• listApplicationAccounts

• listServiceProviderAccounts

• removeApplicationAccount

• removeServiceProviderAccount

• setApplicationAccountGroup

• setApplicationAccountProperties

• setApplicationAccountReference

• setApplicationAccountState

• setServiceProviderAccountGroup

• setServiceProviderAccountProperties

• setServiceProviderAccountReference

• setServiceProviderAccountState

---

addApplicationAccount

The addApplicationAccount operation adds an application account.

Scope

Domain

Signature

addApplicationAccount(Application Identifier: String, Service Provider Identifier: String, Application Group Identifier: String, Reference: String)

Parameters

Application Identifier

ID of the application account to add.

Service Provider Identifier

ID of the service provider account to which the application account belongs.

Application Group Identifier

ID of the application group to which the application account belongs.

Reference

See "Account References".

---

addServiceProviderAccount

The addServiceProviderAccount operation adds a service provider account.

Scope

Domain

Signature

addServiceProviderAccount(Service Provider Identifier: String, Service Provider Group Identifier: String, Reference: String)

Parameters

Service Provider Identifier

ID of the service provider account to add.

The account will not be created if this parameter is blank spaces.

Service Provider Group Identifier

ID of the service provider group to which the service provider account belongs.

Reference

See "Account References".

---

countApplicationAccounts

The countApplicationAccounts operation displays the number of registered application accounts. The display can be filtered on any combination of:

• service provider account

• application group

• application account state.

Scope

Domain

Signature

countApplicationAccounts(serviceProviderIdentifier : String, applicationGroupIdentifier: String, state : String)

Parameters

ServiceProviderIdentifier

ID of the service provider account.

Optional. Leave empty to match all.

ApplicationGroupIdentifier

ID of the application group.

Optional. Leave empty to match all.

State

State of application account. See "States of Accounts".

Valid values:

• ACTIVATED

• DEACTIVATED

Optional. Leave empty to match all.

---

countServiceProviderAccounts

The countServiceProviderAccounts operation displays the number of registered service provider accounts. Can be filtered on any combination of:

• service provider group

• service provider account state.

Scope

Domain

Signature

countServiceProviderAccounts(serviceProviderGroupIdentifier : String, state :String)

Parameters

serviceProviderGroupIdentifier

ID of the service provider group.

Optional. Leave empty to match all.

State

State of service provider account. See "States of Accounts".

Valid values:

• ACTIVATED

• DEACTIVATED

Optional. Leave empty to match all.

---

getApplicationAccount

The getApplicationAccount operation gets information about an application account. Because the application account is not necessarily unique across service provider accounts, you must also specify the relevant service provider account.

The information includes:

• Application account ID.

• ID of the service provider account to which the application account belongs.

• State, see "States of Accounts".

• Reference, see "Account References".

• Properties, see Account Properties.

Scope

Domain

Signature

getApplicationAccount(Application Identifier: String, Service Provider Identifier: String)

Parameters

Application Identifier

ID of the application account to get information about.

Service Provider Identifier

ID of the service provider account to which the application account belongs.

---

getServiceProviderAccount

The getServiceProviderAccount operation gets information about a service provider account.

The retrieved information includes:

• Service provider account ID.

• State, see "States of Accounts".

• Reference, see "Account References".

• Properties, see "Account Properties".

Scope

Domain

Signature

getServiceProviderAccount(Service Provider Identifier: String)

Parameters

Service Provider Identifier

ID of the service provider account.

---

listApplicationAccounts

The listApplicationAccounts operation displays a list of application accounts. The display can be filtered on any combination of:

• service provider account.

• application group.

• state of application account.

The resultant list contains application account IDs.

Scope

Domain

Signature

listApplicationAccounts(ServiceProviderIdentifier: String, ApplicationGroupIdentifier : String, State: String, Offset: int, Size: int)

Parameters

ServiceProviderIdentifier

ID of the service provider account.

Optional. Leave empty to match all.

ApplicationGroupIdentifier

Application group ID.

Optional. Leave empty to match all.

State

State of application account. See "States of Accounts"

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

---

listServiceProviderAccounts

The listServiceProviderAccounts operation displays a list of service provider accounts. Can be filtered on any combination of:

• service provider group.

• state of service provider account.

The resultant list contains service provider account IDs.

Scope

Domain

Signature

listServiceProviderAccounts(ServiceProviderGroupIdentifier: String, State: String, Offset: int, Size: int)

Parameters

ServiceProviderGroupIdentifier

Service provider group ID.

Optional. Leave empty to match all.

State

State of service provider account. See "States of Accounts"

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

---

removeApplicationAccount

The removeApplicationAccount operation removes an application account.

To be removed, the account must not have any associated application instances. The application account state must also be DEACTIVATED.

Because the application account is not necessarily unique across service provider accounts, you must also specify the relevant service provider account.

Scope

Domain

Signature

removeApplicationAccount(Application Identifier: String,Service Provider Identifier: String)

Parameters

Application Identifier

ID of the application account to remove.

Service Provider Identifier

ID of the service provider account the application account belongs to.

---

removeServiceProviderAccount

The removeServiceProviderAccount operation removes a service provider account.

To be removed, the service provider account must not have any associated application accounts and must be in the DEACTIVATED state.

Scope

Domain

Signature

removeServiceProviderAccount(Service Provider Identifier: String)

Parameters

Service Provider Identifier

ID of the service provider account to remove.

---

setApplicationAccountGroup

The setApplicationAccountGroup operation sets the application account group for a particular application account/service provider account combination. Is also used to change to which group a combination belongs.

Scope

Domain

Signature

setApplicationAccountGroup(Application Identifier: String, Service Provider Identifier: String, Application Group Identifier: String)

Parameters

Application Identifier

ID of the application account to be assigned.

Service Provider Identifier

ID of the service provider account associated with the application account to be assigned.

Application Group Identifier

ID of the application group to which the combination is to be assigned.

---

setApplicationAccountProperties

The setApplicationAccountProperties operation specifies properties for an application account/service provider account combination. See "Account Properties".

Note:

Only applicable when accessing the MBean directly.

Scope

Domain

Signature

setApplicationAccountProperties(Application Identifier: String, Service Provider Identifier: String, Properties: Set<Map.Entry<String, String>>)

Parameters

Application Identifier

ID of the application account whose properties are being set.

Service Provider Identifier

ID of the service provider account to which the application account belongs.

Properties

See "Account Properties".

---

setApplicationAccountReference

The setApplicationAccountReference operation specifies a reference for an application account/service provide account combinations. See "Account References".

Scope

Domain

Signature

setApplicationAccountReference(Application Identifier: String, Service Provider Identifier: String, Reference: String)

Parameters

Application Identifier

ID of the application account whose reference is being set.

Service Provider Identifier

ID of the service provider account to which the application account belongs.

Reference

See "Account References".

---

setApplicationAccountState

The setApplicationAccountState operation performs a state transition for an application account/service provide account combination. See "States of Accounts".

Scope

Domain

Signature

setApplicationAccountReference(Application Identifier: String, Service Provider Identifier: String, State: String)

Parameters

Application Identifier

ID of the application account whose state is to be changed.

Service Provider Identifier

ID of the service provider account to which the application account belongs.

State

One of:

• ACTIVATED

• DEACTIVATED

See "States of Accounts".

---

setServiceProviderAccountGroup

The setServiceProviderAccountGroup operation specifies to which service provider group a certain service provider account belongs. Can be used as well to change the group assignment.

Scope

Domain

Signature

setServiceProviderAccountGroup(Service Provider Identifier: String, Service Provider Group Identifier: String)

Parameters

Service Provider Identifier

ID of the service provider account being assigned.

Service Provider Group Identifier

ID of the service provider group to which the account is being assigned.

---

setServiceProviderAccountProperties

The setServiceProviderAccountProperties operation specifies properties for a service provider account. See "Account Properties".

Note:

Only applicable when accessing the MBean directly.

Scope

Domain

Signature

setServiceProviderAccountProperties(Service Provider Identifier: String, Properties: Set<Map.Entry<String, String>>)

Parameters

Service Provider Identifier

ID of the service provider account whose properties are being set.

Properties

See "Account Properties".

---

setServiceProviderAccountReference

The setServiceProviderAccountReference operation specifies a reference for a service provider account. See "Account References".

Scope

Domain

Signature

setServiceProviderAccountReference(Service Provider Identifier: String, Reference: String)

Parameters

Service Provider Identifier

ID of the service provider account whose reference is being set.

Reference

See "Account References".

---

setServiceProviderAccountState

The setServiceProviderAccountState operation performs a state transition for a service provider account. See "States of Accounts".

Scope

Domain

Signature

setServiceProviderAccountState(Service Provider Identifier: String, State: String)

Parameters

Service Provider Identifier

ID of the service provider account whose state is being changed.

State

One of:

• ACTIVATED

• DEACTIVATED

See "States of Accounts".