Hello World - WebSphere Portal V5 The simplest portal: Part 1, creation, and deployment

This article will take you to the steps of creation and deploying a simple portlet in WebSphere Portal Version 5.

Introduction, some people often ask me this question: "If you start from the beginning, what is the simplest portlet created by WebSphere Portal Version 5?". The fixed answer is "Hello World". This article will take a long time to answer this question in detail. I am going to take you to learn how to create the easiest Protlet for WebSphere Portal V5. You will start from some Java code, then compile it, then package it. Next, you will create the deployment descriptor required for the application server and portal information about the information about portlets. Finally, we pack them together and deploy new portlets to the portal.

Creating a directory structure first creates a directory structure and you will create a portlet in this directory structure. Below is the directory structure I will use in this simple portlet:

HelloWorld / COM / IBM / Portlets / Sample - Position of the source code HelloWorld / Web-INF - Deploy the location of the descriptor HelloWorld / WEB-INF / LIB - JAR file storage

Creating a Java file Sample directory is where you will store the Java source code. Create a file called HelloWorld.java in the sample directory, then open the file with your favorite text editor. Here is the class you need to enter (or copy, paste) to the HelloWorld.java file:

Package com.ibm.portlets.sample;

// portlet APIT

Import org.apache.jetspeed.portlet. *;

// java stuff

Import java.io. *;

Public class helloworld extends portletadapter {

Public void

Service (PortletRequest)

REQUEST, PortletResponse

Response)

Throws portletException,

IOEXCEPTION {

PrintWriter Writer =

Response.getwriter ();

Writer.println ("Hello, World");

}

}

Compiling Code Once you have created a source file, you can compile the Java code. In a batch file, you can use the following scripts to compile portlets. You first define some environment variables (for example, the location of the Java home directory). The JDK with WebSphere Application Server is compiled for this is usually a good idea, because this is the environment you want to run. You have to set the PATH to access the Java compiler. In addition, it is also necessary to set the variable libpath to point to the directory where the WebSphere JAR file is located.

Next, you build a variable called CP for our compile class path. The CP variable can be constructed on one line, but to illustrate the different JAR files required, we disassemble the branch display. Then, you call the Java compiler to compile the code. This assumes that you are located in the HelloWorld directory. Please adjust the directory path to the path that is fit.

Set java_home = c: / WebSphere / AppserVer / Java

SET PATH =% java_home% / bin

SET LIBPATH = C: / WebSphere / AppServer / LIB

SET CP =.

SET CP =% CP%;% libpath% / j2ee.jar

SET CP =% CP%;% libpath% / Dynacache.jar

SET CP =% CP%; c: /websphere/portalser/shared/app/portlet-api.jar

Javac-ClassPath% CP% COM / IBM / Portlets / Sample / HelloWorld.java

If you can't compile some reason, you must have a correct error before going down. Some common mistakes are:

Enter an error - class name, path, and variable name Enter the error file name - the file name must match the class name. In our example, the file name is HelloWorld.java, and the class name is HelloWorld. If you have changed a name, another name is also changed. Editor Error - Determines the editor to store files as text. Like a editor like writing, you will not store the file to text by default.

Creating a JAR file After completing the compilation of the Java source file, you need to create a JAR file in a web-inf / lib directory. Have a hypothesis that you are located in the HelloWorld directory. If you create a batch file in the Compile Code section, you can include part of the file as part of the file. This depends on the PATH set to point to the JAR program.

Set java_home = c: / WebSphere / AppserVer / Java

SET PATH =% java_home% / bin

Jar -cv0f ./web-inf/lib/helloworld.jar COM / IBM / Portlets / Sample / *. Class

Create a deployment descriptor now, you need to create two XML files:

HelloWorld / Web-INF / Web.xml - Web Deployment Descriptor. HelloWorld / Web-INF / portlet.xml - portlet deployment descriptor.

Web.xml - Web Deployment Descriptor Web Deployment Descriptor is required for WebSphere Portal. Now the portlet extends servlet, so you need to use the web deployment descriptor to declare the Servlet (portlet) class.

"1.0" encoding =

"UTF-8"?>

Public "- // Sun microsystems, Inc.//dtd Web Application 2.3 // en"

"http://java.sun.com/dtd/web-app_2_3.dtd">

HelloWorldportlet <

/ Display-name>

HelloWorld <

/ servlet-name>

com.ibm.portlets.sample.helloworld <

/ servlet-clas>

"Servletmapping_1">

HelloWorld <

/ servlet-name>

/ helloworld / * <

/ url-pattern>

portlet.xml - Portlet Deployment Descriptor Portlet Deployment Descriptor Defines the portal. Each portlet is mapped to a servlet defined in the web deployment descriptor through the HREF property of the portlet element. These references are represented by bold. Portlets must define a unique ID, each of which can reference the ID. Each specific portlet uses the specific ID of the HREF attribute of the Concrete-Portlet element to reference the portlet. Represents these references in blue.

"1.0" encoding =

"UTF-8"?>

PUBLIC "- // ibm // DTD portlet application 1.1 // en" "portlet_1.1.dtd">

"com.ibm.ports.sample.helloWorld.1" major-version = "1"

Minor-version = "0">

HelloWorld0Portlet <

/ portlet-app-name>

Minor-verion = "0">

HelloWorld <

/ portlet-name>

0 <

/ expresss>

NO <

/ shared>

"html">

"com.ibm.ports.sample.helloWorld.1.2">

Concrete HelloWorld <

/ portlet-app-name>

Author <

/ param-name>

tcat@us.ibm.com <

/ param-value>

HelloWorld <

/ portlet-name>

EN <

/ Default-local>

"en">