Oracle® Communications Services Gatekeeper Accounts and SLAs Guide Release 5.0 Part Number E16617-02 |
|
|
View PDF |
This chapter describes how service provider and application accounts are managed and provisioned:
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.
The following is a summary of tasks related to 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 |
|
Add, remove and get information about an application account |
|
List registered application accounts |
|
Define additional properties for an application account |
setApplicationAccountProperties |
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 |
|
Add, remove and get information about a service provider account |
|
List registered service provider accounts |
|
Define additional properties for a service provider account |
setServiceProviderAccountGroup setServiceProviderAccountProperties |
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:
It is possible to filter on account state in all the following methods:
When an account is created using "addApplicationAccount" or "addServiceProviderAccount", state is always ACTIVATED.
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:
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:
They are retrieved as part of the result of:
Managed object: Container Services > AccountService > ApplicationAccounts
MBean: com.bea.wlcp.wlng.account.management.ApplicationAccountMBean
Following is a list of operations for configuration and maintenance.
The addApplicationAccount operation adds an application account.
Domain
addApplicationAccount(Application Identifier: String, Service Provider Identifier: String, Application Group Identifier: String, Reference: String)
ID of the application account to add.
ID of the service provider account to which the application account belongs.
ID of the application group to which the application account belongs.
See "Account References".
The addServiceProviderAccount operation adds a service provider account.
Domain
addServiceProviderAccount(Service Provider Identifier: String, Service Provider Group Identifier: String, Reference: String)
ID of the service provider account to add.
The account will not be created if this parameter is blank spaces.
ID of the service provider group to which the service provider account belongs.
See "Account References".
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.
Domain
countApplicationAccounts(serviceProviderIdentifier : String, applicationGroupIdentifier: String, state : String)
ID of the service provider account.
Optional. Leave empty to match all.
ID of the application group.
Optional. Leave empty to match all.
State of application account. See "States of Accounts".
Valid values:
ACTIVATED
DEACTIVATED
Optional. Leave empty to match all.
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.
Domain
countServiceProviderAccounts(serviceProviderGroupIdentifier : String, state :String)
ID of the service provider group.
Optional. Leave empty to match all.
State of service provider account. See "States of Accounts".
Valid values:
ACTIVATED
DEACTIVATED
Optional. Leave empty to match all.
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.
Domain
getApplicationAccount(Application Identifier: String, Service Provider Identifier: String)
ID of the application account to get information about.
ID of the service provider account to which the application account belongs.
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".
Domain
getServiceProviderAccount(Service Provider Identifier: String)
ID of the service provider account.
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.
Domain
listApplicationAccounts(ServiceProviderIdentifier: String, ApplicationGroupIdentifier : String, State: String, Offset: int, Size: int)
ID of the service provider account.
Optional. Leave empty to match all.
Application group ID.
Optional. Leave empty to match all.
State of application account. See "States of Accounts"
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 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.
Domain
listServiceProviderAccounts(ServiceProviderGroupIdentifier: String, State: String, Offset: int, Size: int)
Service provider group ID.
Optional. Leave empty to match all.
State of service provider account. See "States of Accounts"
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 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.
Domain
removeApplicationAccount(Application Identifier: String,Service Provider Identifier: String)
ID of the application account to remove.
ID of the service provider account the application account belongs to.
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.
Domain
removeServiceProviderAccount(Service Provider Identifier: String)
ID of the service provider account to remove.
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.
Domain
setApplicationAccountGroup(Application Identifier: String, Service Provider Identifier: String, Application Group Identifier: String)
ID of the application account to be assigned.
ID of the service provider account associated with the application account to be assigned.
ID of the application group to which the combination is to be assigned.
The setApplicationAccountProperties operation specifies properties for an application account/service provider account combination. See "Account Properties".
Note:
Only applicable when accessing the MBean directly.Domain
setApplicationAccountProperties(Application Identifier: String, Service Provider Identifier: String, Properties: Set<Map.Entry<String, String>>)
ID of the application account whose properties are being set.
ID of the service provider account to which the application account belongs.
See "Account Properties".
The setApplicationAccountReference operation specifies a reference for an application account/service provide account combinations. See "Account References".
Domain
setApplicationAccountReference(Application Identifier: String, Service Provider Identifier: String, Reference: String)
ID of the application account whose reference is being set.
ID of the service provider account to which the application account belongs.
See "Account References".
The setApplicationAccountState operation performs a state transition for an application account/service provide account combination. See "States of Accounts".
Domain
setApplicationAccountReference(Application Identifier: String, Service Provider Identifier: String, State: String)
ID of the application account whose state is to be changed.
ID of the service provider account to which the application account belongs.
One of:
ACTIVATED
DEACTIVATED
See "States of Accounts".
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.
Domain
setServiceProviderAccountGroup(Service Provider Identifier: String, Service Provider Group Identifier: String)
ID of the service provider account being assigned.
ID of the service provider group to which the account is being assigned.
The setServiceProviderAccountProperties operation specifies properties for a service provider account. See "Account Properties".
Note:
Only applicable when accessing the MBean directly.Domain
setServiceProviderAccountProperties(Service Provider Identifier: String, Properties: Set<Map.Entry<String, String>>)
ID of the service provider account whose properties are being set.
See "Account Properties".
The setServiceProviderAccountReference operation specifies a reference for a service provider account. See "Account References".
Domain
setServiceProviderAccountReference(Service Provider Identifier: String, Reference: String)
ID of the service provider account whose reference is being set.
See "Account References".
The setServiceProviderAccountState operation performs a state transition for a service provider account. See "States of Accounts".
Domain
setServiceProviderAccountState(Service Provider Identifier: String, State: String)
ID of the service provider account whose state is being changed.
One of:
ACTIVATED
DEACTIVATED
See "States of Accounts".