Tutorial: Developing a Simple Hello World Portlet

Size: px

Start display at page:

Download "Tutorial: Developing a Simple Hello World Portlet"

Alexia Jones
6 years ago
Views:

Venkata Sri Vatsav Reddy Konreddy Tutorial: Developing a Simple Hello World Portlet CIS 764 This Tutorial helps to create and deploy a simple Portlet.

How to setup Pluto on local machine: Step 1: Download the current version of Apache Pluto from Pluto Website (http://portals.apache.org/pluto/download.

1 Venkata Sri Vatsav Reddy Konreddy Tutorial: Developing a Simple Hello World Portlet CIS 764 This Tutorial helps to create and deploy a simple Portlet. This tutorial uses Apache Pluto Server, a freeware which can support Portlets. How to setup the environment required to run portlets. How to setup Pluto on local machine: Step 1: Download the current version of Apache Pluto from Pluto Website ( Step 2: Extract the contents of the file into a local directory. Step 3: Go to the bin directory. The file startup.bat is used to start the server. Enter startup.bat at command prompt

We need to set the class path to compile the portlet code.

2 Pluto server running: Step 4: Portlet-api is not provided by default with java standard edition. It is provided with the Pluto server. We need to set the class path to compile the portlet code. Portlet-api is in the lib folder under shared folder. Procedure to set the class path: Go to properties in mycomputer. Under advanced system settings click on environment variables.

3 Now select the classpath variable. Classpath variable will not be present in some cases. If it is not present create a new variable and name it as Classpath. If the classpath variable is already present then click on edit button and add the portlet-api path to it.

4 These settings will come into effect the next time when command prompt is opened. Now that the required environment is ready, let s start developing the portlet. In the Pluto installation directory there will be a folder named webapps. Portlets can be created here directly or they can be created somewhere else and deployed in the server. To deploy a Portlet we need to follow a directory structure. General directory structure that should be followed is: / root folder of the portlet. /images all the images required by the portlet are stored here. /WEB-INF All the protected resources are stored here. The /WEB-INF directory stores the portlet descriptor document and all of the runtime executable JAR files and classes that the packaged portlet requires. The portlet information directory is not part of the public document tree of the application. Files that reside in /WEB-INF are not served directly to a client. /WEB-INF/lib the jar files are stored here /WEB-INF/classes the class files required by the portlet are stored here I have followed the following directory structure: /helloworld root directory WEB-INF portlet.xml & web.xml WEB-INF classes HelloWorld.class Now we have to write the portlet code: Under classes directory present in WEB-INF directory open a file named HelloWorld.java

5 Write the following code: import javax.portlet.*; import java.io.*; public class HelloWorld extends GenericPortlet{ protected void doview(renderrequest request, RenderResponse response) throws PortletException, IOException { response.setcontenttype("text/html"); response.getwriter().println("hello, world!"); } } Now compile the code using java compiler. Now deployment descriptors for the portlet must be written. Under WEB-INF directory create a file named web.xml

6 Write the following piece of xml code in it: <web-app> <servlet> <servlet-name>hello</servlet-name> <servlet-class>org.apache.pluto.core.portletservlet</servlet-class> <init-param> <param-name>portlet-class</param-name> <param-value>helloworld</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>hello</servlet-name> <url-pattern>/hello</url-pattern> </servlet-mapping> </web-app> Under WEB,-INF directory create a file named portlet.xml Write the following piece of xml code in it: <portlet-app> <portlet> <portlet-name>hello</portlet-name> <portlet-class>helloworld</portlet-class> <expiration-cache>0</expiration-cache>

<resource-bundle>helloworld</resource-bundle> <supports> <mime-type>text/html</mime-type> <portlet-mode>view</portlet-mode> </supports> </portlet> </portlet-app> Now as the root directory is under

7 <resource-bundle>helloworld</resource-bundle> <supports> <mime-type>text/html</mime-type> <portlet-mode>view</portlet-mode> </supports> </portlet> </portlet-app> Now as the root directory is under webapps it is not required to create a war file. The portlet application is deployed automatically by the server. If the root directory is not under webapps then a war file must be created and must be deployed manually in the server (which is explained after this method) Now open the server running on the local host by following the link The server s home page will be displayed. Select the manager mode. In the username and password fields enter username as pluto and password as pluto. (The username and password need not be same for all the server versions.

8 check the version s username and password). You can see the portlet application helloworld in the applications section.

9 We have used hello as our URL-Pattern in web.xml section. Type the following in the URLfield of the browser. You can see the output: Alternate Method (creating a war file): If the root directory is not present in the webapps directory then we need to use a war file. Creating a war file: Type the following command at the prompt.

10 java cvf helloworld.war *; Open the server and at the bottom there is a field to give the path of the war file. Or just use browse button to select the warfile. After the application is deployed then again the same procedure should be followed to get the output.

Administration Console Extension Developer's Guide

Administration Console Extension Developer's Guide {scrollbar} Previous versions of Geronimo have included a noncustomizable, static administration console. Often times when a user installs Geronimo, the