org.apache.geronimo.kernel.config
Interface PersistentConfigurationList


public interface PersistentConfigurationList

Version:
$Rev: 399794 $ $Date: 2006-05-04 20:04:16 +0200 (Thu, 04 May 2006) $

Field Summary
static String PERSISTENT_CONFIGURATION_LIST
           
 
Method Summary
 void addConfiguration(Artifact configName)
          Adds a configuration to the list, but does not mark it as started.
 Artifact[] getListedConfigurations(Artifact query)
          Gets all configurations in the list matching the specified query, whether they are marked at starting or not.
 boolean isKernelFullyStarted()
           
 void migrateConfiguration(Artifact oldName, Artifact newName, Configuration configuration)
          Migrates settings from an old version of a configuration to a newer version of the configuration.
 void removeConfiguration(Artifact configName)
          Removes all record of the specified configuration from the configuration list.
 List restore()
           
 void save()
           
 void setKernelFullyStarted(boolean kernelFullyStarted)
           
 void startConfiguration(Artifact configName)
          Indicates that the configuration should be started when the server is started.
 void stopConfiguration(Artifact configName)
          Indicates that the configuration should not be started when the server is started.
 

Field Detail

PERSISTENT_CONFIGURATION_LIST

public static final String PERSISTENT_CONFIGURATION_LIST
See Also:
Constant Field Values
Method Detail

isKernelFullyStarted

public boolean isKernelFullyStarted()

setKernelFullyStarted

public void setKernelFullyStarted(boolean kernelFullyStarted)

save

public void save()
          throws IOException
Throws:
IOException

restore

public List restore()
             throws IOException
Throws:
IOException

addConfiguration

public void addConfiguration(Artifact configName)
Adds a configuration to the list, but does not mark it as started.


startConfiguration

public void startConfiguration(Artifact configName)
Indicates that the configuration should be started when the server is started. The configuration should have been previously added with addConfiguration.


stopConfiguration

public void stopConfiguration(Artifact configName)
Indicates that the configuration should not be started when the server is started. The configuration should have been previously added with addConfiguration (and presumably started with startConfiguration).


removeConfiguration

public void removeConfiguration(Artifact configName)
Removes all record of the specified configuration from the configuration list. This is somewhat unusual -- normally you want to remember the settings in case the configuration is deployed again later.


getListedConfigurations

public Artifact[] getListedConfigurations(Artifact query)
Gets all configurations in the list matching the specified query, whether they are marked at starting or not.

Parameters:
query - The artifact to search for, normally not fully resolved so there may be multiple matches or matches that are not exactly equal to the argument.
Returns:
The matching artifacts that have data in the config list.

migrateConfiguration

public void migrateConfiguration(Artifact oldName,
                                 Artifact newName,
                                 Configuration configuration)
Migrates settings from an old version of a configuration to a newer version of the configuration. Used when an updated version is deployed with a newer version number in the name, but the settings used for the previous version should be carried forward.

Parameters:
oldName - The name that the existing settings are under
newName - The name to move the settings to
configuration - The configuration itself, which can be used to verify that all the settings are still valid as they are migrated.


Copyright © 2003-2007 Apache Software Foundation. All Rights Reserved.