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

From Gcube Wiki
Jump to: navigation, search
(Dependencies)
Line 1: Line 1:
= Build Script =
+
= Build Scripts =
If you wish to use provided build.xml and build.properties, please download them and copy them in portlet's root directory.
+
To build portlets 3 standard scripts have been created that should be suitable for all portlets. These files are:
 +
* build.xml [[File:Build.xml]]
 +
* build.properties [[File:Build.properties]]
 +
* installPortlet.sh [[File:InstallPortlet_sh]] (rename it in InstallPortlet.sh)
 +
 
 +
Please copy those file in your 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 11: Line 15:
 
* '''war''': creates war package
 
* '''war''': creates war package
 
* '''javadoc''': runs javadoc compiler
 
* '''javadoc''': runs javadoc compiler
 +
* '''d4s-deploy''': used for automatic portlet's deploy
  
 
Download from here the build.xml file. [[File:Build.xml]]
 
Download from here the build.xml file. [[File:Build.xml]]
Line 17: Line 22:
 
Following properties, at least, must be customized:
 
Following properties, at least, must be customized:
 
*war.filename
 
*war.filename
*gwt-module
+
*gwt-module (if any)
 
*javadoc.doctitle
 
*javadoc.doctitle
 
*javadoc.windowtitle
 
*javadoc.windowtitle

Revision as of 17:04, 7 July 2010

Build Scripts

To build portlets 3 standard scripts have been created that should be suitable for all portlets. These files are:

Please copy those file in your portlet's root directory.


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
  • d4s-deploy: used for automatic portlet's deploy

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

build.properties

Following properties, at least, must be customized:

  • war.filename
  • gwt-module (if any)
  • 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. This component aims to:

  • decouple portlets from the specific portal implementation (e.g.: gridsphere, liferay,...);
  • provide a common environment to compile portlets;


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;