com.kabira.test.management

Class Client.Configuration

java.lang.Object

com.kabira.test.management.Client.Configuration

Enclosing class:

Client

public final class Client.Configuration
extends java.lang.Object

Provides a mechanism for loading and managing configuration data.

Constructor Summary

Constructors

Constructor and Description
Configuration(java.net.URL url) Create a new Configuration instance to manage the supplied configuration data

Method Summary

Modifier and Type	Method and Description
void	activate() Activate the current configuration.
void	deactivate() Deactivate the current configuration.
java.lang.String[]	display() Display the current Configuration.
java.lang.String[]	export() Export the current configuration.
java.lang.String	getName() Get the name of the currently-loaded configuration.
ConfigurationState	getState() Get the state of the currently-loaded configuration.
java.lang.String	getType() Get the type of the currently-loaded configuration.
java.lang.String	getVersion() Get the version of the currently-loaded configuration.
void	load() Load configuration data.
void	remove() Remove the current configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Configuration

public Configuration(java.net.URL url)

Create a new Configuration instance to manage the supplied configuration data

Parameters:

url - the URL of the configuration data.

Method Detail

load

public void load()
          throws CommandFailed,
                 Transaction.InvalidTransactionState

Load configuration data.

Throws:

CommandFailed - the URL could not be opened, or the configuration failed audit.

Transaction.InvalidTransactionState - called from a transactional context.

activate

public void activate()
              throws CommandFailed,
                     Transaction.InvalidTransactionState

Activate the current configuration. Configuration must have been loaded by this instance of Configuration.

Throws:

CommandFailed - the configuration was not loaded by this Configuration instance or the configuration is already active.

Transaction.InvalidTransactionState - called from a transactional context.

deactivate

public void deactivate()
                throws CommandFailed,
                       Transaction.InvalidTransactionState

Deactivate the current configuration. Configuration must have been loaded by this instance of Configuration.

Throws:

CommandFailed - the configuration was not loaded by this Configuration instance or the configuration is not active.

Transaction.InvalidTransactionState - called from a transactional context.

remove

public void remove()
            throws CommandFailed,
                   Transaction.InvalidTransactionState

Remove the current configuration. Configuration must have been loaded by this instance of Configuration.

Throws:

CommandFailed - the configuration was not loaded by this Configuration instance or the configuration has already been removed.

Transaction.InvalidTransactionState - called from a transactional context.

display

public java.lang.String[] display()
                           throws CommandFailed,
                                  Transaction.InvalidTransactionState

Display the current Configuration. Configuration must have been loaded by this instance of Configuration.

Returns:

All available information about the configuration.

Throws:

CommandFailed - the configuration was not loaded by this Configuration instance.

Transaction.InvalidTransactionState - called from a transactional context.

export

public java.lang.String[] export()
                          throws CommandFailed,
                                 Transaction.InvalidTransactionState

Export the current configuration. Configuration must have been loaded by this instance of Configuration.

Returns:

The configuration data formatted as a kcs file.

Throws:

CommandFailed - the configuration was not loaded by this Configuration instance.

Transaction.InvalidTransactionState - called from a transactional context.

getType

public java.lang.String getType()
                         throws CommandFailed

Get the type of the currently-loaded configuration.

Returns:

the type of the currently-loaded configuration.

Throws:

CommandFailed - the configuration was not loaded by this Configuration instance.

getName

public java.lang.String getName()
                         throws CommandFailed

Get the name of the currently-loaded configuration.

Returns:

the name of the currently-loaded configuration

Throws:

CommandFailed - the configuration was not loaded by this Configuration instance.

getVersion

public java.lang.String getVersion()
                            throws CommandFailed

Get the version of the currently-loaded configuration.

Returns:

the version of the currently-loaded configuration

Throws:

CommandFailed - the configuration was not loaded by this Configuration instance.

getState

public ConfigurationState getState()
                            throws CommandFailed,
                                   Transaction.InvalidTransactionState

Get the state of the currently-loaded configuration.

Returns:

the state of the currently-loaded configuration

Throws:

CommandFailed - the configuration was not loaded by this Configuration instance.

Transaction.InvalidTransactionState - called from a transactional context.