org.codehaus.enunciate.modules.gwt
Class GWTDeploymentModule

java.lang.Object
  org.codehaus.enunciate.modules.BasicDeploymentModule
      org.codehaus.enunciate.modules.FreemarkerDeploymentModule
          org.codehaus.enunciate.modules.gwt.GWTDeploymentModule

All Implemented Interfaces:

EnunciateClasspathListener, EnunciateModelAware, DeploymentModule, GWTHomeAwareModule, ProjectExtensionModule

public class GWTDeploymentModule
extends FreemarkerDeploymentModule
implements ProjectExtensionModule, GWTHomeAwareModule, EnunciateClasspathListener

GWT Module

The GWT deployment module generates the server-side and client-side libraries used to support a GWT RPC API. There is also support for invoking the GWTCompiler to compile a set a GWT applications that can be included in the generated Enunciate web application.

The order of the GWT deployment module is 0, as it doesn't depend on any artifacts exported by any other module.

This documentation is an overview of how to use Enunciate to build your GWT-RPC API and (optional) associated GWT application. The reader is redirected to the documentation for the GWT for instructions on how to use GWT. You may also find the petclinic sample application useful as an illustration. The sample petclinic application is included with the Enunciate distribution.

• steps
• configuration
• artifacts

Steps

generate

The "generate" step generates all source code for the GWT-RPC API.

compile

During the "compile" step, the GWT module compiles the code that was generated. It is also during the "compile" step that the GWTCompiler is invoked on any GWT applications that were specified in the configuration.

build

The "build" step assembles the client-side GWT jar.

Configuration

The GWT module is configured by the "gwt" element under the "modules" element of the enunciate configuration file. The GWT module is disabled by default because of the added constraints applied to the service endpoints. To enable GWT, be sure to specify disabled="false" on the "gwt" element.

The "gwt" element supports the following attributes:

• The "rpcModuleName" attribute must be supplied. The RPC module name will also be used to determine the layout of the created module. The module name must be of the form "com.mycompany.MyModuleName". In this example, "com.mycompany" will be the module namespace and all client code will be generated into a package named of the form [module namespace].client (e.g. "com.mycompany.client"). By default, in order to provide a sensible mapping from service code to GWT client-side code, all service endpoints, faults, and JAXB beans must exist in a package that matches the module namespace, or a subpackage thereof. Use the "enforceNamespaceConformance" attribute to loosen this requirement.
• The "enforceNamespaceConformance" attribute allows you to lift the requirement that all classes must exist in a package that matches the module namespace. If this is set to "false", the classes that do not match the module namespace will be subpackaged by the client namespace. NOTE: You may not like this because the package mapping might be ugly. For example, if your module namespace is "com.mycompany" and you have a class "org.othercompany.OtherClass", it will be mapped to a client-side GWT class named "com.mycompany.client.org.othercompany.OtherClass".
• The "label" attribute is used to determine the name of the client-side artifact files. The default is the Enunciate project label.
• The "clientJarName" attribute specifies the name of the client-side jar file that is to be created. If no jar name is specified, the name will be calculated from the enunciate label, or a default will be supplied.
• The "clientJarDownloadable" attribute specifies whether the GWT client-side jar should be included as a download. Default: false.
• The "gwtHome" attribute specifies the filesystem path to the Google Web Toolkit home directory.
• The "gwtCompilerClass" attribute specifies the FQN of the GWTCompiler. Default: "com.google.gwt.dev.GWTCompiler".
• The "enforceNoFieldAccessors" attribute specifies whether to enforce that a field accessor cannot be used for GWT mapping. Note: whether this option is enabled or disabled, there currently MUST be a getter and setter for each accessor. This option only disables the compile-time validation check.
• The "useWrappedServices" attribute specifies whether to use wrapped GWT client services. This is an artifact from when GWT 1.4 was supported and the generic types were unavailable. Default: false
• The "disableCompile" attribute prevents Enunciate from compiling its generated client source files.

The "war" element

The "war" element under the "gwt" element is used to configure the webapp that will host the GWT endpoints and GWT applications. It supports the following attributes:

• The "gwtSubcontext" attribute is the subcontext at which the gwt endpoints will be mounted. Default: "/gwt/".
• The "gwtAppDir" attribute is the directory in the war to which the gwt applications will be put. The default is the root of the war.

The "app" element

The GWT module supports the development of GWT AJAX apps. Each app is comprised of a set of GWT modules that will be compiled into JavaScript. The "app" element supports the folowing attributes:

• The "name" attribute is the name of the GWT app. Each app will be deployed into a subdirectory that matches its name. By default, the name of the application is the empty string (""). This means that the application will be deployed into the root directory.
• The "srcDir" attribute specifies the source directory for the application. This attribute is required.
• The "javascriptStyle" attribute specified the JavaScript style that is to be applied by the GWTCompiler. Valid values are "OBF", "PRETTY", and "DETAILED". The default value is "OBF".

Each "app" element may contain an arbitrary number of "module" child elements that specify the modules that are included in the app. The "module" element supports the following attributes:

• The "name" attribute specifies the name of the module. This is usually of the form "com.mycompany.MyModule" and it always has a corresponding ".gwt.xml" module file.
• The "outputDir" attribute specifies where the compiled module will be placed, relative to the application directory. By default, the outputDir is the empty string (""), which means the compiled module will be placed at the root of the application directory. Note: as of GWT 1.6, a new "war" directory structure is supported, along with support to control the directory where the GWT compiler puts the compiled application. Because of this, the "outputDir" attribute will only be honored if not using GWT 1.6 or above.
• The "shellPage" attribute specifies the (usually HTML) page to open when invoking the shell for this module (used to generate the shell script). By default, the shell page is the [moduleId].html, where [moduleId] is the (short, unqualified) name of the module.

The "gwtCompileJVMArg" element

The "gwtCompileJVMArg" element is used to specify additional JVM parameters that will be used when invoking GWTCompile. It supports a single "value" attribute.

The "gwtCompilerArg" element

The "gwtCompilerArg" element is used to specify additional arguments that will be psssed to the GWT compiler. It supports a single "value" attribute.

Example Configuration

As an example, consider the following configuration:

<enunciate> <modules> <gwt disabled="false" rpcModuleName="com.mycompany.MyGWTRPCModule" gwtHome="/home/myusername/tools/gwt-linux-1.5.2"> <app srcDir="src/main/mainapp"> <module name="com.mycompany.apps.main.MyRootModule"/> <module name="com.mycompany.apps.main.MyModuleTwo" outputDir="two"/> </app> <app srcDir="src/main/anotherapp" name="another"> <module name="com.mycompany.apps.another.AnotherRootModule"/> <module name="com.mycompany.apps.another.MyModuleThree" outputDir="three"/> </app> ... </gwt> </modules> </enunciate>

The configuration enables the GWT Enunciate module and will publish the web service endpoints under the module name "com.mycompany.MyGWTRPCModule".

There are also two GWT applications defined. The first is located at "src/main/mainapp". Since there is no "name" applied to this application, it will be generated into the root of the applications directory. This first application has two GWT modules defined, the first named "com.mycompany.apps.main.MyRootModule" and the second named "com.mycompany.apps.main.MyModuleTwo". "MyRootModule", since it has to output path defined, will be generated into the root of its application directory (which is the root of the main applications directory). "MyModuleTwo", however, will be generated into the subdirectory "two".

The second application, rooted at "src/main/anotherapp", is named "another", so it will be generated into the "another" subdirectory of the main applications directory. It also has two modules, one named "com.mycompany.apps.another.AnotherRootModule", and another named "com.mycompany.apps.another.MyModuleThree". "AnotherRootModule" will be generated into the root of its application directory ("another") and "MyModuleThree" will be generated into "another/three".

All modules are defined by their associated ".gwt.xml" module definition files. After the "compile" step of the GWT module, the main applications directory will look like this:

|--[output of com.mycompany.apps.main.MyRootModule] |--two |----[output of com.mycompany.apps.main.MyModuleTwo] |--another |----[output of com.mycompany.apps.another.AnotherRootModule] |----three |------[output of com.mycompany.apps.another.MyModuleThree]

For a less contrived example, see the "petclinic" sample Enunciate project bundled with the Enunciate distribution.

Artifacts

• The "gwt.client.jar" artifact is the packaged client-side GWT jar.
• The "gwt.client.src.dir" artifact is the directory where the client-side source code is generated.
• The "gwt.server.src.dir" artifact is the directory where the server-side source code is generated.
• The "gwt.app.dir" artifact is the directory to which the GWT AJAX apps are compiled.
• The "[appName].[moduleName].shell" artifact is the GWT shell script used to invoke the gwt shell for the module [moduleName] in app [appName].
Script is different from the alternative in that it assumes a server is already running before invoking the GWTShell.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.codehaus.enunciate.modules.BasicDeploymentModule

enunciate

Constructor Summary

GWTDeploymentModule()

Method Summary

void	addGWTApp(GWTApp gwtApp) Adds a gwt app to be compiled.
void	addGwtCompileJVMArg(java.lang.String arg) Extra JVM args for the GWT compile.
void	addGwtCompilerArg(java.lang.String arg) Additional argument to pass to the GWT compiler.
protected void	buildClientJar()
protected void	doBuild() Default implementation is a no-op.
protected void	doCompile() Default implementation is a no-op.
void	doFreemarkerGenerate() Generate using Freemarker.
protected void	doGWTCompile() Invokes GWTCompile on the apps specified in the configuration file.
protected boolean	existsAnyJsonResourceMethod(java.util.List<RootResource> rootResources) Whether any root resources exist that produce json.
java.io.File	getAppGenerateDir() The base generate dir for the gwt applications.
protected java.io.File	getAppGenerateDir(java.lang.String appName) The generate dir for the specified app.
java.lang.String	getClientJarName() The name of the client jar.
java.io.File	getClientSideCompileDir() Get the compile directory for client-side GWT classes.
java.io.File	getClientSideGenerateDir() Get the generate directory for client-side GWT classes.
org.apache.commons.digester.RuleSet	getConfigurationRules() GWT configuration rule set.
java.lang.String	getGwtAppDir() The gwt app dir.
java.util.List<GWTApp>	getGwtApps() The gwt apps to compile.
java.util.List<java.lang.String>	getGwtCompileJVMArgs() Extra JVM args for the GWT compile.
java.util.List<java.lang.String>	getGwtCompilerArgs() Additional arguments to pass to the GWT compiler.
java.lang.String	getGwtCompilerClass() The GWT compiler class.
java.io.File	getGwtGenDir() The GWT gen directory.
java.lang.String	getGwtHome() The gwt home directory
java.io.File	getGwtScriptDir() The base generate dir for the gwt scripts (e.g.
java.lang.String	getGwtSubcontext() The GWT subcontext.
java.lang.String	getLabel() The label for the GWT client API.
protected java.lang.String	getModuleId(java.lang.String moduleName) Get the module id of the specified GWT module.
java.lang.String	getName() The name of the deployment module.
protected freemarker.template.ObjectWrapper	getObjectWrapper() The object wrapper to use for the model.
java.util.List<java.io.File>	getProjectResourceDirectories() Any additional project resource directories to add to the project.
java.util.List<java.io.File>	getProjectSources() Any additional project source roots to add to the project.
java.util.List<java.io.File>	getProjectTestResourceDirectories() Any additional project resource directories to add to the project.
java.util.List<java.io.File>	getProjectTestSources() Any additional project test source roots to add to the project.
java.lang.String	getRpcModuleName() The generated RPC module name.
java.lang.String	getRpcModuleNamespace() The generated RPC module namespace.
java.io.File	getServerSideGenerateDir() Get the generate directory for server-side GWT classes.
java.io.File	getShellScriptFile(java.lang.String appName, java.lang.String moduleName) Get the GWT shell script file for the specified module, app.
protected java.net.URL	getTemplateURL(java.lang.String template) Get a template URL for the template of the given name.
Validator	getValidator() GWT validator.
protected boolean	gwtVersionGreaterThan(int major, int minor)
void	init(Enunciate enunciate) Sets the enunciate mechanism.
void	initModel(EnunciateFreemarkerModel model) Initialize the model.
boolean	isClientJarDownloadable() Whether the client jar is downloadable.
boolean	isDisableCompile() Whether to disable the compilation of the java sources (default: false).
boolean	isEnforceNamespaceConformance() Whether to enforce namespace conformace on the server-side classes.
boolean	isEnforceNoFieldAccessors() Whether to enforce that field accessors can't be used.
boolean	isGenerateJsonOverlays() Whether to generate JSON overlays.
boolean	isGenerateRPCSupport() Whether to generate the RPC support classes.
protected boolean	isGWTTransient(com.sun.mirror.declaration.Declaration declaration) Whether the given type declaration is GWT-transient.
protected boolean	isGWTTransient(com.sun.mirror.declaration.TypeDeclaration declaration) Whether the given type declaration is GWT-transient.
boolean	isUseWrappedServices() Whether to generated wrapped GWT remote services in the client-code.
void	onClassesFound(java.util.Set<java.lang.String> classes) Logic for handling a set of classes that were found on the Enunciate classpath.
protected int[]	parseGwtVersion(java.lang.String version)
protected java.lang.String	readResource(java.lang.String resource) Reads a resource into string form.
void	setClientJarDownloadable(boolean clientJarDownloadable) Whether the client jar is downloadable.
void	setClientJarName(java.lang.String clientJarName) The name of the client jar.
void	setDisableCompile(boolean disableCompile) Whether to disable the compilation of the java sources (default: false).
void	setEnforceNamespaceConformance(boolean enforceNamespaceConformance) Whether to enforce namespace conformace on the server-side classes.
void	setEnforceNoFieldAccessors(boolean enforceNoFieldAccessors) Whether to enforce that field accessors can't be used.
void	setGenerateJsonOverlays(boolean generateJsonOverlays) Whether to generate JSON overlays.
void	setGwtAppDir(java.lang.String gwtAppDir) The gwt app dir.
void	setGwtCompilerClass(java.lang.String gwtCompilerClass) The GWT compiler class.
void	setGwtHome(java.lang.String gwtHome) Set the path to the GWT home directory.
void	setGwtModuleName(java.lang.String gwtModuleName) Deprecated. Use setRpcModuleName(String)
void	setGwtSubcontext(java.lang.String gwtSubcontext) The gwt subcontext.
void	setGwtVersion(java.lang.String version) Sets the GWT version that Enunciate will target.
void	setLabel(java.lang.String label) The label for the ActionScript API.
void	setRpcModuleName(java.lang.String rpcModuleName) The generated RPC module name.
void	setUseWrappedServices(boolean useWrappedServices) Whether to generated wrapped GWT remote services in the client-code.

Methods inherited from class org.codehaus.enunciate.modules.FreemarkerDeploymentModule

close, doGenerate, getConfiguration, getModel, getModelInternal, getTemplateExceptionHandler, getTemplateLoader, processTemplate, processTemplate, processTemplate, processTemplate

Methods inherited from class org.codehaus.enunciate.modules.BasicDeploymentModule

debug, doPackage, getAliases, getBuildDir, getCompileDir, getEnunciate, getGenerateDir, getOrder, getPackageDir, info, isDisabled, setBuildDir, setCompileDir, setDisabled, setGenerateDir, setPackageDir, step, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.enunciate.modules.DeploymentModule

close, getAliases, getOrder, isDisabled, step

Constructor Detail

GWTDeploymentModule

public GWTDeploymentModule()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: DeploymentModule

The name of the deployment module. Identifies its section in the enunciate configuration.

Specified by:

getName in interface DeploymentModule

Overrides:

getName in class BasicDeploymentModule

Returns:

"gwt"

init

public void init(Enunciate enunciate)
          throws EnunciateException

Description copied from class: BasicDeploymentModule

Sets the enunciate mechanism.

Specified by:

init in interface DeploymentModule

Overrides:

init in class BasicDeploymentModule

Parameters:

enunciate - The enunciate mechanism.

Throws:

EnunciateException

gwtVersionGreaterThan

protected boolean gwtVersionGreaterThan(int major,
                                        int minor)

initModel

public void initModel(EnunciateFreemarkerModel model)

Description copied from interface: EnunciateModelAware

Initialize the model.

Specified by:

initModel in interface EnunciateModelAware

Overrides:

initModel in class FreemarkerDeploymentModule

Parameters:

model - The model to initialize.

onClassesFound

public void onClassesFound(java.util.Set<java.lang.String> classes)

Description copied from interface: EnunciateClasspathListener

Logic for handling a set of classes that were found on the Enunciate classpath.

Specified by:

onClassesFound in interface EnunciateClasspathListener

Parameters:

classes - The classes that were found.

doFreemarkerGenerate

public void doFreemarkerGenerate()
                          throws java.io.IOException,
                                 freemarker.template.TemplateException,
                                 EnunciateException

Description copied from class: FreemarkerDeploymentModule

Generate using Freemarker. Same as FreemarkerDeploymentModule.doGenerate() but can throw a TemplateException.

Specified by:

doFreemarkerGenerate in class FreemarkerDeploymentModule

Throws:

java.io.IOException

freemarker.template.TemplateException

EnunciateException

doGWTCompile

protected void doGWTCompile()
                     throws EnunciateException,
                            java.io.IOException

Invokes GWTCompile on the apps specified in the configuration file.

Throws:

EnunciateException

java.io.IOException

doCompile

protected void doCompile()
                  throws EnunciateException,
                         java.io.IOException

Description copied from class: BasicDeploymentModule

Default implementation is a no-op.

Overrides:

doCompile in class BasicDeploymentModule

Throws:

EnunciateException

java.io.IOException

doBuild

protected void doBuild()
                throws EnunciateException,
                       java.io.IOException

Description copied from class: BasicDeploymentModule

Default implementation is a no-op.

Overrides:

doBuild in class BasicDeploymentModule

Throws:

EnunciateException

java.io.IOException

buildClientJar

protected void buildClientJar()
                       throws java.io.IOException,
                              EnunciateException

Throws:

java.io.IOException

EnunciateException

readResource

protected java.lang.String readResource(java.lang.String resource)
                                 throws java.io.IOException,
                                        EnunciateException

Reads a resource into string form.

Parameters:

resource - The resource to read.

Returns:

The string form of the resource.

Throws:

java.io.IOException

EnunciateException

isGWTTransient

protected boolean isGWTTransient(com.sun.mirror.declaration.TypeDeclaration declaration)

Whether the given type declaration is GWT-transient.

Parameters:

declaration - The type declaration.

Returns:

Whether the given tyep declaration is GWT-transient.

isGWTTransient

protected boolean isGWTTransient(com.sun.mirror.declaration.Declaration declaration)

Whether the given type declaration is GWT-transient.

Parameters:

declaration - The type declaration.

Returns:

Whether the given tyep declaration is GWT-transient.

getTemplateURL

protected java.net.URL getTemplateURL(java.lang.String template)

Get a template URL for the template of the given name.

Parameters:

template - The specified template.

Returns:

The URL to the specified template.

getServerSideGenerateDir

public java.io.File getServerSideGenerateDir()

Get the generate directory for server-side GWT classes.

Returns:

The generate directory for server-side GWT classes.

getClientSideGenerateDir

public java.io.File getClientSideGenerateDir()

Get the generate directory for client-side GWT classes.

Returns:

The generate directory for client-side GWT classes.

getGwtGenDir

public java.io.File getGwtGenDir()

The GWT gen directory. (I still don't know what this is used for, exactly.)

Returns:

The GWT gen directory.

getClientSideCompileDir

public java.io.File getClientSideCompileDir()

Get the compile directory for client-side GWT classes.

Returns:

The compile directory for client-side GWT classes.

getAppGenerateDir

public java.io.File getAppGenerateDir()

The base generate dir for the gwt applications.

Returns:

The base generate dir for the gwt applications.

getGwtScriptDir

public java.io.File getGwtScriptDir()

The base generate dir for the gwt scripts (e.g. shell scripts).

Returns:

The base generate dir for the gwt scripts (e.g. shell scripts).

getShellScriptFile

public java.io.File getShellScriptFile(java.lang.String appName,
                                       java.lang.String moduleName)

Get the GWT shell script file for the specified module, app.

Parameters:

appName - The app name.

moduleName - The module name.

Returns:

The shell script file.

getModuleId

protected java.lang.String getModuleId(java.lang.String moduleName)

Get the module id of the specified GWT module.

Parameters:

moduleName - The module name.

Returns:

The module id.

getAppGenerateDir

protected java.io.File getAppGenerateDir(java.lang.String appName)

The generate dir for the specified app.

Parameters:

appName - The app name.

Returns:

The generate dir for the specified app.

getClientJarName

public java.lang.String getClientJarName()

The name of the client jar.

Returns:

The name of the client jar.

setClientJarName

public void setClientJarName(java.lang.String clientJarName)

The name of the client jar.

Parameters:

clientJarName - The name of the client jar.

getConfigurationRules

public org.apache.commons.digester.RuleSet getConfigurationRules()

GWT configuration rule set.

Specified by:

getConfigurationRules in interface DeploymentModule

Overrides:

getConfigurationRules in class BasicDeploymentModule

Returns:

GWT configuration rule set.

getValidator

public Validator getValidator()

GWT validator.

Specified by:

getValidator in interface DeploymentModule

Overrides:

getValidator in class BasicDeploymentModule

Returns:

GWT validator.

getObjectWrapper

protected freemarker.template.ObjectWrapper getObjectWrapper()

Description copied from class: FreemarkerDeploymentModule

The object wrapper to use for the model.

Overrides:

getObjectWrapper in class FreemarkerDeploymentModule

Returns:

The object wrapper to use for the model.

getRpcModuleName

public java.lang.String getRpcModuleName()

The generated RPC module name.

Returns:

The generated RPC module name.

getRpcModuleNamespace

public java.lang.String getRpcModuleNamespace()

The generated RPC module namespace.

Returns:

The generated RPC module namespace.

setGwtModuleName

public void setGwtModuleName(java.lang.String gwtModuleName)

Deprecated. Use setRpcModuleName(String)

The generated RPC module name.

Parameters:

gwtModuleName - The gwt module name.

setRpcModuleName

public void setRpcModuleName(java.lang.String rpcModuleName)

The generated RPC module name.

Parameters:

rpcModuleName - The generated RPC module name.

isClientJarDownloadable

public boolean isClientJarDownloadable()

Whether the client jar is downloadable.

Returns:

Whether the client jar is downloadable.

setClientJarDownloadable

public void setClientJarDownloadable(boolean clientJarDownloadable)

Whether the client jar is downloadable.

Parameters:

clientJarDownloadable - Whether the client jar is downloadable.

isEnforceNamespaceConformance

public boolean isEnforceNamespaceConformance()

Whether to enforce namespace conformace on the server-side classes.

Returns:

Whether to enforce namespace conformace on the server-side classes.

setEnforceNamespaceConformance

public void setEnforceNamespaceConformance(boolean enforceNamespaceConformance)

Whether to enforce namespace conformace on the server-side classes.

Parameters:

enforceNamespaceConformance - Whether to enforce namespace conformace on the server-side classes.

isEnforceNoFieldAccessors

public boolean isEnforceNoFieldAccessors()

Whether to enforce that field accessors can't be used.

Returns:

Whether to enforce that field accessors can't be used.

setEnforceNoFieldAccessors

public void setEnforceNoFieldAccessors(boolean enforceNoFieldAccessors)

Whether to enforce that field accessors can't be used.

Parameters:

enforceNoFieldAccessors - Whether to enforce that field accessors can't be used.

getGwtHome

public java.lang.String getGwtHome()

The gwt home directory

Returns:

The gwt home directory

setGwtHome

public void setGwtHome(java.lang.String gwtHome)

Set the path to the GWT home directory.

Specified by:

setGwtHome in interface GWTHomeAwareModule

Parameters:

gwtHome - The gwt home directory

getGwtCompileJVMArgs

public java.util.List<java.lang.String> getGwtCompileJVMArgs()

Extra JVM args for the GWT compile.

Returns:

Extra JVM args for the GWT compile.

addGwtCompileJVMArg

public void addGwtCompileJVMArg(java.lang.String arg)

Extra JVM args for the GWT compile.

Parameters:

arg - Extra JVM args for the GWT compile.

getGwtCompilerArgs

public java.util.List<java.lang.String> getGwtCompilerArgs()

Additional arguments to pass to the GWT compiler.

Returns:

Additional arguments to pass to the GWT compiler.

addGwtCompilerArg

public void addGwtCompilerArg(java.lang.String arg)

Additional argument to pass to the GWT compiler.

Parameters:

arg - The additional arg.

getGwtCompilerClass

public java.lang.String getGwtCompilerClass()

The GWT compiler class.

Returns:

The GWT compiler class.

setGwtCompilerClass

public void setGwtCompilerClass(java.lang.String gwtCompilerClass)

The GWT compiler class.

Parameters:

gwtCompilerClass - The GWT compiler class.

getGwtApps

public java.util.List<GWTApp> getGwtApps()

The gwt apps to compile.

Returns:

The gwt apps to compile.

addGWTApp

public void addGWTApp(GWTApp gwtApp)

Adds a gwt app to be compiled.

Parameters:

gwtApp - The gwt app to be compiled.

getGwtSubcontext

public java.lang.String getGwtSubcontext()

The GWT subcontext.

Returns:

The GWT subcontext.

setGwtSubcontext

public void setGwtSubcontext(java.lang.String gwtSubcontext)

The gwt subcontext.

Parameters:

gwtSubcontext - The gwt subcontext.

getGwtAppDir

public java.lang.String getGwtAppDir()

The gwt app dir.

Returns:

The gwt app dir.

setGwtAppDir

public void setGwtAppDir(java.lang.String gwtAppDir)

The gwt app dir.

Parameters:

gwtAppDir - The gwt app dir.

isUseWrappedServices

public boolean isUseWrappedServices()

Whether to generated wrapped GWT remote services in the client-code.

Returns:

Whether to generated wrapped GWT remote services in the client-code.

setUseWrappedServices

public void setUseWrappedServices(boolean useWrappedServices)

Whether to generated wrapped GWT remote services in the client-code.

Parameters:

useWrappedServices - Whether to generated wrapped GWT remote services in the client-code.

isGenerateJsonOverlays

public boolean isGenerateJsonOverlays()

Whether to generate JSON overlays.

Returns:

Whether to generate JSON overlays.

isGenerateRPCSupport

public boolean isGenerateRPCSupport()

Whether to generate the RPC support classes.

Returns:

Whether to generate the RPC support classes.

setGenerateJsonOverlays

public void setGenerateJsonOverlays(boolean generateJsonOverlays)

Whether to generate JSON overlays.

Parameters:

generateJsonOverlays - Whether to generate JSON overlays.

getLabel

public java.lang.String getLabel()

The label for the GWT client API.

Returns:

The label for the GWT client API.

setLabel

public void setLabel(java.lang.String label)

The label for the ActionScript API.

Parameters:

label - The label for the ActionScript API.

setGwtVersion

public void setGwtVersion(java.lang.String version)

Sets the GWT version that Enunciate will target.

Parameters:

version - The GWT version Enunciate will target.

parseGwtVersion

protected int[] parseGwtVersion(java.lang.String version)
                         throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

existsAnyJsonResourceMethod

protected boolean existsAnyJsonResourceMethod(java.util.List<RootResource> rootResources)

Whether any root resources exist that produce json.

Parameters:

rootResources - The root resources.

Returns:

Whether any root resources exist that produce json.

getProjectSources

public java.util.List<java.io.File> getProjectSources()

Description copied from interface: ProjectExtensionModule

Any additional project source roots to add to the project.

Specified by:

getProjectSources in interface ProjectExtensionModule

Returns:

Any additional project source roots to add to the project.

getProjectTestSources

public java.util.List<java.io.File> getProjectTestSources()

Description copied from interface: ProjectExtensionModule

Any additional project test source roots to add to the project.

Specified by:

getProjectTestSources in interface ProjectExtensionModule

Returns:

Any additional project test source roots to add to the project.

getProjectResourceDirectories

public java.util.List<java.io.File> getProjectResourceDirectories()

Description copied from interface: ProjectExtensionModule

Any additional project resource directories to add to the project.

Specified by:

getProjectResourceDirectories in interface ProjectExtensionModule

Returns:

Any additional project resource directories to add to the project.

getProjectTestResourceDirectories

public java.util.List<java.io.File> getProjectTestResourceDirectories()

Description copied from interface: ProjectExtensionModule

Any additional project resource directories to add to the project.

Specified by:

getProjectTestResourceDirectories in interface ProjectExtensionModule

Returns:

Any additional project resource directories to add to the project.

isDisableCompile

public boolean isDisableCompile()

Whether to disable the compilation of the java sources (default: false).

Returns:

Whether to disable the compilation of the java sources (default: false).

setDisableCompile

public void setDisableCompile(boolean disableCompile)

Whether to disable the compilation of the java sources (default: false).

Parameters:

disableCompile - Whether to disable the compilation of the java sources (default: false).