org.codehaus.enunciate.modules
Interface DeploymentModule

All Known Subinterfaces:
DocumentationAwareModule, FacetAware, ProjectExtensionModule, ProjectTitleAware, ProjectVersionAware
All Known Implementing Classes:
AMFDeploymentModule, BasicAppModule, BasicDeploymentModule, CDeploymentModule, CSharpDeploymentModule, CXFDeploymentModule, DocumentationDeploymentModule, FreemarkerDeploymentModule, GWTDeploymentModule, JavaClientDeploymentModule, JAXWSRIDeploymentModule, JAXWSSupportDeploymentModule, JBossDeploymentModule, JerseyDeploymentModule, ObjCDeploymentModule, PHPDeploymentModule, RubyDeploymentModule, SpringAppDeploymentModule, SwaggerDeploymentModule, XMLDeploymentModule

public interface DeploymentModule

Interface for a deployment module. A deployment module for a specific platform implements logic for each enunciate step.

Author:
Ryan Heaton

Method Summary
 void close()
          Close this enunciate module.
 java.util.Set<java.lang.String> getAliases()
          Any aliases for this deployment module.
 org.apache.commons.digester.RuleSet getConfigurationRules()
          The configuration rules for this deployment module, or null if none.
 java.lang.String getName()
          The name of the deployment module.
 int getOrder()
          The order of execution for the deployment module.
 Validator getValidator()
          Get the validator for this module, or null if none.
 void init(Enunciate enunciate)
          Initialize this deployment module with the specified enunciate mechanism.
 boolean isDisabled()
          Whether this deployment module has been disabled, e.g.
 void step(Enunciate.Target target)
          Step to the next enunciate target.
 

Method Detail

getName

java.lang.String getName()
The name of the deployment module. Identifies its section in the enunciate configuration.

Returns:
The name of the deployment module.

getAliases

java.util.Set<java.lang.String> getAliases()
Any aliases for this deployment module.

Returns:
Any aliases for this deployment module.

getValidator

Validator getValidator()
Get the validator for this module, or null if none.

Returns:
The validator.

init

void init(Enunciate enunciate)
          throws EnunciateException
Initialize this deployment module with the specified enunciate mechanism. This will be called even if this module is disabled.

Parameters:
enunciate - The enunciate mechanism.
Throws:
EnunciateException

step

void step(Enunciate.Target target)
          throws EnunciateException,
                 java.io.IOException
Step to the next enunciate target.

Parameters:
target - The enunciate target to step to.
Throws:
EnunciateException
java.io.IOException

close

void close()
           throws EnunciateException
Close this enunciate module. This will be called even if this module is disabled.

Throws:
EnunciateException

getConfigurationRules

org.apache.commons.digester.RuleSet getConfigurationRules()
The configuration rules for this deployment module, or null if none.

Returns:
The configuration rules for this deployment module.

getOrder

int getOrder()
The order of execution for the deployment module.

Returns:
The order of execution for the deployment module.

isDisabled

boolean isDisabled()
Whether this deployment module has been disabled, e.g. in the config file. Since the discovery mechanism is used to discover the modules on the classpath, it may be necessary to be able to disable a module.

Returns:
Whether this deployment module has been disabled.