org.apache.geronimo.deployment
Interface ConfigurationBuilder

All Known Implementing Classes:
EARConfigBuilder, ServiceConfigBuilder

public interface ConfigurationBuilder


Field Summary
static String CONFIG_BUILDER
           
 
Method Summary
 DeploymentContext buildConfiguration(boolean inPlaceDeployment, Artifact configId, Object plan, JarFile module, Collection configurationStores, ArtifactResolver artifactResolver, ConfigurationStore targetConfigurationStore)
          Build a configuration from a local file
 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.
 

Field Detail

CONFIG_BUILDER

static final String CONFIG_BUILDER
See Also:
Constant Field Values
Method Detail

getDeploymentPlan

Object getDeploymentPlan(File planFile,
                         JarFile module,
                         ModuleIDBuilder idBuilder)
                         throws 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:
DeploymentException - if there was a problem with the configuration

getConfigurationID

Artifact getConfigurationID(Object plan,
                            JarFile module,
                            ModuleIDBuilder idBuilder)
                            throws IOException,
                                   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
DeploymentException - if there was a problem with the configuration

buildConfiguration

DeploymentContext buildConfiguration(boolean inPlaceDeployment,
                                     Artifact configId,
                                     Object plan,
                                     JarFile module,
                                     Collection configurationStores,
                                     ArtifactResolver artifactResolver,
                                     ConfigurationStore targetConfigurationStore)
                                     throws IOException,
                                            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
DeploymentException - if there was a problem with the configuration


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