org.codehaus.mojo.jaxws

Class MainWsGenMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.jaxws.MainWsGenMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="wsgen",
      defaultPhase=PROCESS_CLASSES,
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class MainWsGenMojo
extends org.apache.maven.plugin.AbstractMojo

Reads a JAX-WS service endpoint implementation class and generates all of the portable artifacts for a JAX-WS web service.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	encoding Specify character encoding used by source files.
protected boolean	genWsdl Specify that a WSDL file should be generated in ${resourceDestDir}.
protected boolean	keep Keep generated files.
protected org.apache.maven.plugin.descriptor.PluginDescriptor	pluginDescriptor Information about this plugin, used to lookup this plugin's dependencies from the currently executing project.
protected org.apache.maven.project.MavenProject	project The Maven Project Object.
protected org.apache.maven.execution.MavenSession	session The current build session instance.
protected boolean	verbose Output messages about what the tool is doing.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
MainWsGenMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addSourceRoot(String sourceDir)
protected void	addVmArg(String vmArg)
protected void	exec(List<String> arguments)
void	execute()
void	executeJaxws()
protected File	getClassesDir()
protected List<String>	getCommonArgs()
protected String	getCPasString(Collection<org.apache.maven.artifact.Artifact> artifacts)
protected File	getDefaultSrcOut()
protected File	getDestDir() Either ${build.outputDirectory} or ${build.testOutputDirectory}.
protected String	getExtraClasspath()
protected String	getMain() Main class of the tool to launch when launched as java command.
protected File	getResourceDestDir()
protected File	getSourceDestDir()
protected String	getToolName() Name of the tool to run when launched as JDK executable from JDK Toolchain.
protected boolean	isArgSupported(String arg)
protected boolean	isExtensionOn()
protected boolean	isXnocompile() Checks if compilation after code generation and let generated sources be compiled by Maven during compilation phase.
protected void	maybeUnsupportedOption(String option, String value, List<String> arguments)
protected void	processSei(String aSei)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

genWsdl

@Parameter(defaultValue="false")
protected boolean genWsdl

Specify that a WSDL file should be generated in ${resourceDestDir}.

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

The Maven Project Object.

verbose

@Parameter(defaultValue="false")
protected boolean verbose

Output messages about what the tool is doing.

keep

@Parameter(defaultValue="true")
protected boolean keep

Keep generated files.

encoding

@Parameter(defaultValue="${project.build.sourceEncoding}")
protected String encoding

Specify character encoding used by source files.

pluginDescriptor

@Parameter(defaultValue="${plugin}",
           readonly=true)
protected org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor

Information about this plugin, used to lookup this plugin's dependencies from the currently executing project.

Since:

2.3.1

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession session

The current build session instance. This is used for toolchain manager API calls.

Constructor Detail

MainWsGenMojo

public MainWsGenMojo()

Method Detail

getDestDir

protected File getDestDir()

Either ${build.outputDirectory} or ${build.testOutputDirectory}.

Returns:

the destination directory

getSourceDestDir

protected File getSourceDestDir()

getResourceDestDir

protected File getResourceDestDir()

getDefaultSrcOut

protected File getDefaultSrcOut()

getClassesDir

protected File getClassesDir()

executeJaxws

public void executeJaxws()
                  throws org.apache.maven.plugin.MojoExecutionException,
                         org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

processSei

protected void processSei(String aSei)
                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getMain

protected String getMain()

Main class of the tool to launch when launched as java command.

Returns:

the class name

getToolName

protected String getToolName()

Name of the tool to run when launched as JDK executable from JDK Toolchain.

Returns:

the tool name

getExtraClasspath

protected String getExtraClasspath()

isXnocompile

protected boolean isXnocompile()

Checks if compilation after code generation and let generated sources be compiled by Maven during compilation phase.

Returns:

true if compilation should not be done by the JAX-WS tool

addSourceRoot

protected void addSourceRoot(String sourceDir)

isExtensionOn

protected boolean isExtensionOn()

getCommonArgs

protected List<String> getCommonArgs()
                              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

isArgSupported

protected boolean isArgSupported(String arg)
                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

exec

protected void exec(List<String> arguments)
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

maybeUnsupportedOption

protected void maybeUnsupportedOption(String option,
                                      String value,
                                      List<String> arguments)

getCPasString

protected String getCPasString(Collection<org.apache.maven.artifact.Artifact> artifacts)

addVmArg

protected void addVmArg(String vmArg)