org.apache.geronimo.kernel.config
Class SimpleConfigurationManager

java.lang.Object
  org.apache.geronimo.kernel.config.SimpleConfigurationManager

All Implemented Interfaces:

ConfigurationManager

Direct Known Subclasses:

KernelConfigurationManager

public class SimpleConfigurationManager
extends Object
implements ConfigurationManager

Field Summary

protected ConfigurationModel	configurationModel
protected Map	configurations
protected static Log	log
protected Collection	repositories
protected Collection	stores
protected Collection	watchers

Constructor Summary

SimpleConfigurationManager(Collection stores, ArtifactResolver artifactResolver, Collection repositories)

SimpleConfigurationManager(Collection stores, ArtifactResolver artifactResolver, Collection repositories, Collection watchers)

Method Summary

protected void	addNewConfigurationToModel(Configuration configuration)
ArtifactResolver	getArtifactResolver() Gets the common ArtifactResolver in case the caller wants to use this directly.
Configuration	getConfiguration(Artifact configurationId) Gets a loaded Configuration (does not see unloaded configurations).
Artifact[]	getInstalled(Artifact query) Given an artifact that's not fully resolved (e.g. some parts are missing), check whether there are any instances installed into the server environment.
Artifact[]	getLoaded(Artifact query) Given an artifact that's not fully resolved (e.g. some parts are missing), check whether there are any instances loaded.
protected LinkedHashSet	getLoadParents(Configuration configuration)
Collection	getRepositories()
Artifact[]	getRunning(Artifact query) Given an artifact that's not fully resolved (e.g. some parts are missing), check whether there are any instances running.
protected LinkedHashSet	getStartParents(Configuration configuration)
ConfigurationStore	getStoreForConfiguration(Artifact configId) Gets the configuration store responsible for the specified configuration, or null if there is none.
ConfigurationStore[]	getStores() Get all the ConfigurationStores known to this manager at present
boolean	isConfiguration(Artifact artifact) Is the specified artifact a configuration?
boolean	isInstalled(Artifact configId) Is the specified configuration installed into the server environment?
boolean	isLoaded(Artifact configId) Is the specified configuration loaded into the kernel?
boolean	isOnline() this configuration manager never starts configurations.
boolean	isRunning(Artifact configId) Is the specified configuation running?
List	listConfigurations() Gets a List>ConfigurationInfo< of every of every available configuation.
List	listConfigurations(AbstractName storeName) Return a list of the configurations in a specific store.
List	listStores() Return a list of the stores this manager knows about.
protected void	load(Artifact configurationId)
protected Configuration	load(ConfigurationData configurationData, LinkedHashSet resolvedParentIds, Map loadedConfigurations)
LifecycleResults	loadConfiguration(Artifact configurationId) Load the specified configuration (from a config store) and all configurations it depends on into the kernel.
LifecycleResults	loadConfiguration(Artifact configurationId, LifecycleMonitor monitor) Load the specified configuration (from a config store) and all configurations it depends on into the kernel.
LifecycleResults	loadConfiguration(ConfigurationData configurationData) Load the specified configurationData and all configurations it depends on (from a config store) into the kernel.
LifecycleResults	loadConfiguration(ConfigurationData configurationData, LifecycleMonitor monitor) Load the specified configurationData and all configurations it depends on (from a config store) into the kernel.
protected void	migrateConfiguration(Artifact oldName, Artifact newName, Configuration configuration, boolean running)
LifecycleResults	reloadConfiguration(Artifact id) Reloads the specified configuration and all configurations that have a dependency on the specified configuration
LifecycleResults	reloadConfiguration(Artifact id, LifecycleMonitor monitor) Reloads the specified configuration and all configurations that have a dependency on the specified configuration
LifecycleResults	reloadConfiguration(Artifact id, Version version) Reloads the specified configuration and all configurations that have a dependency on the specified configuration
LifecycleResults	reloadConfiguration(Artifact id, Version version, LifecycleMonitor monitor) Reloads the specified configuration and all configurations that have a dependency on the specified configuration
LifecycleResults	reloadConfiguration(ConfigurationData configurationData) Reloads the specified configuration and all configurations that have a dependency on the specified configuration
LifecycleResults	reloadConfiguration(ConfigurationData configurationData, LifecycleMonitor monitor) Reloads the specified configuration and all configurations that have a dependency on the specified configuration
protected void	removeConfigurationFromModel(Artifact configurationId)
LifecycleResults	restartConfiguration(Artifact id) Restarts the specified configuration and all configurations that have a service dependency on the specified configuration
LifecycleResults	restartConfiguration(Artifact id, LifecycleMonitor monitor) Restarts the specified configuration and all configurations that have a service dependency on the specified configuration
void	setOnline(boolean online)
protected void	start(Configuration configuration)
LifecycleResults	startConfiguration(Artifact id) Loads and starts all of the gbeans contained within the configuration.
LifecycleResults	startConfiguration(Artifact id, LifecycleMonitor monitor) Loads and starts all of the gbeans contained within the configuration.
protected void	stop(Configuration configuration)
LifecycleResults	stopConfiguration(Artifact id) Stop the gbeans contained within the configuration.
LifecycleResults	stopConfiguration(Artifact id, LifecycleMonitor monitor) Stop the gbeans contained within the configuration.
void	uninstallConfiguration(Artifact configurationId) Unstalls the specified configuration from the server.
protected void	unload(Configuration configuration)
LifecycleResults	unloadConfiguration(Artifact id) Stops and unloads the configuration.
LifecycleResults	unloadConfiguration(Artifact id, LifecycleMonitor monitor) Stops and unloads the configuration.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final Log log

stores

protected final Collection stores

configurations

protected final Map configurations

configurationModel

protected final ConfigurationModel configurationModel

repositories

protected final Collection repositories

watchers

protected final Collection watchers

Constructor Detail

SimpleConfigurationManager

public SimpleConfigurationManager(Collection stores,
                                  ArtifactResolver artifactResolver,
                                  Collection repositories)

SimpleConfigurationManager

public SimpleConfigurationManager(Collection stores,
                                  ArtifactResolver artifactResolver,
                                  Collection repositories,
                                  Collection watchers)

Method Detail

isInstalled

public boolean isInstalled(Artifact configId)

Description copied from interface: ConfigurationManager

Is the specified configuration installed into the server environment? That is, does it exist in the configuration store, regardless of whether it's loaded or running? Note that this always returns false if the argument does not represent a configuration (e.g. if it's for a plain JAR).

Specified by:

isInstalled in interface ConfigurationManager

Parameters:

configId - the configuration identifier, which must be fully resolved (isResolved() == true)

Returns:

true if the configuration has been loaded; false otherwise

isLoaded

public boolean isLoaded(Artifact configId)

Description copied from interface: ConfigurationManager

Is the specified configuration loaded into the kernel? Note that this always returns false if the argument does not represent a configuration (e.g. if it's for a plain JAR).

Specified by:

isLoaded in interface ConfigurationManager

Parameters:

configId - the configuration identifier, which must be fully resolved (isResolved() == true)

Returns:

true if the configuration has been loaded; false otherwise

isRunning

public boolean isRunning(Artifact configId)

Description copied from interface: ConfigurationManager

Is the specified configuation running? Note that this always returns false if the argument does not represent a configuration (e.g. if it's for a plain JAR).

Specified by:

isRunning in interface ConfigurationManager

Parameters:

configId - the configuration identifier, which must be fully resolved (isResolved() == true)

Returns:

true if the configuration is running, false otherwise

getInstalled

public Artifact[] getInstalled(Artifact query)

Description copied from interface: ConfigurationManager

Given an artifact that's not fully resolved (e.g. some parts are missing), check whether there are any instances installed into the server environment. That is, are there any matches in the configuration store, regardless of whether they're loaded or running? Note that this always returns an empty array if the argument does not represent a configuration (e.g. if it's for a plain JAR).

Specified by:

getInstalled in interface ConfigurationManager

Parameters:

query - The partially-complete artifact name to check for

Returns:

All matching artifacts that are loaded in the server

getLoaded

public Artifact[] getLoaded(Artifact query)

Description copied from interface: ConfigurationManager

Given an artifact that's not fully resolved (e.g. some parts are missing), check whether there are any instances loaded. Note that this always returns an empty array if the argument does not represent a configuration (e.g. if it's for a plain JAR).

Specified by:

getLoaded in interface ConfigurationManager

Parameters:

query - The partially-complete artifact name to check for

Returns:

All matching artifacts that are loaded in the server

getRunning

public Artifact[] getRunning(Artifact query)

Description copied from interface: ConfigurationManager

Given an artifact that's not fully resolved (e.g. some parts are missing), check whether there are any instances running. Note that this always returns an empty array if the argument does not represent a configuration (e.g. if it's for a plain JAR).

Specified by:

getRunning in interface ConfigurationManager

Parameters:

query - The partially-complete artifact name to check for

Returns:

All matching artifacts that are loaded in the server

listStores

public List listStores()

Description copied from interface: ConfigurationManager

Return a list of the stores this manager knows about.

Specified by:

listStores in interface ConfigurationManager

Returns:

a List>AbstractName< of the stores this manager controls

getStores

public ConfigurationStore[] getStores()

Description copied from interface: ConfigurationManager

Get all the ConfigurationStores known to this manager at present

Specified by:

getStores in interface ConfigurationManager

getRepositories

public Collection getRepositories()

listConfigurations

public List listConfigurations()

Description copied from interface: ConfigurationManager

Gets a List>ConfigurationInfo< of every of every available configuation. This includes all configurations installed, regardless of whether they are currently loaded or running.

Specified by:

listConfigurations in interface ConfigurationManager

getStoreForConfiguration

public ConfigurationStore getStoreForConfiguration(Artifact configId)

Description copied from interface: ConfigurationManager

Gets the configuration store responsible for the specified configuration, or null if there is none. The configuration need not be loaded or running; this just checks which store holds the data for it.

Specified by:

getStoreForConfiguration in interface ConfigurationManager

Parameters:

configId - The unique ID for the configuration to check for, which must be fully resolved (isResolved() == true)

Returns:

The ConfigurationStore for this configuration, or null if the configuration was not found in any configuration store.

listConfigurations

public List listConfigurations(AbstractName storeName)
                        throws NoSuchStoreException

Description copied from interface: ConfigurationManager

Return a list of the configurations in a specific store.

Specified by:

listConfigurations in interface ConfigurationManager

Parameters:

storeName - the store to list

Returns:

a List>ConfigurationInfo< of all the configurations in the store

Throws:

NoSuchStoreException - if the store could not be located

isConfiguration

public boolean isConfiguration(Artifact artifact)

Description copied from interface: ConfigurationManager

Is the specified artifact a configuration?

Specified by:

isConfiguration in interface ConfigurationManager

Parameters:

artifact - the ID of the artifact to check, which must be fully resolved (isResolved() == true)

Returns:

true if the artifact is a configuration available in the server (regardless of whether it has been loaded/started)

getConfiguration

public Configuration getConfiguration(Artifact configurationId)

Description copied from interface: ConfigurationManager

Gets a loaded Configuration (does not see unloaded configurations).

Specified by:

getConfiguration in interface ConfigurationManager

Parameters:

configurationId - the unique ID of the configuration to get, which must be fully resolved (isResolved() == true)

Returns:

the specified configuration or null if the configuration has not been loaded

loadConfiguration

public LifecycleResults loadConfiguration(Artifact configurationId)
                                   throws NoSuchConfigException,
                                          LifecycleException

Description copied from interface: ConfigurationManager

Load the specified configuration (from a config store) and all configurations it depends on into the kernel. This causes the configuration gbean to be loaded and started, but does not load any of the gbeans contained within the configuration.

Specified by:

loadConfiguration in interface ConfigurationManager

Parameters:

configurationId - the configuration identifier, which must be fully resolved (isResolved() == true)

Returns:

the results of the operation

Throws:

NoSuchConfigException - if no configuration with the given id exists in the configuration stores

LifecycleException - if there is a problem loading the configuration

loadConfiguration

public LifecycleResults loadConfiguration(Artifact configurationId,
                                          LifecycleMonitor monitor)
                                   throws NoSuchConfigException,
                                          LifecycleException

Description copied from interface: ConfigurationManager

Load the specified configuration (from a config store) and all configurations it depends on into the kernel. This causes the configuration gbean to be loaded and started, but does not load any of the gbeans contained within the configuration.

Specified by:

loadConfiguration in interface ConfigurationManager

Parameters:

configurationId - the configuration identifier, which must be fully resolved (isResolved() == true)

monitor - the monitor that should receive events as the operation is carried out

Returns:

the results of the operation

Throws:

NoSuchConfigException - if no configuration with the given id exists in the configuration stores

LifecycleException - if there is a problem loading the configuration

loadConfiguration

public LifecycleResults loadConfiguration(ConfigurationData configurationData)
                                   throws NoSuchConfigException,
                                          LifecycleException

Description copied from interface: ConfigurationManager

Load the specified configurationData and all configurations it depends on (from a config store) into the kernel. This causes the configuration gbean to be loaded and started, but does not load any of the gbeans contained within the configuration.

Specified by:

loadConfiguration in interface ConfigurationManager

Parameters:

configurationData - the configuration to load

Returns:

the results of the operation

Throws:

NoSuchConfigException - if no configuration with the given id exists in the configuration stores

LifecycleException - if there is a problem loading the configuration

loadConfiguration

public LifecycleResults loadConfiguration(ConfigurationData configurationData,
                                          LifecycleMonitor monitor)
                                   throws NoSuchConfigException,
                                          LifecycleException

Description copied from interface: ConfigurationManager

Load the specified configurationData and all configurations it depends on (from a config store) into the kernel. This causes the configuration gbean to be loaded and started, but does not load any of the gbeans contained within the configuration.

Specified by:

loadConfiguration in interface ConfigurationManager

Parameters:

configurationData - the configuration to load

monitor - the monitor that should receive events as the operation is carried out

Returns:

the results of the operation

Throws:

NoSuchConfigException - if no configuration with the given id exists in the configuration stores

LifecycleException - if there is a problem loading the configuration

load

protected void load(Artifact configurationId)
             throws NoSuchConfigException

Throws:

NoSuchConfigException

load

protected Configuration load(ConfigurationData configurationData,
                             LinkedHashSet resolvedParentIds,
                             Map loadedConfigurations)
                      throws InvalidConfigException

Throws:

InvalidConfigException

addNewConfigurationToModel

protected void addNewConfigurationToModel(Configuration configuration)
                                   throws NoSuchConfigException

Throws:

NoSuchConfigException

getLoadParents

protected LinkedHashSet getLoadParents(Configuration configuration)

getStartParents

protected LinkedHashSet getStartParents(Configuration configuration)

startConfiguration

public LifecycleResults startConfiguration(Artifact id)
                                    throws NoSuchConfigException,
                                           LifecycleException

Description copied from interface: ConfigurationManager

Loads and starts all of the gbeans contained within the configuration. If any of the gbeans fails to fully start, all gbeans will be unloaded and an exception will be thrown. This operation causes all configurations that the specified configuration has a service dependency on to be started.

Specified by:

startConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

LifecycleException

startConfiguration

public LifecycleResults startConfiguration(Artifact id,
                                           LifecycleMonitor monitor)
                                    throws NoSuchConfigException,
                                           LifecycleException

Description copied from interface: ConfigurationManager

Loads and starts all of the gbeans contained within the configuration. If any of the gbeans fails to fully start, all gbeans will be unloaded and an exception will be thrown. This operation causes all configurations that the specified configuration has a service dependency on to be started.

Specified by:

startConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

monitor - the monitor that should receive events as the operation is carried out

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

LifecycleException

start

protected void start(Configuration configuration)
              throws Exception

Throws:

Exception

stopConfiguration

public LifecycleResults stopConfiguration(Artifact id)
                                   throws NoSuchConfigException

Description copied from interface: ConfigurationManager

Stop the gbeans contained within the configuration. This operation causes all configurations that have a service dependency on the specified configuration to be stopped.

Specified by:

stopConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

stopConfiguration

public LifecycleResults stopConfiguration(Artifact id,
                                          LifecycleMonitor monitor)
                                   throws NoSuchConfigException

Description copied from interface: ConfigurationManager

Stop the gbeans contained within the configuration. This operation causes all configurations that have a service dependency on the specified configuration to be stopped.

Specified by:

stopConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

monitor - the monitor that should receive events as the operation is carried out

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

stop

protected void stop(Configuration configuration)

restartConfiguration

public LifecycleResults restartConfiguration(Artifact id)
                                      throws NoSuchConfigException,
                                             LifecycleException

Description copied from interface: ConfigurationManager

Restarts the specified configuration and all configurations that have a service dependency on the specified configuration

Specified by:

restartConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

LifecycleException - if there is a problem loading the configuration

restartConfiguration

public LifecycleResults restartConfiguration(Artifact id,
                                             LifecycleMonitor monitor)
                                      throws NoSuchConfigException,
                                             LifecycleException

Description copied from interface: ConfigurationManager

Restarts the specified configuration and all configurations that have a service dependency on the specified configuration

Specified by:

restartConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

monitor - the monitor that should receive events as the operation is carried out

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

LifecycleException - if there is a problem loading the configuration

unloadConfiguration

public LifecycleResults unloadConfiguration(Artifact id)
                                     throws NoSuchConfigException

Description copied from interface: ConfigurationManager

Stops and unloads the configuration. This causes all contained gbeans to be stopped and unloaded, and the configuration gbean is stopped and unloaded. This operation causes all configurations that have a class or service dependency on the specified configuration to be stopped and unloaded.

Specified by:

unloadConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

unloadConfiguration

public LifecycleResults unloadConfiguration(Artifact id,
                                            LifecycleMonitor monitor)
                                     throws NoSuchConfigException

Description copied from interface: ConfigurationManager

Stops and unloads the configuration. This causes all contained gbeans to be stopped and unloaded, and the configuration gbean is stopped and unloaded. This operation causes all configurations that have a class or service dependency on the specified configuration to be stopped and unloaded.

Specified by:

unloadConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

monitor - the monitor that should receive events as the operation is carried out

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

removeConfigurationFromModel

protected void removeConfigurationFromModel(Artifact configurationId)
                                     throws NoSuchConfigException

Throws:

NoSuchConfigException

unload

protected void unload(Configuration configuration)

reloadConfiguration

public LifecycleResults reloadConfiguration(Artifact id)
                                     throws NoSuchConfigException,
                                            LifecycleException

Description copied from interface: ConfigurationManager

Reloads the specified configuration and all configurations that have a dependency on the specified configuration

Specified by:

reloadConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

LifecycleException - if there is a problem loading the configuration

reloadConfiguration

public LifecycleResults reloadConfiguration(Artifact id,
                                            LifecycleMonitor monitor)
                                     throws NoSuchConfigException,
                                            LifecycleException

Description copied from interface: ConfigurationManager

Reloads the specified configuration and all configurations that have a dependency on the specified configuration

Specified by:

reloadConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

monitor - the monitor that should receive events as the operation is carried out

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

LifecycleException - if there is a problem loading the configuration

reloadConfiguration

public LifecycleResults reloadConfiguration(Artifact id,
                                            Version version)
                                     throws NoSuchConfigException,
                                            LifecycleException

Description copied from interface: ConfigurationManager

Reloads the specified configuration and all configurations that have a dependency on the specified configuration

Specified by:

reloadConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

version - new version to load from the config store

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

LifecycleException - if there is a problem loading the configuration

reloadConfiguration

public LifecycleResults reloadConfiguration(Artifact id,
                                            Version version,
                                            LifecycleMonitor monitor)
                                     throws NoSuchConfigException,
                                            LifecycleException

Description copied from interface: ConfigurationManager

Reloads the specified configuration and all configurations that have a dependency on the specified configuration

Specified by:

reloadConfiguration in interface ConfigurationManager

Parameters:

id - the configuration identifier, which must be fully resolved (isResolved() == true)

version - new version to load from the config store

monitor - the monitor that should receive events as the operation is carried out

Returns:

the results of the operation

Throws:

NoSuchConfigException - if the configuration is not loaded

LifecycleException - if there is a problem loading the configuration

reloadConfiguration

public LifecycleResults reloadConfiguration(ConfigurationData configurationData)
                                     throws LifecycleException,
                                            NoSuchConfigException

Description copied from interface: ConfigurationManager

Reloads the specified configuration and all configurations that have a dependency on the specified configuration

Specified by:

reloadConfiguration in interface ConfigurationManager

Parameters:

configurationData - the configuration to load

Returns:

the results of the operation

Throws:

LifecycleException - if there is a problem loading the configuration

NoSuchConfigException - if the configuration is not loaded

reloadConfiguration

public LifecycleResults reloadConfiguration(ConfigurationData configurationData,
                                            LifecycleMonitor monitor)
                                     throws LifecycleException,
                                            NoSuchConfigException

Description copied from interface: ConfigurationManager

Reloads the specified configuration and all configurations that have a dependency on the specified configuration

Specified by:

reloadConfiguration in interface ConfigurationManager

Parameters:

configurationData - the configuration to load

monitor - the monitor that should receive events as the operation is carried out

Returns:

the results of the operation

Throws:

LifecycleException - if there is a problem loading the configuration

NoSuchConfigException - if the configuration is not loaded

migrateConfiguration

protected void migrateConfiguration(Artifact oldName,
                                    Artifact newName,
                                    Configuration configuration,
                                    boolean running)
                             throws NoSuchConfigException

Throws:

NoSuchConfigException

uninstallConfiguration

public void uninstallConfiguration(Artifact configurationId)
                            throws IOException,
                                   NoSuchConfigException

Description copied from interface: ConfigurationManager

Unstalls the specified configuration from the server. This operation can not be reversed.

Specified by:

uninstallConfiguration in interface ConfigurationManager

Parameters:

configurationId - the configuration identifier, which must be fully resolved (isResolved() == true)

Throws:

IOException - if there was a problem removing the configuration

NoSuchConfigException - if the configuration is not loaded

getArtifactResolver

public ArtifactResolver getArtifactResolver()

Description copied from interface: ConfigurationManager

Gets the common ArtifactResolver in case the caller wants to use this directly. It is configured for all the repositories known to this configuration manager, etc.

Specified by:

getArtifactResolver in interface ConfigurationManager

isOnline

public boolean isOnline()

this configuration manager never starts configurations.

Specified by:

isOnline in interface ConfigurationManager

Returns:

false

setOnline

public void setOnline(boolean online)

Specified by:

setOnline in interface ConfigurationManager