org.codehaus.enunciate.modules.jaxws_ri
Class JAXWSRIDeploymentModule

java.lang.Object
  org.codehaus.enunciate.modules.BasicDeploymentModule
      org.codehaus.enunciate.modules.FreemarkerDeploymentModule
          org.codehaus.enunciate.modules.jaxws_ri.JAXWSRIDeploymentModule

All Implemented Interfaces:

EnunciateModelAware, DeploymentModule, SpecProviderModule

public class JAXWSRIDeploymentModule
extends FreemarkerDeploymentModule
implements SpecProviderModule

JAX-WS RI Module

The JAX-WS RI module assembles a JAX-WS RI-based server-side application for hosting the SOAP endpoints.

• steps
• configuration
• artifacts

Steps

generate

The "generate" step generates the necessary configuration files.

Configuration

The JAX-WS RI module accepts the following parameters:

• The "forceSpringEnabled" that forces spring integration. By default, spring integration will only be enabled if the spring-app module is enabled and the JAX-WS spring components are found on the classpath.
• The "forceSpringDisabled" that forces spring integration to be disabled. By default, spring integration will be enabled if the spring-app module is enabled and the JAX-WS spring components are found on the classpath.
• The "useWsdlRedirectFilter" attribute is used to disable the use of the Enunciate-provided wsdl redirect filter that handles the requests to ?wsdl

Artifacts

The JAX-WS RI deployment module exports no artifacts.

Author:

Ryan Heaton

Field Summary

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

enunciate

Constructor Summary

JAXWSRIDeploymentModule()

Method Summary

protected void	doBuild() Default implementation is a no-op.
void	doFreemarkerGenerate() Generate using Freemarker.
protected java.io.File	getConfigGenerateDir()
protected java.net.URL	getInstrumentedEndpointTemplateURL()
protected java.net.URL	getJAXWSSpringTemplateURL()
java.lang.String	getName() The name of the deployment module.
protected java.net.URL	getSunJAXWSTemplateURL()
Validator	getValidator() Get the validator for this module, or null if none.
void	init(Enunciate enunciate) Sets the enunciate mechanism.
void	initModel(EnunciateFreemarkerModel model) Initialize the model.
boolean	isDisabled() Whether this deployment module has been disabled, e.g.
boolean	isJaxrsProvider() Whether this module is a JAX-RS provider module.
boolean	isJaxwsProvider() Whether this module is a JAX-WS provider module.
boolean	isSpringEnabled() Spring is enabled if the spring-app module is enabled AND the spring runtime servlet is on the Enunciate classpath.
protected boolean	isUpToDate() Whether the generated sources are up-to-date.
boolean	isUseWsdlRedirectFilter()
void	setForceSpringDisabled(boolean forceSpringDisabled)
void	setForceSpringEnabled(boolean forceSpringEnabled)
void	setUseWsdlRedirectFilter(boolean useWsdlRedirectFilter)

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

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

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

debug, doCompile, doPackage, getAliases, getBuildDir, getCompileDir, getConfigurationRules, getEnunciate, getGenerateDir, getOrder, getPackageDir, info, 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

JAXWSRIDeploymentModule

public JAXWSRIDeploymentModule()

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:

"jaxws-ri"

getJAXWSSpringTemplateURL

protected java.net.URL getJAXWSSpringTemplateURL()

Returns:

The URL to "jaxws-servlet.xml.fmt"

getSunJAXWSTemplateURL

protected java.net.URL getSunJAXWSTemplateURL()

Returns:

The URL to "jaxws-servlet.xml.fmt"

getInstrumentedEndpointTemplateURL

protected java.net.URL getInstrumentedEndpointTemplateURL()

Returns:

The URL to "jaxws-ri-endpoint.fmt"

init

public void init(Enunciate enunciate)
          throws EnunciateException

Description copied from class: BasicDeploymentModule

Sets the enunciate mechanism.

Specified by:

init in interface DeploymentModule

Overrides:

init in class BasicDeploymentModule

Parameters:

enunciate - The enunciate mechanism.

Throws:

EnunciateException

initModel

public void initModel(EnunciateFreemarkerModel model)

Description copied from interface: EnunciateModelAware

Initialize the model.

Specified by:

initModel in interface EnunciateModelAware

Overrides:

initModel in class FreemarkerDeploymentModule

Parameters:

model - The model to initialize.

isSpringEnabled

public boolean isSpringEnabled()

Spring is enabled if the spring-app module is enabled AND the spring runtime servlet is on the Enunciate classpath.

Returns:

Whether spring is enabled.

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

getConfigGenerateDir

protected java.io.File getConfigGenerateDir()

doBuild

protected void doBuild()
                throws EnunciateException,
                       java.io.IOException

Description copied from class: BasicDeploymentModule

Default implementation is a no-op.

Overrides:

doBuild in class BasicDeploymentModule

Throws:

EnunciateException

java.io.IOException

isUpToDate

protected boolean isUpToDate()

Whether the generated sources are up-to-date.

Returns:

Whether the generated sources are up-to-date.

isJaxwsProvider

public boolean isJaxwsProvider()

Description copied from interface: SpecProviderModule

Whether this module is a JAX-WS provider module.

Specified by:

isJaxwsProvider in interface SpecProviderModule

Returns:

Whether this module is a JAX-WS provider module.

isJaxrsProvider

public boolean isJaxrsProvider()

Description copied from interface: SpecProviderModule

Whether this module is a JAX-RS provider module.

Specified by:

isJaxrsProvider in interface SpecProviderModule

Returns:

Whether this module is a JAX-RS provider module.

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

setForceSpringEnabled

public void setForceSpringEnabled(boolean forceSpringEnabled)

setForceSpringDisabled

public void setForceSpringDisabled(boolean forceSpringDisabled)

isUseWsdlRedirectFilter

public boolean isUseWsdlRedirectFilter()

setUseWsdlRedirectFilter

public void setUseWsdlRedirectFilter(boolean useWsdlRedirectFilter)

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.