Difference between revisions of "Building your gCube Portlet in ETICS"

From Gcube Wiki
Jump to: navigation, search
Line 1: Line 1:
 
= Build Script =
 
= Build Script =
To build portlets in ETICS (and also on development machine) a standard build.xml and build.properties can be used copying them in portlet's root directory.
+
If you wish to use provided build.xml and build.properties, please download them and copy them in portlet's root directory.
 +
 
 +
Provided build.xml should be good to build almost all portlets, but, for some portlets specific commands not included in that script could be required.
  
 
== build.xml ==
 
== build.xml ==
Line 10: Line 12:
 
* '''javadoc''': runs javadoc compiler
 
* '''javadoc''': runs javadoc compiler
  
Download from here the basic build.xml file. [[File:Build.xml]]
+
Download from here the build.xml file. [[File:Build.xml]]
  
 
== build.properties ==
 
== build.properties ==
Line 29: Line 31:
  
 
[[Image:PortletBuildCommands.png]]
 
[[Image:PortletBuildCommands.png]]
 +
 +
 
== Dependencies ==
 
== Dependencies ==
 
In order to simplify portlet's dependencies management a ''special'' component has been created: '''org.gcube.portal.portal-framework'''. The aim of this component is to:
 
In order to simplify portlet's dependencies management a ''special'' component has been created: '''org.gcube.portal.portal-framework'''. The aim of this component is to:
Line 36: Line 40:
  
  
All portlets should express a dependency on org.gcube.portal.portal-framework.  
+
'''All portlets should express a dependency on org.gcube.portal.portal-framework.'''
 +
 
  
 
=== portal-framework details ===
 
=== portal-framework details ===
 
At the moment, '''org.gcube.portal.portal-framework''' provide portlets that express it as dependency with:
 
At the moment, '''org.gcube.portal.portal-framework''' provide portlets that express it as dependency with:
* a '''PORTAL_HOME''' env variable that point to actual location on filesystem of portal libraries;
+
* a PORTAL_HOME env variable that point to actual location on filesystem of portal libraries;
* a '''GWT_HOME''' anv variable that point to actual location of gwt installation directory;
+
* a GWT_HOME anv variable that point to actual location of gwt installation directory;
* '''gwt''' dependency;
+
* gwt dependency;
* '''liferay''' dependency;
+
* liferay dependency;
* '''gcube-widgets-library''' dependency;
+
* gcube-widgets-library dependency;

Revision as of 12:49, 5 July 2010

Build Script

If you wish to use provided build.xml and build.properties, please download them and copy them in portlet's root directory.

Provided build.xml should be good to build almost all portlets, but, for some portlets specific commands not included in that script could be required.

build.xml

Targets provided by build.xml are:

  • setenv: sets classpath. All other targets depend on it;
  • compile: compiles java soruces
  • gwt-compile: runs gwt compiler
  • war: creates war package
  • javadoc: runs javadoc compiler

Download from here the build.xml file. File:Build.xml

build.properties

Following properties, at least, must be customized:

  • war.filename
  • gwt-module
  • javadoc.doctitle
  • javadoc.windowtitle

Download from here the basic build.properties file. File:Build.properties


ETICS Configuration

In this page a guide to create an ETICS configuration for a D4Science-II portlet is provided.

Build Commands

Build commands specification is quite straightforward: you can refer to following screenshot.

PortletBuildCommands.png


Dependencies

In order to simplify portlet's dependencies management a special component has been created: org.gcube.portal.portal-framework. The aim of this component is to:

  • decouple portlets from the specific portal implementation (e.g.: gridsphere, liferay,...);
  • pull off common dependencies from portlet's configurations (e.g.: gwt, gcube-widgets);
  • provide an environment to compile portlet;


All portlets should express a dependency on org.gcube.portal.portal-framework.


portal-framework details

At the moment, org.gcube.portal.portal-framework provide portlets that express it as dependency with:

  • a PORTAL_HOME env variable that point to actual location on filesystem of portal libraries;
  • a GWT_HOME anv variable that point to actual location of gwt installation directory;
  • gwt dependency;
  • liferay dependency;
  • gcube-widgets-library dependency;