org.codehaus.mojo.jaxws.WsImportMojo Maven / Gradle / Ivy
/*
* Copyright 2006 Guillaume Nodet.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.codehaus.mojo.jaxws;
import com.sun.tools.ws.Invoker;
import org.apache.maven.plugin.MojoExecutionException;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
/**
*
* @author gnodet
* @author dantran
* @version $Id: WsImportMojo.java 3169 2007-01-22 02:51:29Z dantran $
*/
abstract class WsImportMojo extends AbstractJaxwsMojo
{
/**
* The package in which the source files will be generated.
*
* @parameter
*/
private String packageName;
/**
* Catalog file to resolve external entity references support TR9401,
* XCatalog, and OASIS XML Catalog format.
*
* @parameter
*/
private File catalog;
/**
* Set HTTP/HTTPS proxy. Format is [user[:password]@]proxyHost[:proxyPort]
*
* @parameter
*/
private String httpproxy;
/**
* Directory containing wsdl files.
*
* @parameter default-value="${basedir}/src/wsdl"
*/
private File wsdlDirectory;
/**
* List of files to use for wsdls. If not specified, all .wsdl files
* in the wsdlDirectory will be used.
*
* @parameter
*/
protected List wsdlFiles;
/**
* List of external wsdl urls to be compiled.
*
* @parameter
*/
private List wsdlUrls;
/**
* Directory containing binding files.
*
* @parameter default-value="${basedir}/src/jaxws"
*/
protected File bindingDirectory;
/**
* List of files to use for bindings.If not specified, all .xml files
* in the bindingDirectory will be used.
*
* @parameter
*/
protected List bindingFiles;
/**
* @WebService.wsdlLocation and
* @WebServiceClient.wsdlLocation value.
*
* @parameter
*/
private String wsdlLocation;
/**
* Generate code as per the given JAXWS specification version.
* Setting "2.0" will cause JAX-WS to generate artifacts
* that run with JAX-WS 2.0 runtime.
*
* @parameter
*/
private String target;
/**
* Specify where to place generated source files, keep is turned on with this option.
*
* @parameter default-value="${project.build.directory}/jaxws/wsimport/java"
*/
protected File sourceDestDir;
/**
* Maps headers not bound to the request or response messages to Java method params.
*
* @parameter default-value="false"
*/
private Boolean xadditionalHeaders;
/**
* Turn on debug message
*
* @parameter default-value="false"
*/
private boolean xdebug;
/**
* Turn of compilation after code generation
*
* Always true with maven plugin and the generated classes get compiled during maven compilation phase.
*
*/
private final boolean xnocompile = true;
/**
* Binding W3C EndpointReferenceType to Java. By default Wsimport follows spec and does not bind
* EndpointReferenceType to Java and uses the spec provided {@link javax.xml.ws.wsaddressing.W3CEndpointReference}
*
* @parameter default-value="false"
*/
private boolean xnoAddressingDataBinding;
/**
* Specify the location of authorization file.
*
* @parameter
*/
protected File xauthFile;
/**
* Specify optional XJC-specific parameters that should simply be passed to xjc
* using -B option of WsImport command.
*
* Multiple elements can be specified, and each token must be placed in its own list.
*
* @parameter
*/
private List xjcArgs;
/**
* Specify optional wsimport commnd-line options.
*
* Multiple elements can be specified, and each token must be placed in its own list.
*
* @parameter
*/
private List args;
/**
* The location of the flag file used to determine if the output is stale.
* @parameter default-value="${project.build.directory}/jaxws/stale/.staleFlag"
*/
private File staleFile;
public void execute()
throws MojoExecutionException
{
// Need to build a URLClassloader since Maven removed it form the chain
ClassLoader parent = this.getClass().getClassLoader();
String originalSystemClasspath = this.initClassLoader( parent );
try
{
sourceDestDir.mkdirs();
getDestDir().mkdirs();
File[] wsdls = getWSDLFiles();
if(wsdls.length == 0 && (wsdlUrls == null || wsdlUrls.size() ==0)){
getLog().info( "No WSDLs are found to process, Specify atleast one of the following parameters: wsdlFiles, wsdlDirectory or wsdlUrls.");
return;
}
this.processWsdlViaUrls();
this.processLocalWsdlFiles(wsdls);
// even thou the generated source already compiled, we still want to
// add the source path so that IDE can pick it up
project.addCompileSourceRoot( sourceDestDir.getAbsolutePath() );
}
catch ( MojoExecutionException e )
{
throw e;
}
catch ( Exception e )
{
throw new MojoExecutionException( e.getMessage(), e );
}
finally
{
// Set back the old classloader
Thread.currentThread().setContextClassLoader( parent );
System.setProperty( "java.class.path", originalSystemClasspath );
}
}
/**
*
* @throws MojoExecutionException
* @throws IOException
*/
private void processLocalWsdlFiles(File[] wsdls)
throws MojoExecutionException, IOException
{
if ( isOutputStale() )
{
for (File wsdl : wsdls) {
getLog().info("Processing: " + wsdl.getAbsolutePath());
ArrayList args = getWsImportArgs();
args.add(wsdl.getAbsolutePath());
getLog().info("jaxws:wsimport args: " + args);
wsImport(args);
}
touchStaleFile();
}
}
/**
* process external wsdl
* @throws MojoExecutionException
*/
private void processWsdlViaUrls()
throws MojoExecutionException
{
//TODO can we do some stale check against a URL?
for ( int i = 0; wsdlUrls != null && i < wsdlUrls.size(); i++ )
{
String wsdlUrl = wsdlUrls.get( i ).toString();
getLog().info( "Processing: " + wsdlUrl );
ArrayList args = getWsImportArgs();
args.add( wsdlUrl );
getLog().info( "jaxws:wsimport args: " + args );
wsImport( args );
}
}
/**
* Invoke wsimport compiler
* @param args
* @throws MojoExecutionException
*/
private void wsImport( ArrayList args )
throws MojoExecutionException
{
try {
final ClassLoader cl = Invoker.createClassLoader(Thread.currentThread().getContextClassLoader());
Class c = cl.loadClass("com.sun.tools.ws.wscompile.WsimportTool");
Object tool = c.getConstructor(OutputStream.class).newInstance(System.out);
String[] ar = args.toArray( new String[args.size()] );
Boolean result = (Boolean)c.getMethod("run", ar.getClass()).invoke(tool, new Object[]{ar});
if ( !result )
{
throw new MojoExecutionException( "Error executing: wsimport " + args );
}
} catch (Exception e) {
throw new MojoExecutionException( "Error executing: wsimport " + args );
}
}
/**
*
* @return wsimport's command arguments
* @throws MojoExecutionException
*/
private ArrayList getWsImportArgs()
throws MojoExecutionException
{
ArrayList args = new ArrayList();
args.add( "-s" );
args.add( sourceDestDir.getAbsolutePath() );
args.add( "-d" );
args.add( getDestDir().getAbsolutePath() );
if ( verbose )
{
args.add( "-verbose" );
}
if ( httpproxy != null )
{
args.add( "-httpproxy" );
args.add( httpproxy );
}
if ( packageName != null )
{
args.add( "-p" );
args.add( packageName );
}
if ( catalog != null )
{
args.add( "-catalog" );
args.add( catalog.getAbsolutePath() );
}
if ( wsdlLocation != null )
{
args.add( "-wsdllocation" );
args.add( wsdlLocation );
}
if ( target != null )
{
args.add( "-target" );
args.add( target );
}
if ( extension )
{
args.add( "-extension" );
}
if(xdebug){
args.add("-Xdebug");
}
if(xnocompile){
args.add("-Xnocompile");
}
/**
* -Xno-addressing-databinding enable binding of W3C EndpointReferenceType to Java
*/
if(xnoAddressingDataBinding){
args.add("-Xno-addressing-databinding");
}
if(xadditionalHeaders){
args.add("-XadditionalHeaders");
}
if(xauthFile != null){
args.add("-Xauthfile");
args.add(xauthFile.getAbsolutePath());
}
// add wsimport commandline Options
if (this.args != null)
{
for (String arg : this.args) {
args.add(arg);
}
}
// xjcOIptions
if (xjcArgs != null)
{
for (String xjcArg : xjcArgs) {
if (xjcArg.startsWith("-"))
args.add("-B" + xjcArg);
else
args.add(xjcArg);
}
}
// Bindings
for (File binding : getBindingFiles()) {
args.add("-b");
args.add(binding.getAbsolutePath());
}
getLog().debug( "jaxws:wsimport args: " + args );
return args;
}
/**
* Returns a file array of xml files to translate to object models.
*
* @return An array of schema files to be parsed by the schema compiler.
*/
public final File[] getBindingFiles()
{
File [] bindings;
if ( bindingFiles != null )
{
bindings = new File[bindingFiles.size()];
for ( int i = 0 ; i < bindingFiles.size(); ++i )
{
String schemaName = (String) bindingFiles.get( i );
File file = new File( schemaName );
if (!file.isAbsolute()) {
file = new File( bindingDirectory, schemaName );
}
bindings[i] = file;
}
}
else
{
getLog().debug( "The binding Directory is " + bindingDirectory );
bindings = bindingDirectory.listFiles( new XMLFile() );
if ( bindings == null )
{
bindings = new File[0];
}
}
return bindings;
}
/**
* Returns a file array of wsdl files to translate to object models.
*
* @return An array of schema files to be parsed by the schema compiler.
*/
public final File[] getWSDLFiles()
{
File [] files;
if ( wsdlFiles != null )
{
files = new File[ wsdlFiles.size() ];
for ( int i = 0 ; i < wsdlFiles.size(); ++i )
{
String schemaName = (String) wsdlFiles.get( i );
getLog().debug( "The wsdl File is " + schemaName);
files[i] = new File( wsdlDirectory, schemaName ) ;
}
}
else
{
getLog().debug( "The wsdl Directory is " + wsdlDirectory );
files = wsdlDirectory.listFiles( new WSDLFile() );
if ( files == null )
{
files = new File[0];
}
}
return files;
}
/**
* A class used to look up .xml documents from a given directory.
*/
private final class XMLFile
implements FileFilter
{
/**
* Returns true if the file ends with an xml extension.
*
* @param file
* The filed being reviewed by the filter.
* @return true if an xml file.
*/
public boolean accept( final java.io.File file )
{
return file.getName().endsWith( ".xml" );
}
}
/**
* A class used to look up .wsdl documents from a given directory.
*/
private final class WSDLFile
implements FileFilter
{
/**
* Returns true if the file ends with a wsdl extension.
*
* @param file
* The filed being reviewed by the filter.
* @return true if an wsdl file.
*/
public boolean accept( final java.io.File file )
{
return file.getName().endsWith( ".wsdl" );
}
}
/**
* Returns true of any one of the files in the WSDL/XJB array are more new than the staleFlag file.
*
* @return True if wsdl files have been modified since the last build.
*/
private boolean isOutputStale()
{
File[] sourceWsdls = getWSDLFiles();
File[] sourceBindings = getBindingFiles();
boolean stale = !staleFile.exists();
if ( !stale )
{
getLog().debug( "Stale flag file exists, comparing to wsdls and bindings." );
long staleMod = staleFile.lastModified();
for (File sourceWsdl : sourceWsdls) {
if (sourceWsdl.lastModified() > staleMod) {
getLog().debug(sourceWsdl.getName() + " is newer than the stale flag file.");
stale = true;
}
}
for (File sourceBinding : sourceBindings) {
if (sourceBinding.lastModified() > staleMod) {
getLog().debug(sourceBinding.getName() + " is newer than the stale flag file.");
stale = true;
}
}
}
return stale;
}
private void touchStaleFile()
throws IOException
{
if ( !staleFile.exists() )
{
staleFile.getParentFile().mkdirs();
staleFile.createNewFile();
getLog().debug( "Stale flag file created." );
}
else
{
staleFile.setLastModified( System.currentTimeMillis() );
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy