org.jvnet.jax_ws_commons.jaxws.AbstractJaxwsMojo Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2013 Oracle and/or its affiliates. All rights reserved.
*
* Oracle licenses this file to You 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.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2006 Codehaus
*
* 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.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.OverConstrainedVersionException;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.Os;
import org.codehaus.plexus.util.cli.CommandLineException;
import org.codehaus.plexus.util.cli.CommandLineUtils;
import org.codehaus.plexus.util.cli.Commandline;
import org.codehaus.plexus.util.cli.DefaultConsumer;
import org.codehaus.plexus.util.cli.StreamConsumer;
/**
*
* @author dantran
* @version $Id: AbstractJaxwsMojo.java 3240 2007-02-04 07:13:21Z dantran $ *
*/
abstract class AbstractJaxwsMojo extends AbstractMojo {
/**
* The Maven Project Object.
*/
@Parameter(property= "project", readonly=true)
protected MavenProject project;
/**
* Output messages about what the tool is doing.
*/
@Parameter(defaultValue = "false")
protected boolean verbose;
/**
* Keep generated files.
*/
@Parameter(defaultValue = "true")
protected boolean keep;
/**
* Allow to use the JAXWS Vendor Extensions.
*/
@Parameter(defaultValue = "false")
private boolean extension;
/**
* Specify character encoding used by source files.
*/
@Parameter(property = "project.build.sourceEncoding")
protected String encoding;
/**
* Specify optional command-line options.
*
* Multiple elements can be specified, and each token must be placed in its
* own list.
*
*/
@Parameter
private List args;
/**
* Specify optional JVM options.
*
* Multiple elements can be specified, and each token must be placed in its
* own list.
*
*/
@Parameter
private List vmArgs;
/**
* Path to the executable. Should be either wsgen or wsimport but basically
* any script which will understand passed in arguments will work.
*
* @since 2.2.1
*/
@Parameter
private File executable;
/**
* Information about this plugin, used to lookup this plugin's configuration
* from the currently executing project.
*
* @since 2.3.1
*/
@Parameter(defaultValue = "${plugin}", readonly = true)
protected PluginDescriptor pluginDescriptor;
/**
* Logger.
*/
private static final Logger LOG = Logger.getLogger(AbstractJaxwsMojo.class
.getName());
private static final List METRO_22 = new ArrayList();
private static final List METRO_221 = new ArrayList();
private static final List METRO_23 = new ArrayList();
static {
METRO_22.add("-encoding");
METRO_22.add("-clientjar");
METRO_22.add("-generateJWS");
METRO_22.add("-implDestDir");
METRO_22.add("-implServiceName");
METRO_22.add("-implPortName");
METRO_221.addAll(METRO_22);
METRO_221.add("-XdisableAuthenticator");
METRO_23.addAll(METRO_221);
METRO_23.add("-x");
}
protected abstract String getMain();
/**
* Either ${build.outputDirectory} or ${build.testOutputDirectory}.
*/
protected abstract File getDestDir();
protected abstract File getSourceDestDir();
protected void addSourceRoot(String sourceDir) {
if (!project.getCompileSourceRoots().contains(sourceDir)) {
getLog().debug("adding src root: " + sourceDir);
project.addCompileSourceRoot(sourceDir);
} else {
getLog().debug("existing src root: " + sourceDir);
}
}
protected abstract File getDefaultSrcOut();
/**
* Checks if compilation after code generation and let generated sources be
* compiled by maven during compilation phase.
*/
protected abstract boolean isXnocompile();
protected String getExtraClasspath() {
return null;
}
protected boolean isExtensionOn() {
return extension;
}
protected List getCommonArgs() throws MojoExecutionException {
List commonArgs = new ArrayList();
if (!isDefaultSrc(getSourceDestDir()) || keep) {
commonArgs.add("-keep");
commonArgs.add("-s");
commonArgs.add("'" + getSourceDestDir().getAbsolutePath() + "'");
if (!getSourceDestDir().mkdirs() && !getSourceDestDir().exists()) {
getLog().warn(
"Cannot create directory: "
+ getSourceDestDir().getAbsolutePath());
}
addSourceRoot(getSourceDestDir().getAbsolutePath());
}
File destDir = getDestDir();
if (!destDir.mkdirs() && !destDir.exists()) {
getLog().warn(
"Cannot create directory: " + destDir.getAbsolutePath());
}
commonArgs.add("-d");
commonArgs.add("'" + destDir.getAbsolutePath() + "'");
if (verbose) {
commonArgs.add("-verbose");
}
if (isArgSupported("-encoding")) {
if (encoding != null) {
maybeUnsupportedOption("-encoding", encoding, commonArgs);
} else {
getLog().warn(
"Using platform encoding ("
+ System.getProperty("file.encoding")
+ "), build is platform dependent!");
}
}
if (isExtensionOn()) {
commonArgs.add("-extension");
}
if (isXnocompile()) {
commonArgs.add("-Xnocompile");
}
// add additional command line options
if (args != null) {
for (String arg : args) {
commonArgs.add(arg);
}
}
return commonArgs;
}
protected boolean isArgSupported(String arg) throws MojoExecutionException {
// try Metro first
Artifact a = pluginDescriptor.getArtifactMap().get(
"org.glassfish.metro:webservices-tools");
List supportedArgs = null;
String v = null;
try {
if (a != null) {
ArtifactVersion av = a.getSelectedVersion();
v = av.toString();
if (av.getMajorVersion() == 2 && av.getMinorVersion() == 2
&& av.getIncrementalVersion() == 0) {
supportedArgs = METRO_22;
} else if (av.getMajorVersion() == 2
&& av.getMinorVersion() == 2
&& av.getIncrementalVersion() >= 1) {
supportedArgs = METRO_221;
} else { // if (av.getMajorVersion() >= 2 &&
// av.getMinorVersion() >= 3) {
supportedArgs = METRO_23;
}
} else {
// fallback to RI
a = pluginDescriptor.getArtifactMap().get(
"com.sun.xml.ws:jaxws-tools");
ArtifactVersion av = a.getSelectedVersion();
v = av.toString();
if (av.getMajorVersion() == 2 && av.getMinorVersion() == 2
&& av.getIncrementalVersion() == 6) {
supportedArgs = METRO_22;
} else if (av.getMajorVersion() == 2
&& av.getMinorVersion() == 2
&& av.getIncrementalVersion() == 7) {
supportedArgs = METRO_221;
} else { // if (av.getMajorVersion() >= 2 &&
// av.getMinorVersion() >= 2 &&
// av.getIncrementalVersion() >= 8) {
supportedArgs = METRO_23;
}
}
} catch (OverConstrainedVersionException ex) {
throw new MojoExecutionException(ex.getMessage(), ex);
}
boolean isSupported = supportedArgs.contains(arg);
if (!isSupported) {
getLog().warn(
"'" + arg + "' is not supported by " + a.getArtifactId()
+ ":" + v);
}
return isSupported;
}
private boolean isDefaultSrc(File srcout) {
return srcout.equals(getDefaultSrcOut());
}
protected void exec(List args) throws MojoExecutionException {
StreamConsumer sc = new DefaultConsumer();
try {
Commandline cmd = new Commandline();
if (executable != null) {
if (executable.isFile() && executable.canExecute()) {
cmd.setExecutable(executable.getAbsolutePath());
if (getExtraClasspath() != null) {
cmd.createArg().setLine("-cp");
cmd.createArg().setValue(getExtraClasspath());
}
} else {
throw new MojoExecutionException("Cannot execute: "
+ executable.getAbsolutePath());
}
} else {
cmd.setExecutable(new File(new File(System
.getProperty("java.home"), "bin"), getJavaExec())
.getAbsolutePath());
// add additional JVM options
if (vmArgs != null) {
for (String arg : vmArgs) {
cmd.createArg().setLine(arg);
}
}
String[] classpath = getCP();
cmd.createArg().setValue("-Xbootclasspath/p:" + classpath[0]);
cmd.createArg().setValue("-cp");
cmd.createArg().setValue(classpath[2]);
cmd.createArg().setLine(
"org.jvnet.jax_ws_commons.jaxws.Invoker");
cmd.createArg().setLine(getMain());
String extraCp = getExtraClasspath();
String cp = extraCp != null ? extraCp + File.pathSeparator : "";
cp += classpath[1];
try {
File pathFile = createPathFile(cp);
cmd.createArg().setLine(
"-pathfile " + pathFile.getAbsolutePath());
} catch (IOException ioe) {
// creation of temporary file can fail, in such case just
// put everything on cp
cmd.createArg().setValue("-cp");
cmd.createArg().setValue(cp);
}
}
cmd.setWorkingDirectory(project.getBasedir());
for (String arg : args) {
cmd.createArg().setLine(arg);
}
String fullCommand = cmd.toString();
if (isWindows() && 8191 <= fullCommand.length()) {
getLog().warn(
"Length of the command is limitted to 8191 characters but it has "
+ fullCommand.length() + " characters.");
getLog().warn(fullCommand);
} else {
getLog().debug(fullCommand);
}
if (CommandLineUtils.executeCommandLine(cmd, sc, sc) != 0) {
throw new MojoExecutionException("Mojo failed - check output");
}
} catch (CommandLineException t) {
throw new MojoExecutionException(t.getMessage(), t);
}
}
protected void maybeUnsupportedOption(String option, String value,
List args) {
if (executable == null) {
args.add(option);
if (value != null) {
args.add(value);
}
} else {
getLog().warn(
option
+ " may not supported on older JDKs.\n"
+ "Use to bypass this warning if you really want to use it.");
}
}
/**
* This gets the dependencies of the plugin and of the project then sorts
* them into three classpath groups.
*
* [0] endorsed list. This contains a list of endorsed
* dependencies.[1] classes that are not part of the endorsed list.[2] the invoker path.
*
* @return an array of three strings representing the classpath.
*/
private String[] getCP() {
Set endorsedCp = new HashSet();
Map cp = new HashMap();
for (Artifact a : pluginDescriptor.getArtifacts()) {
sortArtifacts(a, cp, endorsedCp);
}
StringBuilder sb = getCPasString(cp.values());
StringBuilder esb = getCPasString(endorsedCp);
//add custom invoker
String invokerPath = AbstractJaxwsMojo.class.getProtectionDomain().getCodeSource().getLocation().toExternalForm();
try {
invokerPath = new URI(invokerPath.substring(5)).getPath();
sb.append(invokerPath);
} catch (URISyntaxException ex) {
throw new RuntimeException(ex);
}
sb.append(File.pathSeparator);
//don't forget tools.jar
File toolsJar = new File(System.getProperty("java.home"), "../lib/tools.jar");
if (!toolsJar.exists()) {
toolsJar = new File(System.getProperty("java.home"), "lib/tools.jar");
}
sb.append(toolsJar.getAbsolutePath());
sb.append(File.pathSeparator);
return new String[]{esb.substring(0, esb.length() - 1), sb.substring(0, sb.length() - 1), invokerPath};
}
private String getJavaExec() {
return isWindows() ? "java.exe" : "java";
}
private File createPathFile(String cp) throws IOException {
File f = File.createTempFile("jax-ws-mvn-plugin-cp", ".txt");
if (f.exists() && f.isFile() && !f.delete()) {
// this should not happen
getLog().warn(
"cannot remove obsolete classpath setting file: "
+ f.getAbsolutePath());
}
Properties p = new Properties();
p.put("cp", cp.replace(File.separatorChar, '/'));
getLog().debug(
"stored classpath: " + cp.replace(File.separatorChar, '/'));
FileOutputStream fos = null;
try {
fos = new FileOutputStream(f);
p.store(fos, null);
} catch (IOException ex) {
LOG.log(Level.SEVERE, null, ex);
} finally {
if (fos != null) {
try {
fos.close();
} catch (IOException ex) {
LOG.log(Level.SEVERE, null, ex);
}
}
}
return f;
}
private boolean isWindows() {
return Os.isFamily(Os.FAMILY_WINDOWS);
}
private StringBuilder getCPasString(Collection artifacts) {
StringBuilder sb = new StringBuilder();
for (Artifact a : artifacts) {
sb.append(a.getFile().getAbsolutePath());
sb.append(File.pathSeparator);
}
return sb;
}
/**
* Places the artifact in either the endorsed classpath set or the normal
* classpath map. It will only add those in "compile" and "runtime" scope
* or those that are specifically endorsed.
*
* @param a
* artifact to sort
* @param cp
* normal classpath map
* @param endorsedCp
* endorsed classpath set
*/
private void sortArtifacts(Artifact a, Map cp,
Set endorsedCp) {
if (isEndorsedArtifact(a)) {
endorsedCp.add(a);
} else if ("compile".equals(a.getScope())
|| "runtime".equals(a.getScope())) {
cp.put(a.getGroupId() + ":" + a.getArtifactId(), a);
}
}
private boolean isEndorsedArtifact(Artifact a) {
if ("jaxws-api".equals(a.getArtifactId())
|| "jaxb-api".equals(a.getArtifactId())
|| "saaj-api".equals(a.getArtifactId())
|| "jsr181-api".equals(a.getArtifactId())
|| "javax.annotation".equals(a.getArtifactId())
|| "javax.annotation-api".equals(a.getArtifactId())
|| "webservices-api".equals(a.getArtifactId())) {
return true;
} else if (a.getArtifactId().startsWith("javax.xml.ws")
|| a.getArtifactId().startsWith("javax.xml.bind")) {
return true;
}
return false;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy