Package org.jvnet.jaxb2.maven2

Class RawXJCMojo<O,XSA extends Annotation,XNA extends Annotation>

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jvnet.jaxb2.maven2.AbstractXJCMojo<O>

org.jvnet.jaxb2.maven2.RawXJCMojo<O,XSA,XNA>

Type Parameters:

O - type

XSA - XML Schema Annotation type

XNA - XML Namespace Annotation type

All Implemented Interfaces:

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

Direct Known Subclasses:

RawXJC2Mojo, RawXJC3Mojo

public abstract class RawXJCMojo<O,XSA extends Annotation,XNA extends Annotation>
extends AbstractXJCMojo<O>

Abstract Maven JAXB Mojo.

Author:

Aleksei Valikov (valikov@gmx.net), Adam Retter (adam@evolvedbinary.com)

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADD_IF_EXISTS_TO_EPISODE_SCHEMA_BINDINGS_TRANSFORMATION_RESOURCE_NAME

Fields inherited from class org.jvnet.jaxb2.maven2.AbstractXJCMojo

m_catalogResolver, plugins

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

ROLE

Constructor Summary

Constructors

Constructor	Description
RawXJCMojo()

Method Summary

Modifier and Type	Method	Description
protected List<URI>	createBindingURIs()
protected CatalogResolver	createCatalogResolver()	Creates an instance of catalog resolver.
protected ClassLoader	createClassLoader(ClassLoader parent)
protected EntityResolver	createEntityResolver(CatalogResolver catalogResolver)
OptionsConfiguration	createOptionsConfiguration()
protected List<URI>	createProducesURIs()
protected void	doExecute()
abstract void	doExecute(O options)
void	execute()	Execute the maven2 mojo to invoke the xjc2 compiler based on any configuration settings.
protected String	getActiveProxyAsHttpproxy()
protected List<String>	getArguments()	Returns array of command line arguments for XJC.
protected List<InputSource>	getBindFiles()
List<File>	getBindingFiles()
protected List<URI>	getBindingURIs()
protected abstract String	getBindPackageInfoClassName()
protected CatalogResolver	getCatalogResolverInstance()
protected List<URI>	getCatalogURIs()
protected String	getCustomHttpproxy()
List<URI>	getDependsURIs()
protected EntityResolver	getEntityResolver()
Collection<org.apache.maven.artifact.Artifact>	getEpisodeArtifacts()
Collection<File>	getEpisodeFiles()
protected abstract String	getEpisodePackageInfoClassName()
protected List<InputSource>	getGrammars()
protected String	getHttpproxy()
protected abstract String	getJaxbNamespaceUri()
List<URI>	getProducesURIs()
protected List<URI>	getResolvedBindingURIs()
protected List<URI>	getResolvedCatalogURIs()
protected List<URI>	getResolvedSchemaURIs()
List<File>	getSchemaFiles()
protected List<URI>	getSchemaURIs()
protected URILastModifiedResolver	getURILastModifiedResolver()
Collection<org.apache.maven.artifact.Artifact>	getXjcPluginArtifacts()
Collection<File>	getXjcPluginFiles()
List<URL>	getXjcPluginURLs()
protected abstract Class<XNA>	getXmlNamespaceAnnotationClass()
protected abstract String	getXmlNamespaceAnnotationValue(XNA xmlValueAnnotation)
protected abstract Class<XSA>	getXmlSchemaAnnotationClass()
protected abstract String	getXmlSchemaAnnotationNamespace(XSA xmlSchemaAnnotation)
protected void	injectDependencyDefaults()	************************************************************************* *
protected void	injectDependencyDefaults(org.apache.maven.model.Dependency[] dependencies)
protected boolean	isUpToDate()
protected void	logConfiguration()	Log the configuration settings.
protected void	resolveArtifacts()
protected void	resolveEpisodeArtifacts()
protected void	resolveXJCPluginArtifacts()
protected void	setupBindingFiles()
protected void	setupDependsURIs()
protected void	setupDirectories()
protected void	setupLogging()	Initializes logging.
protected void	setupMavenPaths()	Augments Maven paths with generated resources.
protected void	setupSchemaFiles()

Methods inherited from class org.jvnet.jaxb2.maven2.AbstractXJCMojo

cleanPackageDirectory, createCatalogURIs, createResourceEntryUris, getAccessExternalDTD, getAccessExternalSchema, getAddCompileSourceRoot, getAddTestCompileSourceRoot, getArgs, getArtifactFactory, getArtifactMetadataSource, getArtifactResolver, getBindingDirectory, getBindingExcludes, getBindingIncludes, getBindings, getBuildContext, getCatalog, getCatalogDirectory, getCatalogExcludes, getCatalogIncludes, getCatalogResolver, getCatalogs, getCleanPackageDirectories, getContentForWildcard, getDebug, getDisableDefaultExcludes, getDisableXmlSecurity, getEnableIntrospection, getEncoding, getEpisode, getEpisodeFile, getEpisodes, getExtension, getForceRegenerate, getGenerateDirectory, getGeneratePackage, getLocale, getLocalRepository, getMarkGenerated, getMavenProjectBuilder, getNoFileHeader, getOptionsFactory, getOtherDependsExcludes, getOtherDependsIncludes, getPackageLevelAnnotations, getPluginArtifacts, getPlugins, getProduces, getProject, getProjectDependencies, getProxyHost, getProxyPassword, getProxyPort, getProxyUsername, getReadOnly, getRemoveOldOutput, getScanDependenciesForBindings, getSchemaDirectory, getSchemaExcludes, getSchemaIncludes, getSchemaLanguage, getSchemas, getSettings, getSpecVersion, getStrict, getUseDependenciesAsEpisodes, getVerbose, getWriteCode, isAddIfExistsToEpisodeSchemaBindings, isEnableExternalEntityProcessing, isUseActiveProxyAsHttpproxy, logApiConfiguration, resolveDependencyResource, setAccessExternalDTD, setAccessExternalSchema, setAddCompileSourceRoot, setAddIfExistsToEpisodeSchemaBindings, setAddTestCompileSourceRoot, setArgs, setArtifactFactory, setArtifactMetadataSource, setArtifactResolver, setBindingDirectory, setBindingExcludes, setBindingIncludes, setBindings, setBuildContext, setCatalog, setCatalogDirectory, setCatalogExcludes, setCatalogIncludes, setCatalogResolver, setCatalogs, setCleanPackageDirectories, setContentForWildcard, setDebug, setDisableDefaultExcludes, setDisableXmlSecurity, setEnableExternalEntityProcessing, setEnableIntrospection, setEncoding, setEpisode, setEpisodeFile, setEpisodes, setExtension, setForceRegenerate, setGenerateDirectory, setGeneratePackage, setLocale, setLocalRepository, setMarkGenerated, setMavenProjectBuilder, setNoFileHeader, setOtherDependsExcludes, setOtherDependsIncludes, setPackageLevelAnnotations, setPluginArtifacts, setPlugins, setProduces, setProject, setProxyHost, setProxyPassword, setProxyPort, setProxyUsername, setReadOnly, setRemoveOldOutput, setScanDependenciesForBindings, setSchemaDirectory, setSchemaExcludes, setSchemaIncludes, setSchemaLanguage, setSchemas, setSettings, setSpecVersion, setStrict, setUseActiveProxyAsHttpproxy, setUseDependenciesAsEpisodes, setVerbose, setWriteCode

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

ADD_IF_EXISTS_TO_EPISODE_SCHEMA_BINDINGS_TRANSFORMATION_RESOURCE_NAME

public static final String ADD_IF_EXISTS_TO_EPISODE_SCHEMA_BINDINGS_TRANSFORMATION_RESOURCE_NAME

Constructor Detail

RawXJCMojo

public RawXJCMojo()

Method Detail

getXjcPluginArtifacts

public Collection<org.apache.maven.artifact.Artifact> getXjcPluginArtifacts()

getXjcPluginFiles

public Collection<File> getXjcPluginFiles()

getXjcPluginURLs

public List<URL> getXjcPluginURLs()

getEpisodeArtifacts

public Collection<org.apache.maven.artifact.Artifact> getEpisodeArtifacts()

getEpisodeFiles

public Collection<File> getEpisodeFiles()

getSchemaFiles

public List<File> getSchemaFiles()

getSchemaURIs

protected List<URI> getSchemaURIs()

getResolvedSchemaURIs

protected List<URI> getResolvedSchemaURIs()

getGrammars

protected List<InputSource> getGrammars()

getBindingFiles

public List<File> getBindingFiles()

getBindingURIs

protected List<URI> getBindingURIs()

getResolvedBindingURIs

protected List<URI> getResolvedBindingURIs()

getBindFiles

protected List<InputSource> getBindFiles()

createBindingURIs

protected List<URI> createBindingURIs()
                               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getDependsURIs

public List<URI> getDependsURIs()

getProducesURIs

public List<URI> getProducesURIs()

execute

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

Execute the maven2 mojo to invoke the xjc2 compiler based on any configuration settings.

Throws:

org.apache.maven.plugin.MojoExecutionException

injectDependencyDefaults

protected void injectDependencyDefaults()

************************************************************************* *

injectDependencyDefaults

protected void injectDependencyDefaults(org.apache.maven.model.Dependency[] dependencies)

resolveArtifacts

protected void resolveArtifacts()
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

resolveXJCPluginArtifacts

protected void resolveXJCPluginArtifacts()
                                  throws org.apache.maven.artifact.resolver.ArtifactResolutionException,
                                         org.apache.maven.artifact.resolver.ArtifactNotFoundException,
                                         org.apache.maven.project.artifact.InvalidDependencyVersionException

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException

org.apache.maven.artifact.resolver.ArtifactNotFoundException

org.apache.maven.project.artifact.InvalidDependencyVersionException

resolveEpisodeArtifacts

protected void resolveEpisodeArtifacts()
                                throws org.apache.maven.artifact.resolver.ArtifactResolutionException,
                                       org.apache.maven.artifact.resolver.ArtifactNotFoundException,
                                       org.apache.maven.project.artifact.InvalidDependencyVersionException

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException

org.apache.maven.artifact.resolver.ArtifactNotFoundException

org.apache.maven.project.artifact.InvalidDependencyVersionException

createClassLoader

protected ClassLoader createClassLoader(ClassLoader parent)

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getJaxbNamespaceUri

protected abstract String getJaxbNamespaceUri()

getBindPackageInfoClassName

protected abstract String getBindPackageInfoClassName()

getXmlSchemaAnnotationClass

protected abstract Class<XSA> getXmlSchemaAnnotationClass()

getXmlSchemaAnnotationNamespace

protected abstract String getXmlSchemaAnnotationNamespace(XSA xmlSchemaAnnotation)

getXmlNamespaceAnnotationClass

protected abstract Class<XNA> getXmlNamespaceAnnotationClass()

getXmlNamespaceAnnotationValue

protected abstract String getXmlNamespaceAnnotationValue(XNA xmlValueAnnotation)

getEpisodePackageInfoClassName

protected abstract String getEpisodePackageInfoClassName()

getURILastModifiedResolver

protected URILastModifiedResolver getURILastModifiedResolver()

doExecute

public abstract void doExecute(O options)
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

setupLogging

protected void setupLogging()

Initializes logging. If Maven is run in debug mode (that is, debug level is enabled in the log), turn on the verbose mode in Mojo. Further on, if vebose mode is on, set the com.sun.tools.xjc.Options.findServices system property on to enable debuggin of XJC plugins.

setupMavenPaths

protected void setupMavenPaths()

Augments Maven paths with generated resources.

setupDirectories

protected void setupDirectories()

setupSchemaFiles

protected void setupSchemaFiles()
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

setupBindingFiles

protected void setupBindingFiles()
                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

setupDependsURIs

protected void setupDependsURIs()
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createProducesURIs

protected List<URI> createProducesURIs()
                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

logConfiguration

protected void logConfiguration()

Log the configuration settings. Shown when exception thrown or when verbose is true.

Overrides:

logConfiguration in class AbstractXJCMojo<O>

getCatalogURIs

protected final List<URI> getCatalogURIs()

getResolvedCatalogURIs

protected final List<URI> getResolvedCatalogURIs()

getCatalogResolverInstance

protected final CatalogResolver getCatalogResolverInstance()

getEntityResolver

protected final EntityResolver getEntityResolver()

createEntityResolver

protected final EntityResolver createEntityResolver(CatalogResolver catalogResolver)

createCatalogResolver

protected final CatalogResolver createCatalogResolver()
                                               throws org.apache.maven.plugin.MojoExecutionException

Creates an instance of catalog resolver.

Returns:

Instance of the catalog resolver.

Throws:

org.apache.maven.plugin.MojoExecutionException - If catalog resolver cannot be instantiated.

isUpToDate

protected boolean isUpToDate()

Returns:

true to indicate results are up-to-date, that is, when the latest from input files is earlier than the younger from the output files (meaning no re-execution required).

getCustomHttpproxy

protected String getCustomHttpproxy()

getActiveProxyAsHttpproxy

protected String getActiveProxyAsHttpproxy()

getArguments

protected List<String> getArguments()

Returns array of command line arguments for XJC. These arguments are based on the configured arguments (see AbstractXJCMojo.getArgs()) but also include episode arguments.

Returns:

String array of XJC command line options.

getHttpproxy

protected String getHttpproxy()

createOptionsConfiguration

public OptionsConfiguration createOptionsConfiguration()