org.apache.geronimo.kernel.config
Interface ConfigurationStore

public interface ConfigurationStore

Interface to a store for Configurations.

Version:

$Revision: 1.10 $ $Date: 2004/06/24 02:50:13 $

Method Summary

boolean	containsConfiguration(URI configID) Determines if the store contains a configuration with the spedified ID.
URL	getBaseURL(URI id) Return the base URL for the specified ID
org.apache.geronimo.gbean.jmx.GBeanMBean	getConfiguration(URI id) Return the Configuration GBean for the specified ID
String	getObjectName() Return the object name for the store.
URI	install(URL source) Add the CAR at the supplied URL into this store
List	listConfiguations() Return the configurations in the store
void	uninstall(URI configID)

Method Detail

install

public URI install(URL source)
            throws IOException,
                   InvalidConfigException

Add the CAR at the supplied URL into this store

Parameters:

source - the URL of a CAR format archive

Throws:

IOException - if the CAR could not be read

InvalidConfigException - if there is a configuration problem with the CAR

uninstall

public void uninstall(URI configID)
               throws NoSuchConfigException,
                      IOException

Throws:

NoSuchConfigException

IOException

containsConfiguration

public boolean containsConfiguration(URI configID)

Determines if the store contains a configuration with the spedified ID.

Parameters:

configID - the unique ID of the configuration

Returns:

true if the store contains the configuration

getConfiguration

public org.apache.geronimo.gbean.jmx.GBeanMBean getConfiguration(URI id)
                                                          throws NoSuchConfigException,
                                                                 IOException,
                                                                 InvalidConfigException

Return the Configuration GBean for the specified ID

Parameters:

id - the unique ID of a Configuration

Returns:

the GBeanMBean for that configuration

Throws:

NoSuchConfigException - if the store does not contain a Configuration with that id

IOException - if there was a problem loading the Configuration from the store

InvalidConfigException - if the Configuration is invalid

getBaseURL

public URL getBaseURL(URI id)
               throws NoSuchConfigException

Return the base URL for the specified ID

Parameters:

id - the unique ID for a Configuration

Returns:

the URL of the base location for the Configuration that should be used for resolution

Throws:

NoSuchConfigException - if the store does not contain a Configuration with that id

getObjectName

public String getObjectName()

Return the object name for the store.

Returns:

the object name for the store

listConfiguations

public List listConfiguations()

Return the configurations in the store

Returns:

a List of configurations in the store