org.codehaus.mojo.gwt.shell

Class AbstractGwtShellMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.gwt.AbstractGwtMojo

org.codehaus.mojo.gwt.AbstractGwtModuleMojo

org.codehaus.mojo.gwt.shell.AbstractGwtShellMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractGwtWebMojo, AbstractThemeMojo, CompileMojo, CSSMojo, I18NMojo, SuperDevModeMojo, TestMojo, UpdateWidgetsetMojo

public abstract class AbstractGwtShellMojo
extends AbstractGwtModuleMojo

Support running GWT SDK Tools as forked JVM with classpath set according to project source/resource directories and dependencies.

Version:

$Id$

Author:

ccollins, cooper, willpugh

Field Summary

Fields

Modifier and Type	Field and Description
protected String	widgetsetMode The widgetset compilation mode (local / fetch from CDN / CDN only).

Fields inherited from class org.codehaus.mojo.gwt.AbstractGwtMojo

artifactFactory, artifactMetadataSource, classpathBuilder, GWT_GROUP_ID, gwtSdkFirstInClasspath, localRepository, modulePathPrefix, remoteRepositories, resolver, VAADIN_GROUP_ID, warSourceDirectory

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGwtShellMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addArgumentDeploy(JavaCommand cmd)
protected void	addArgumentGen(JavaCommand cmd)
protected void	addCompileSourceArtifacts(JavaCommand cmd) Add sources.jar artifacts for project dependencies listed as compileSourcesArtifacts.
protected void	addPersistentUnitCache(JavaCommand cmd)
protected JavaCommand	createJavaCommand()
protected com.vaadin.wscdn.client.WidgetSetRequest	createWidgetsetRequest() Create a CDN widgetset compilation request.
abstract void	doExecute()
void	execute()
protected String	getExtraJvmArgs()
protected String	getJvm()
protected String	getLogLevel()
protected String	getStyle()
protected void	postProcessClassPath(Collection<File> classpath) hook to post-process the dependency-based classpath
void	setTimeOut(int timeOut)

Methods inherited from class org.codehaus.mojo.gwt.AbstractGwtModuleMojo

getGwtModules, getModules, readModule

Methods inherited from class org.codehaus.mojo.gwt.AbstractGwtMojo

addClasspathElements, addCompileSourceRoot, getArtifact, getClasspath, getGenerateDirectory, getGwtDevJar, getGwtUserJar, getJarAndDependencies, getLocalRepository, getOutputDirectory, getProject, getProjectArtifacts, getProjectRuntimeArtifacts, getRemoteRepositories, isGenerator, resolve, setupGenerateDirectory

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

widgetsetMode

@Parameter(defaultValue="local",
           property="vaadin.widgetset.mode")
protected String widgetsetMode

The widgetset compilation mode (local / fetch from CDN / CDN only). The allowed values are "local", "fetch" and "cdn".

Can be set from command line using '-Dvaadin.widgetset.mode=...'

Constructor Detail

AbstractGwtShellMojo

public AbstractGwtShellMojo()

Method Detail

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

See Also:

Mojo.execute()

doExecute

public abstract void doExecute()
                        throws org.apache.maven.plugin.MojoExecutionException,
                               org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getExtraJvmArgs

protected String getExtraJvmArgs()

getLogLevel

protected String getLogLevel()

getStyle

protected String getStyle()

getJvm

protected String getJvm()

postProcessClassPath

protected void postProcessClassPath(Collection<File> classpath)

hook to post-process the dependency-based classpath

setTimeOut

public void setTimeOut(int timeOut)

Parameters:

timeOut - the timeOut to set

createJavaCommand

protected JavaCommand createJavaCommand()

addCompileSourceArtifacts

protected void addCompileSourceArtifacts(JavaCommand cmd)
                                  throws org.apache.maven.plugin.MojoExecutionException

Add sources.jar artifacts for project dependencies listed as compileSourcesArtifacts. This is a GWT hack to avoid packaging java source files into JAR when sharing code between server and client. Typically, some domain model classes or business rules may be packaged as a separate Maven module. With GWT packaging this requires to distribute such classes with code, that may not be desirable.

The hack can also be used to include utility code from external librariries that may not have been designed for GWT.

Throws:

org.apache.maven.plugin.MojoExecutionException

addArgumentDeploy

protected void addArgumentDeploy(JavaCommand cmd)

addArgumentGen

protected void addArgumentGen(JavaCommand cmd)

addPersistentUnitCache

protected void addPersistentUnitCache(JavaCommand cmd)

createWidgetsetRequest

protected com.vaadin.wscdn.client.WidgetSetRequest createWidgetsetRequest()
                                                                   throws org.apache.maven.plugin.MojoExecutionException,
                                                                          org.apache.maven.plugin.MojoFailureException

Create a CDN widgetset compilation request.

Returns:

created request

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException