org.codehaus.enunciate.modules.jaxws
Class JAXWSSupportDeploymentModule

java.lang.Object
  org.codehaus.enunciate.modules.BasicDeploymentModule
      org.codehaus.enunciate.modules.FreemarkerDeploymentModule
          org.codehaus.enunciate.modules.jaxws.JAXWSSupportDeploymentModule

All Implemented Interfaces:

EnunciateModelAware, DeploymentModule

public class JAXWSSupportDeploymentModule
extends FreemarkerDeploymentModule

JAX-WS Support Module

The JAXWS support deployment module is a simple module that generates the request/response/fault beans for doc/lit SOAP operations as specified in the JAX-WS specification.

The order of the JAXWS Support deployment module is 0, as it doesn't depend on any artifacts exported by any other module.

• steps
• configuration
• artifacts

Steps

generate

"Generate" is only one significant step in the JAX-WS Support module. It generates the stubs according to the JAX-WS spec.

Configuration

There are no configuration options for the jaxws deployment module

Artifacts

The jaxws support deployment module exports its source directory under artifact id "jaxws.support.src.dir" during the generate step.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.codehaus.enunciate.modules.BasicDeploymentModule

enunciate

Constructor Summary

JAXWSSupportDeploymentModule()

Method Summary

void	doFreemarkerGenerate() Generate using Freemarker.
java.lang.String	getName() The name of the deployment module.
Validator	getValidator() Get the validator for this module, or null if none.
boolean	isDisabled() Whether this deployment module has been disabled, e.g.
protected boolean	isUpToDate(java.io.File genDir) Whether the generate dir is up-to-date.

Methods inherited from class org.codehaus.enunciate.modules.FreemarkerDeploymentModule

close, doGenerate, getConfiguration, getModel, getModelInternal, getObjectWrapper, getTemplateExceptionHandler, getTemplateLoader, initModel, processTemplate, processTemplate, processTemplate, processTemplate

Methods inherited from class org.codehaus.enunciate.modules.BasicDeploymentModule

debug, doBuild, doCompile, doPackage, getAliases, getBuildDir, getCompileDir, getConfigurationRules, getEnunciate, getGenerateDir, getOrder, getPackageDir, info, init, setBuildDir, setCompileDir, setDisabled, setGenerateDir, setPackageDir, step, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JAXWSSupportDeploymentModule

public JAXWSSupportDeploymentModule()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: DeploymentModule

The name of the deployment module. Identifies its section in the enunciate configuration.

Specified by:

getName in interface DeploymentModule

Overrides:

getName in class BasicDeploymentModule

Returns:

"xml"

doFreemarkerGenerate

public void doFreemarkerGenerate()
                          throws java.io.IOException,
                                 freemarker.template.TemplateException

Description copied from class: FreemarkerDeploymentModule

Generate using Freemarker. Same as FreemarkerDeploymentModule.doGenerate() but can throw a TemplateException.

Specified by:

doFreemarkerGenerate in class FreemarkerDeploymentModule

Throws:

java.io.IOException

freemarker.template.TemplateException

isUpToDate

protected boolean isUpToDate(java.io.File genDir)

Whether the generate dir is up-to-date.

Parameters:

genDir - The generate dir.

Returns:

Whether the generate dir is up-to-date.

getValidator

public Validator getValidator()

Description copied from interface: DeploymentModule

Get the validator for this module, or null if none.

Specified by:

getValidator in interface DeploymentModule

Overrides:

getValidator in class BasicDeploymentModule

Returns:

null

isDisabled

public boolean isDisabled()

Description copied from interface: DeploymentModule

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.

Specified by:

isDisabled in interface DeploymentModule

Overrides:

isDisabled in class BasicDeploymentModule

Returns:

Whether this deployment module has been disabled.