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

From Gcube Wiki
Jump to: navigation, search
(→‎Build Scripts)
Line 3: Line 3:
 
* build.xml [[File:Build.xml]]
 
* build.xml [[File:Build.xml]]
 
* build.properties [[File:Build.properties]]
 
* build.properties [[File:Build.properties]]
−
* installPortlet.sh [[File:InstallPortlet_sh]] (rename it in InstallPortlet.sh)
+
* installPortlet.sh (see below)
  
 
Please copy those file in your portlet's root directory.
 
Please copy those file in your portlet's root directory.
Line 28: Line 28:
 
Download from here the basic build.properties file. [[File:Build.properties]]
 
Download from here the basic build.properties file. [[File:Build.properties]]
  
 +
== installPortlet.sh ==
 +
Create a file named installPortlet.sh in your portlet's root directory containing:
 +
<pre>
 +
#!/bin/bash
 +
#
 +
if [ -f "$HOME/.bashrc_portal" ]
 +
then
 +
source "$HOME/.bashrc_portal"
 +
fi
 +
 +
if [ -z "$CATALINA_HOME"  ]
 +
then
 +
echo  "Cannot deploy portlet(s), tomcat was not detected!"
 +
exit 1
 +
else
 +
ant -f build.xml d4s-deploy >& ant_logs.txt
 +
if [ $? != 0 ]
 +
then
 +
echo  "Cannot deploy portlet(s), build was not successfull!"
 +
exit 1
 +
fi
 +
exit 0
 +
fi
 +
</pre>
  
 
= ETICS Configuration =
 
= ETICS Configuration =

Revision as of 17:09, 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

installPortlet.sh

Create a file named installPortlet.sh in your portlet's root directory containing: 

#!/bin/bash
#
if [ -f "$HOME/.bashrc_portal" ]
then
	source "$HOME/.bashrc_portal"
fi

if [ -z "$CATALINA_HOME"  ]
then
	echo  "Cannot deploy portlet(s), tomcat was not detected!"
	exit 1
else
	ant -f build.xml d4s-deploy >& ant_logs.txt
	if [ $? != 0 ]
	then
		echo  "Cannot deploy portlet(s), build was not successfull!"
		exit 1
	fi
exit 0
fi

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;
Retrieved from "https://wiki.gcube-system.org/index.php?title=Building_your_gCube_Portlet_in_ETICS&oldid=10101"