com.bea.wlcp.wlng.account.management
Interface ApplicationAccountMBean

public interface ApplicationAccountMBean

Method Summary

abstract void	addApplicationAccount(java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier, java.lang.String applicationGroupIdentifier, java.lang.String reference) Adds an application account.
abstract void	addServiceProviderAccount(java.lang.String serviceProviderIdentifier, java.lang.String serviceProviderGroupIdentifier, java.lang.String reference) Adds a service provider account.
abstract int	countApplicationAccounts(java.lang.String serviceProviderIdentifier, java.lang.String applicationGroupIdentifier, java.lang.String state) Gets the number of application accounts.
abstract int	countServiceProviderAccounts(java.lang.String serviceProviderGroupIdentifier, java.lang.String state) Displays the number of registered service provider accounts.
abstract ApplicationDescription	getApplicationAccount(java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier) Gets information about an application account.
abstract ServiceProviderDescription	getServiceProviderAccount(java.lang.String serviceProviderIdentifier) Gets information about a service provider account.
abstract java.util.Set	listApplicationAccounts(java.lang.String serviceProviderIdentifier, java.lang.String applicationGroupIdentifier, java.lang.String state, int offset, int size) Displays a list of application accounts.
abstract java.util.Set	listServiceProviderAccounts(java.lang.String serviceProviderGroupIdentifier, java.lang.String state, int offset, int size) Displays a list of service provider accounts.
abstract void	removeApplicationAccount(java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier) Removes a deactivated empty application account.
abstract void	removeServiceProviderAccount(java.lang.String serviceProviderIdentifier) Removes a deactivated empty service provider account.
abstract void	setApplicationAccountGroup(java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier, java.lang.String applicationGroupIdentifier) Sets the application account group for a particular application account/service provider account combination.
abstract void	setApplicationAccountProperties(java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier, java.util.Set properties) Sets properties for an application account.
abstract void	setApplicationAccountReference(java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier, java.lang.String reference) Sets reference for an application account.
abstract void	setApplicationAccountState(java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier, java.lang.String state) Sets state for an application account.
abstract void	setServiceProviderAccountGroup(java.lang.String serviceProviderIdentifier, java.lang.String serviceProviderGroupIdentifier) Sets a group for a service provider account.
abstract void	setServiceProviderAccountProperties(java.lang.String serviceProviderIdentifier, java.util.Set properties) Sets properties for a service provider account.
abstract void	setServiceProviderAccountReference(java.lang.String serviceProviderIdentifier, java.lang.String reference) Sets state for a service provider account.
abstract void	setServiceProviderAccountState(java.lang.String serviceProviderIdentifier, java.lang.String state) Sets state for a service provider account.

Method Detail

addApplicationAccount

public void addApplicationAccount(java.lang.String applicationIdentifier,
                                  java.lang.String serviceProviderIdentifier,
                                  java.lang.String applicationGroupIdentifier,
                                  java.lang.String reference)
                           throws com.bea.wlcp.wlng.api.management.DuplicateKeyException,
                                  com.bea.wlcp.wlng.api.management.KeyNotFoundException

Adds an application account.

Scope: Domain

Parameters:

applicationIdentifier - The application identifier.

serviceProviderIdentifier - The service provider.

applicationGroupIdentifier - The application group.

reference - The account reference.

Throws:

com.bea.wlcp.wlng.api.management.DuplicateKeyException - If such an account already exists.

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such parent account or account group exists.

addServiceProviderAccount

public void addServiceProviderAccount(java.lang.String serviceProviderIdentifier,
                                      java.lang.String serviceProviderGroupIdentifier,
                                      java.lang.String reference)
                               throws com.bea.wlcp.wlng.api.management.DuplicateKeyException,
                                      com.bea.wlcp.wlng.api.management.KeyNotFoundException

Adds a service provider account.

Scope: Domain

Parameters:

serviceProviderIdentifier - The account identifier.

serviceProviderGroupIdentifier - The service provider group.

reference - The account reference.

Throws:

com.bea.wlcp.wlng.api.management.DuplicateKeyException - If such an account already exists.

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such account group exists.

countApplicationAccounts

public int countApplicationAccounts(java.lang.String serviceProviderIdentifier,
                                    java.lang.String applicationGroupIdentifier,
                                    java.lang.String state)
                             throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Gets the number of application accounts.

Scope: Domain

Parameters:

serviceProviderIdentifier - The service provider (optional).

applicationGroupIdentifier - The application group identifier (optional).

state - The state (ACTIVATED or DEACTIVATED) (optional).

Returns:

The number of child accounts for specified filter.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - if no such account or group exists.

countServiceProviderAccounts

public int countServiceProviderAccounts(java.lang.String serviceProviderGroupIdentifier,
                                        java.lang.String state)
                                 throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Displays the number of registered service provider accounts. Can be filtered on any combination of:

• Service provider group
• Service provider account state

Scope: Domain

Parameters:

serviceProviderGroupIdentifier - The service provider group identifier (optional). Leave empty to match all.

state - The state (ACTIVATED or DEACTIVATED) (optional). Leave empty to match all.

Returns:

The number of accounts for specified filter.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - if no such group exists.

getApplicationAccount

public ApplicationDescription getApplicationAccount(java.lang.String applicationIdentifier,
                                                    java.lang.String serviceProviderIdentifier)

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
• Reference
• Properties

Scope: Domain

Parameters:

applicationIdentifier - The account identifier.

serviceProviderIdentifier - The service provider.

Returns:

The application account description or null if it doesn't exist.

getServiceProviderAccount

public ServiceProviderDescription getServiceProviderAccount(java.lang.String serviceProviderIdentifier)

Gets information about a service provider account.

The retrieved information includes:

• Service provider account ID
• State
• Reference
• Properties

Scope: Domain

Parameters:

serviceProviderIdentifier - The account identifier.

Returns:

The child account description or null if no such account exists.

listApplicationAccounts

public java.util.Set listApplicationAccounts(java.lang.String serviceProviderIdentifier,
                                             java.lang.String applicationGroupIdentifier,
                                             java.lang.String state,
                                             int offset,
                                             int size)
                                      throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Displays a list of application accounts. The display can be filtered on any combination of:

• Service provider account
• Application group
• State of the application account

The list contains application account IDs.

Scope: Domain

Parameters:

serviceProviderIdentifier - The service provider (optional). Leave empty to match all.

applicationGroupIdentifier - The application group identifier (optional). Leave empty to match all.

state - The state (ACTIVATED or DEACTIVATED) (optional). Leave empty to match all.

offset - Offset in complete resultset. Must be >= 0.

size - Number of entries to return. 0 means no limit.

Returns:

The application accounts matching specified filter.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - if no such account or group exists.

listServiceProviderAccounts

public java.util.Set listServiceProviderAccounts(java.lang.String serviceProviderGroupIdentifier,
                                                 java.lang.String state,
                                                 int offset,
                                                 int size)
                                          throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Displays a list of service provider accounts. Can be filtered on any combination of:

• Service provider group
• State of service provider account

The list contains service provider account IDs.

Scope: Domain

Parameters:

serviceProviderGroupIdentifier - The service provider group identifier (optional). Leave empty to match all.

state - The state (ACTIVATED or DEACTIVATED) (optional). Leave empty to match all.

offset - Offset in complete resultset. Must be >= 0.

size - Number of entries to return. 0 means no limit.

Returns:

The service provider accounts matching specified filter.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - if no such group exists.

removeApplicationAccount

public void removeApplicationAccount(java.lang.String applicationIdentifier,
                                     java.lang.String serviceProviderIdentifier)
                              throws com.bea.wlcp.wlng.api.management.ManagementException

Removes a deactivated empty 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

Parameters:

applicationIdentifier - The application account.

serviceProviderIdentifier - The service provider account.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException - If the account is not in deactivated state or contains users.

removeServiceProviderAccount

public void removeServiceProviderAccount(java.lang.String serviceProviderIdentifier)
                                  throws com.bea.wlcp.wlng.api.management.ManagementException

Removes a deactivated empty 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

Parameters:

serviceProviderIdentifier - The account.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException - If the account contains child accounts or is not in deactivated state.

setApplicationAccountGroup

public void setApplicationAccountGroup(java.lang.String applicationIdentifier,
                                       java.lang.String serviceProviderIdentifier,
                                       java.lang.String applicationGroupIdentifier)
                                throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

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

Parameters:

applicationIdentifier - The account.

serviceProviderIdentifier - The service provider account ID.

applicationGroupIdentifier - The new group or null if group should not change.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such account could be found.

setApplicationAccountProperties

public void setApplicationAccountProperties(java.lang.String applicationIdentifier,
                                            java.lang.String serviceProviderIdentifier,
                                            java.util.Set properties)
                                     throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Sets properties for an application account.

Note: Only applicable when accessing the MBean directly.

Scope: Domain

Parameters:

applicationIdentifier - The account.

serviceProviderIdentifier - The service provider account ID.

properties - The new properties. A set with Map.Entry.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such account could be found.

setApplicationAccountReference

public void setApplicationAccountReference(java.lang.String applicationIdentifier,
                                           java.lang.String serviceProviderIdentifier,
                                           java.lang.String reference)
                                    throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Sets reference for an application account.

Scope: Domain

Parameters:

applicationIdentifier - The account.

serviceProviderIdentifier - The service provider account ID.

reference - The account reference.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such account could be found.

setApplicationAccountState

public void setApplicationAccountState(java.lang.String applicationIdentifier,
                                       java.lang.String serviceProviderIdentifier,
                                       java.lang.String state)
                                throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Sets state for an application account.

Parameters:

applicationIdentifier - The account.

serviceProviderIdentifier - The service provider account ID.

state - The new state or null if state should not change.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such account could be found.

setServiceProviderAccountGroup

public void setServiceProviderAccountGroup(java.lang.String serviceProviderIdentifier,
                                           java.lang.String serviceProviderGroupIdentifier)
                                    throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Sets a group for a service provider account. Can be used as well to change the group assignment.

Scope: Domain

Parameters:

serviceProviderIdentifier - The account.

serviceProviderGroupIdentifier - The new group or null if group should not change.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such account could be found.

setServiceProviderAccountProperties

public void setServiceProviderAccountProperties(java.lang.String serviceProviderIdentifier,
                                                java.util.Set properties)
                                         throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Sets properties for a service provider account.

Note: Only applicable when accessing the MBean directly.

Scope: Domain

Parameters:

serviceProviderIdentifier - The account.

properties - The new properties. A set with Map.Entry.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such account could be found.

setServiceProviderAccountReference

public void setServiceProviderAccountReference(java.lang.String serviceProviderIdentifier,
                                               java.lang.String reference)
                                        throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Sets state for a service provider account.

Scope: Domain

Parameters:

serviceProviderIdentifier - The account.

reference - The account reference.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such account could be found.

setServiceProviderAccountState

public void setServiceProviderAccountState(java.lang.String serviceProviderIdentifier,
                                           java.lang.String state)
                                    throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Sets state for a service provider account.

Scope: Domain

Parameters:

serviceProviderIdentifier - The account.

state - The new state (ACTIVATED or DEACTIVATED).

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If no such account could be found.