org.codehaus.mojo.jaxws

Class MainWsImportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.jaxws.MainWsImportMojo

All Implemented Interfaces:

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

@Mojo(name="wsimport",
      defaultPhase=GENERATE_SOURCES,
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class MainWsImportMojo
extends org.apache.maven.plugin.AbstractMojo

Parses wsdl and binding files and generates Java code needed to access it.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
protected File	bindingDirectory Directory containing binding files.
protected List<String>	bindingFiles List of files to use for bindings.
protected String	encoding Specify character encoding used by source files.
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.
protected List<String>	wsdlFiles List of files to use for WSDLs.
protected File	xauthFile Specify the location of authorization file.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
MainWsImportMojo()

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()
File[]	getBindingFiles() Returns a file array of xml files to translate to object models.
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 File	getImplDestDir()
protected String	getMain() Main class of the tool to launch when launched as java command.
protected File	getSourceDestDir()
protected String	getToolName() Name of the tool to run when launched as JDK executable from JDK Toolchain.
protected List<String>	getWSDLFileLookupClasspathElements() Returns the dependencies that should be placed on the classpath for the classloader to lookup wsdl files.
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)

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

wsdlFiles

@Parameter
protected List<String> wsdlFiles

List of files to use for WSDLs. If not specified, all .wsdl files in the wsdlDirectory will be used.

bindingDirectory

@Parameter(defaultValue="${project.basedir}/src/jaxws")
protected File bindingDirectory

Directory containing binding files.

bindingFiles

@Parameter
protected List<String> bindingFiles

List of files to use for bindings. If not specified, all .xml files in the bindingDirectory will be used.

xauthFile

@Parameter
protected File xauthFile

Specify the location of authorization file.

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

MainWsImportMojo

public MainWsImportMojo()

Method Detail

getDestDir

protected File getDestDir()

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

Returns:

the destination directory

getSourceDestDir

protected File getSourceDestDir()

getDefaultSrcOut

protected File getDefaultSrcOut()

getImplDestDir

protected File getImplDestDir()

getWSDLFileLookupClasspathElements

protected List<String> getWSDLFileLookupClasspathElements()

Returns the dependencies that should be placed on the classpath for the classloader to lookup wsdl files.

executeJaxws

public void executeJaxws()
                  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

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

getBindingFiles

public final File[] getBindingFiles()

Returns a file array of xml files to translate to object models.

Returns:

An array of schema files to be parsed by the schema compiler.

addSourceRoot

protected void addSourceRoot(String sourceDir)

getExtraClasspath

protected String getExtraClasspath()

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)