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

public interface ApplicationInstanceMBean

Method Summary

abstract void	addApplicationInstance(java.lang.String applicationInstanceName, java.lang.String password, java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier, java.lang.String reference) Adds an application instance.
abstract int	countApplicationInstances(java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier, java.lang.String state) Displays the number of registered application instances for a service provider/application account/application instance combinations.
abstract ApplicationInstanceDescription	getApplicationInstance(java.lang.String applicationInstanceName) Gets an application instance description.
abstract java.lang.String[]	listApplicationInstances(java.lang.String applicationIdentifier, java.lang.String serviceProviderIdentifier, java.lang.String state, int offset, int size) Displays a list of registered application instances for a specific service provider/application account/application instance state combination.
abstract void	removeApplicationInstance(java.lang.String applicationInstanceName) Removes an application instance.
abstract void	setApplicationInstancePassword(java.lang.String applicationInstanceName, java.lang.String password) Sets an application instance password.
abstract void	setApplicationInstanceProperties(java.lang.String applicationInstanceName, java.util.Set properties) Sets application instance properties.
abstract void	setApplicationInstanceReference(java.lang.String applicationInstanceName, java.lang.String reference) Sets an application instance reference.
abstract void	setApplicationInstanceState(java.lang.String applicationInstanceName, java.lang.String state) Sets application instance state.

Method Detail

addApplicationInstance

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

Adds an application instance. Each instance is always connected to a service provider/application account combination.

Scope: Domain

Parameters:

applicationInstanceName - The application instance name.

password - The password.

applicationIdentifier - The application account.

serviceProviderIdentifier - The service provider account.

reference - An alias reference ID for this application instance.

Throws:

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

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

countApplicationInstances

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

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

Scope: Domain

Parameters:

applicationIdentifier - The application (optional).

serviceProviderIdentifier - The service provider (optional).

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

Returns:

The count of application instances matching specified filter.

Throws:

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

getApplicationInstance

public ApplicationInstanceDescription getApplicationInstance(java.lang.String applicationInstanceName)

Gets an application instance description. 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
• Reference

Scope: Domain

Parameters:

applicationInstanceName - The application instance name.

Returns:

The application instance description or null if the application instance doesn't exist.

listApplicationInstances

public java.lang.String[] listApplicationInstances(java.lang.String applicationIdentifier,
                                                   java.lang.String serviceProviderIdentifier,
                                                   java.lang.String state,
                                                   int offset,
                                                   int size)
                                            throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

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

Parameters:

applicationIdentifier - The application identifier (optional).

serviceProviderIdentifier - The service provider (optional).

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

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

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

Returns:

The application instances matching the specified filter.

Throws:

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

removeApplicationInstance

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

Removes an application instance. The account must be in DEACTIVATED state.

Scope: Domain

Parameters:

applicationInstanceName - the application instance.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException - If the application instance is not in deactivated state.

setApplicationInstancePassword

public void setApplicationInstancePassword(java.lang.String applicationInstanceName,
                                           java.lang.String password)
                                    throws com.bea.wlcp.wlng.api.management.KeyNotFoundException

Sets an application instance password.

Scope: Domain

Parameters:

applicationInstanceName - The application instance to update.

password - The new password.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If the application instance does not exist.

setApplicationInstanceProperties

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

Sets application instance properties.

Note: Only applicable when the MBean is accessed directly.

Scope: Domain

Parameters:

applicationInstanceName - The application instance to update.

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

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If the application instance does not exist.

setApplicationInstanceReference

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

Sets an application instance reference.

Scope: Domain

Parameters:

applicationInstanceName - The application instance to update.

reference - The new reference.

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If the application instance does not exist.

setApplicationInstanceState

public void setApplicationInstanceState(java.lang.String applicationInstanceName,
                                        java.lang.String state)
                                 throws com.bea.wlcp.wlng.api.management.KeyNotFoundException,
                                        com.bea.wlcp.wlng.api.management.ManagementException

Sets application instance state.

Scope: Domain

Parameters:

applicationInstanceName - The application instance to update.

state - The new state (ACTIVATED or DEACTIVATED).

Throws:

com.bea.wlcp.wlng.api.management.KeyNotFoundException - If the application instance does not exist.

com.bea.wlcp.wlng.api.management.ManagementException - If a parameter was invalid.