org.jvnet.jax_ws_commons.jaxws.AbstractWsGenMojo Maven / Gradle / Ivy
/*
* Copyright (c) 2012, 2020 Oracle and/or its affiliates. All rights reserved.
* 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.jvnet.jax_ws_commons.jaxws;
import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import jakarta.jws.WebService;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Parameter;
import org.codehaus.plexus.util.FileUtils;
/**
*
*
* @author gnodet
* @author dantran
* @version $Id: WsGenMojo.java 3169 2007-01-22 02:51:29Z dantran $
*/
abstract class AbstractWsGenMojo extends AbstractJaxwsMojo {
/**
* Specify that a WSDL file should be generated in ${resourceDestDir}.
*/
@Parameter(defaultValue = "false")
protected boolean genWsdl;
/**
* Service endpoint implementation class name.
*/
@Parameter
private String sei;
/**
* Used in conjunction with genWsdl to specify the protocol to use in the
* wsdl:binding. Valid values are "soap1.1" or "Xsoap1.2",
* default is "soap1.1". "Xsoap1.2" is not standard
* and can only be used in conjunction with the extension option.
*/
@Parameter
private String protocol;
/**
* Specify the Service name to use in the generated WSDL.
* Used in conjunction with the genWsdl option.
*/
@Parameter
private String servicename;
/**
* Specify the Port name to use in the generated WSDL.
* Used in conjunction with the genWsdl option.
*/
@Parameter
private String portname;
/**
* Inline schemas in the generated WSDL.
* Used in conjunction with the genWsdl option.
*/
@Parameter(defaultValue = "false")
private boolean inlineSchemas;
/**
* Turn off compilation after code generation and let generated sources be
* compiled by maven during compilation phase; keep is turned on with this option.
*/
@Parameter(defaultValue = "false")
private boolean xnocompile;
/**
*/
@Parameter(defaultValue = "false")
private boolean xdonotoverwrite;
/**
* Metadata file for wsgen. See the JAX-WS Guide
* for the description of this feature.
* Unmatched files will be ignored.
*
* @since 2.3
* @see External Web Service Metadata
*/
@Parameter
private File metadata;
protected abstract File getResourceDestDir();
protected abstract File getClassesDir();
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
Set seis = new HashSet();
if (sei != null) {
seis.add(sei);
} else {
//find all SEIs within current classes
seis.addAll(getSEIs(getClassesDir()));
}
if (seis.isEmpty()) {
throw new MojoFailureException("No @jakarta.jws.WebService found.");
}
for (String aSei : seis) {
processSei(aSei);
}
}
protected void processSei(String sei) throws MojoExecutionException {
getLog().info("Processing: " + sei);
ArrayList args = getWsGenArgs(sei);
getLog().info("jaxws:wsgen args: " + args);
exec(args);
if (metadata != null) {
try {
FileUtils.copyFileToDirectory(metadata, getClassesDir());
} catch (IOException ioe) {
throw new MojoExecutionException(ioe.getMessage(), ioe);
}
}
}
@Override
protected String getMain() {
return "com.sun.tools.ws.wscompile.WsgenTool";
}
@Override
@SuppressWarnings("unchecked")
protected String getExtraClasspath() {
StringBuilder buf = new StringBuilder();
buf.append(getClassesDir().getAbsolutePath());
for (Artifact a : (Set)project.getArtifacts()) {
buf.append(File.pathSeparatorChar);
buf.append(a.getFile().getAbsolutePath());
}
return buf.toString();
}
@Override
protected boolean getXnocompile() {
return xnocompile;
}
/**
* Construct wsgen arguments
* @return a list of arguments
* @throws MojoExecutionException
*/
private ArrayList getWsGenArgs(String aSei) throws MojoExecutionException {
ArrayList args = new ArrayList();
args.addAll(getCommonArgs());
if (this.genWsdl) {
if (this.protocol != null) {
args.add("-wsdl:" + this.protocol);
} else {
args.add("-wsdl");
}
if (inlineSchemas) {
maybeUnsupportedOption("-inlineSchemas", null, args);
}
if (servicename != null) {
args.add("-servicename");
args.add(servicename);
}
if (portname != null) {
args.add("-portname");
args.add(portname);
}
File resourceDir = getResourceDestDir();
if (!resourceDir.mkdirs() && !resourceDir.exists()) {
getLog().warn("Cannot create directory: " + resourceDir.getAbsolutePath());
}
args.add("-r");
args.add("'" + resourceDir.getAbsolutePath() + "'");
if (!"war".equals(project.getPackaging())) {
Resource r = new Resource();
r.setDirectory(getRelativePath(project.getBasedir(), getResourceDestDir()));
project.addResource(r);
}
}
if (xdonotoverwrite) {
args.add("-Xdonotoverwrite");
}
if (metadata != null && isArgSupported("-x")) {
maybeUnsupportedOption("-x", "'" + metadata.getAbsolutePath() + "'", args);
}
args.add(aSei);
getLog().debug("jaxws:wsgen args: " + args);
return args;
}
private String getRelativePath(File root, File f) {
return root.toURI().relativize(f.toURI()).getPath();
}
private Set getSEIs(File directory) throws MojoExecutionException {
Set seis = new HashSet();
if (!directory.exists() || directory.isFile()) {
return seis;
}
ClassLoader cl = null;
try {
cl = new URLClassLoader(new URL[]{ directory.toURI().toURL()}, getClass().getClassLoader());
for (String s : FileUtils.getFileAndDirectoryNames(directory, "**/*.class", null, false, true, true, false)) {
try {
String clsName = s.replace(File.separator, ".");
Class c = cl.loadClass(clsName.substring(0, clsName.length() - 6));
if (!c.isInterface() && c.isAnnotationPresent(WebService.class)) {
//more sophisticated checks are done by wsgen itself
seis.add(c.getName());
}
} catch (ClassNotFoundException ex) {
throw new MojoExecutionException(ex.getMessage(), ex);
}
}
} catch (IOException ex) {
throw new MojoExecutionException(ex.getMessage(), ex);
} finally {
if (cl != null && cl instanceof Closeable) {
try {
((Closeable) cl).close();
} catch (IOException ex) {
//ignore
}
}
}
return seis;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy