GridSphere Portlet Services API

The Portlet Services API is an implementation based upon the GridLab Portal Technical Specification. The Portlet Services API presented was based originally on the IBM WebSphere Portlet API 4.1 (which in turn was based on the Jakarta Turbine-2 services model).

The two primary differences in the GridSphere Portlet Service API and the WebSphere 4.1 API are:

1. The use of an XML schema for defining portlet services as opposed to a plain text properties file

More information on developing portlet services using the GridSphere Portlet Services API can be found in the GridSphere documentation.

An example portlet service descriptor file is the following: ``

<portlet-services>

<service>
<name>Portlet Manager Service</name>
<description>Provides Administration Capabilities for Portlet Web Applications</description>
<interface>org.gridlab.gridsphere.services.core.registry.PortletManagerService</interface>
<implementation>org.gridlab.gridsphere.services.core.registry.impl.PortletManagerServiceImpl</implementation>
<service-config>
<param-name>coreContext</param-name>
<param-value>gsmanager, coreportlets, gridportlets</param-value>
</service-config>
</service>

<service>
<name>Login Service</name>
<description>Provides Login Capabilities</description>
<interface>org.gridlab.gridsphere.services.core.user.LoginService</interface>
<implementation>org.gridlab.gridsphere.services.core.user.impl.LoginServiceImpl</implementation>
</service>

...

The following definitions are used in defining a portlet service:

- portlet name - the portlet name
- description - a description of the portlet service
- interface - the portlet service interface class
- implementation - the portlet service implementation class
- service-config - specifies additional configuration requirements of the portlet service

- param-name - specifies an initialization parameter name
- param-value - specifies an initialization parameter value