org.apache.geronimo.deployment
Interface ConfigurationBuilder


public interface ConfigurationBuilder

Version:
$Rev: 398051 $ $Date: 2006-04-29 03:13:14 +0200 (Sat, 29 Apr 2006) $

Method Summary
 DeploymentContext buildConfiguration(boolean inPlaceDeployment, org.apache.geronimo.kernel.repository.Artifact configId, Object plan, JarFile module, Collection configurationStores, org.apache.geronimo.kernel.repository.ArtifactResolver artifactResolver, org.apache.geronimo.kernel.config.ConfigurationStore targetConfigurationStore)
          Build a configuration from a local file
 org.apache.geronimo.kernel.repository.Artifact getConfigurationID(Object plan, JarFile module, ModuleIDBuilder idBuilder)
          Checks what configuration URL will be used for the provided module.
 Object getDeploymentPlan(File planFile, JarFile module, ModuleIDBuilder idBuilder)
          Builds a deployment plan specific to this builder from a planFile and/or module if this builder can process it.
 

Method Detail

getDeploymentPlan

public Object getDeploymentPlan(File planFile,
                                JarFile module,
                                ModuleIDBuilder idBuilder)
                         throws org.apache.geronimo.common.DeploymentException
Builds a deployment plan specific to this builder from a planFile and/or module if this builder can process it.

Parameters:
planFile - the deployment plan to examine; can be null
module - the URL of the module to examine; can be null
Returns:
the deployment plan, or null if this builder can not handle the module
Throws:
org.apache.geronimo.common.DeploymentException - if there was a problem with the configuration

getConfigurationID

public org.apache.geronimo.kernel.repository.Artifact getConfigurationID(Object plan,
                                                                         JarFile module,
                                                                         ModuleIDBuilder idBuilder)
                                                                  throws IOException,
                                                                         org.apache.geronimo.common.DeploymentException
Checks what configuration URL will be used for the provided module.

Parameters:
plan - the deployment plan
module - the module to build
Returns:
the ID that will be used for the Configuration
Throws:
IOException - if there was a problem reading or writing the files
org.apache.geronimo.common.DeploymentException - if there was a problem with the configuration

buildConfiguration

public DeploymentContext buildConfiguration(boolean inPlaceDeployment,
                                            org.apache.geronimo.kernel.repository.Artifact configId,
                                            Object plan,
                                            JarFile module,
                                            Collection configurationStores,
                                            org.apache.geronimo.kernel.repository.ArtifactResolver artifactResolver,
                                            org.apache.geronimo.kernel.config.ConfigurationStore targetConfigurationStore)
                                     throws IOException,
                                            org.apache.geronimo.common.DeploymentException
Build a configuration from a local file

Parameters:
inPlaceDeployment - true if the deployment is in-place.
plan - the deployment plan
module - the module to build
configurationStores -
artifactResolver -
targetConfigurationStore -
Returns:
the deployment context created from the deployment (the contexts must be closed by the caller)
Throws:
IOException - if there was a problem reading or writing the files
org.apache.geronimo.common.DeploymentException - if there was a problem with the configuration


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