JSR 168 Portlet Spec

Transcription

1 JSR 168 Portlet Spec IEEE Certified Software Development Professional

2 Agenda 1. Portal & Portlet Architecture & Strategy 2. Pluto 3. Our First Portlet 4. The API Cliff s Notes 5. EXO Portal Plus, Deploy our Portlet in Portal Two 6. Jetspeed Plus, Deploy our Portlet in Portal Three! 7. Liferay My Favorite Portal

3 A note on the Moon Guy He means I have a Pre Baked Demo I can do Stop me if I skip one you want to see

4 Elements of Portal (ificaton) Perhaps a definition of "Portals" from Javaworld.com might also be useful - A portal is a Web-based application that provides personalization, single sign-on, and content aggregation from different sources, and hosts the presentation layer of information systems. Aggregation is the process of integrating content from different sources within a Webpage. A portal may have sophisticated personalization features to provide customized content to users. Portal pages may have different sets of portlets creating content for different users.

5 What is Portalification?

6 What is a Portlet? A portlet is a Java technology based web component, managed by a portlet container, that processes requests and generates dynamic content. Portlets are used by portals as pluggable user interface components that provide a presentation layer to Information Systems.

7 Portlet and Portal Together Static View

8 Portlet and Portal Together Dynamic View

9 Why Build a Portal? To solve some specific business need Usually associated with content aggregration

10 Steps in building a Portal Gather Requirements Portal s require a more comprehensive architecture than standard web or J2EE apps Build an Information Architecture Content User Interface Portlets Search Engine Taxonomy

11 Taxonomy Creation and Maintenance Categorize Content Assets Inventory Content Label and Personalize Index

12 Steps in Building a Taxonomy Define the strategy Create an organization focused on taxonomy creation Define purpose and intended use (users) of taxonomy Prioritize needs: Concepts if you re inventing Processes if you re low skill service based Competencies if you re high skill service based Decide basic metaphor for structuring information Choose a methodology/approach to building the taxonomy Classify information assets and categorize them Verification Implement Technology Support (JSR-168 compliant Portal?) Maintain

13 Building Portal Metadata Dublin Core Title Description Date Identifier Relation Creator Publisher Type Source Coverage Subject Contributor Format Language Rights

14 Look and Feel Most portlets are customized using Skins Jetspeed EXOPortal Liferay Search is an important part of any portal effort these days.

15 JSR-168 / Java Portlets Javax.portlet package Like other java applications Addition of portlet classes Addition of portlet.xml deployment descriptor WAR file deployment Different than other java applications Portal handles the layout, aggregation, personalization and single sign on

16 Why not use servlets &.jsp s? Absence of personalization interface and support for persistence of personalization information in servlet architecture Servlet architecture doesn t define aggregation on the desktop

17 Portlet & Servlet both End in let Are java components Have container managed lifecycles Servlet container (tomcat) Portlet container (pluto) Generate dynamic content Manage sessions Share a deployment and class loading paradigm

18 But only Portlets Generate Fragments (not complete documents) Have container managed, predefined states Window States Portlet Modes Are not directly bound to a URL

19 and Only Servlets Can set the URL client request Can set HTTP headers in responses Can establish response character encoding

20 Portal Page

21 Portlet Architecture

22 WSRP OASIS Standard Web Services for Remote Portals Portals that support WSRP can display Portlets from other WSRP enabled Portals

23 Integrating Existing Applications into the Portal Write a thin web service and develop a portlet for that application Write a WSRP layer on top of the application and have the application host itself as a portlet producer Application rewrite, factoring business logic and persistence out of the legacy app.

24 Part Two Pluto

25 Installing Pluto

26 Installing Pluto CVS Client I just used Eclipse Install Maven Install Tomcat Edit build.properties file Add %MAVEN_HOME%\bin directory to path Root Directory of PLUTO Project Execute `maven fulldeployment` Check it out!

27 Installing Pluto Build.properties settings maven.tomcat.home=c:/tomcat5.0 maven.tomcat.version.major=5

28 If your Maven Build Works

29 Interesting Eclipse Plugins Where Portal Construction is Going For Eclipse Generation of Portlets Maven Eclipse Plugin

30 JSR-168 Establishes Portlet Container Pluto is the reference implementation Portlet API Requests Preferences User Information Deployment Packaging Relationship between portlet and portlet container

31 Portal Just Another Web App WEB-INF (Familiar to Servlet & JSP folks) Web.xml Portlet.xml Pluto Specific Deployment Directory $TOMCAT_HOME/webapps/pluto/data Portletentityregistry.xml portlet & portlet app definitions Pageregistry.xml Describes how the portal page looks

32 Using Ant for War Files Init <property file="build.properties"/> <property name="src.dir" value="src"/> <property name="build.dir" value="build"/> <property name="dist.dir" value="dist"/> <property name="classes.dir" value="${build.dir}/classes"/> <property name="lib.dir" value="lib"/> <property name="web-inf.dir" value="web-inf"/> <target name="init"> <mkdir dir="${build.dir}"/> <mkdir dir="${classes.dir}"/> <mkdir dir="${dist.dir}"/> <mkdir dir="${lib.dir}"/> </target> INIT

33 Using Ant for War Files Compile <target name="compile" depends="init"> <javac destdir="${classes.dir}" deprecation="true" debug="true" optimize="false"> <src> <pathelement location="${src.dir}"/> </src> <classpath> <fileset dir="${lib.dir}"> <include name="*.jar"> </include> </fileset> <fileset dir="${tomcat.shared.lib.dir}"> <include name="*.jar"> </include> COMPILE </fileset> </classpath> </javac> </target>

34 Using Ant for War Files War <target name="war" depends="compile"> <war destfile="${dist.dir}/${war.name}.war" webxml="web-inf/web.xml"> <classes dir="${classes.dir}"/> <lib dir="${lib.dir}"/> <webinf dir="${web-inf.dir}"/> </war> </target> WAR

35 Pageregistry.xml Portal Application Id.portletId

36 portletentityregistry.xml Portal Application Id Portlet Id

37 Portlet Errors

38 Portlet Errors Did you Deploy? maven deploy -Ddeploy=FULL_PATH_TO_YOUR_PORTLET_WAR

39 Part Three Build our First Portlet

40 Portlet Modes Mandatory support for View Edit Help JSR-168 supports custom, vendor defined portlet modes

41 Window State Three States defined in JSR-168 Normal Maximized Minimized Custom states supported

42 Build our First Portlet Define Project Structure Define our Construction File structures, etc.

43 Build our First Portlet Code the Java package com.clutchsoftware.portlets; import java.io.ioexception; import java.io.writer; import javax.portlet.genericportlet; import javax.portlet.portletexception; import javax.portlet.renderrequest; import javax.portlet.renderresponse; public class CardinalsOne extends GenericPortlet { protected void doview(renderrequest request, RenderResponse response) throws PortletException, IOException { System.out.println("TEST OUTPUT"); response.setcontenttype("text/html"); Writer writer = response.getwriter(); writer.write("help, I'm a portlet, and I'm trapped in a portal framework!"); } } Code the Java

44 Build our First Portlet Build the web.xml Build the XML

45 Build our First Portlet Portlet.xml Build the XML

46 Build our First Portlet Ant Build Script Run the ant build script

47 Build our First Portlet Perform the PLUTO Deployment

48 Build our First Portlet Make sure this is the same as your class name in your java file Edit the portletentityregistry.xml file

49 Build our First Portlet Edit the pageregistry.xml file

50 Build our First Portlet

51 Part Four An API Tour

52 GenericPortlet Base class for java portlet specification Implements Portlet and PortletConfig interfaces of the portlet API Key methods dodispatch() doview() dohelp() doedit()

53 Portlet Interface init() processaction(actionrequest, ActionResponse) render(renderrequest, RenderResponse) destroy() «interface» PortletRequest «interface» PortletResponse «interface» ActionRequest «interface» RenderRequest «interface» ActionResponse «interface» RenderResponse

54 RenderResponse object Content Types Portlets can produce content using the RenderResponse writer or it may delegate generation of content to a servlet or.jsp Set content type public void setcontenttype(string type); Get Default Content Type for the Portal public String getresponseconenttype(); List of all supported content types public java.util.enumeration getresponsecontenttypes()

55 RenderResponse object Writing Content to a Portal Page Where portlets can write Output stream Writer Most use getwriter() method on the RenderResponse object public java.io.printwriter getwriter() throws java.io.exception;

56 PortletURL A portlet can create a URL that targets itself inside the portlet container PortletURL s Key methods on RenderResponse createrenderurl() createactionurl() Key PortletURL object methods setparameter(string name, String value) setparameters(java.util.map parameters) setsecure() [true to enable security, false to disable it]

57 What does a Portlet Have to Implement? GenericPortlet s gettitle() doview() Constructor

58 Lifecycle of a Portlet Creation of the portlet Loading the classes Invocation of constructor init() Processing Requests render() processaction() Death of a Portlet destroy()

59 Portlet Requests Request Attributes «interface» ActionRequest «interface» PortletRequest «interface» RenderRequest Request Attributes Pass java objects between portlets, servlets & JSP s PortletRequest Attributes are identical to HTTPServletRequest attributes

60 Portlet Requests Request Properties «interface» ActionRequest «interface» PortletRequest «interface» RenderRequest Request Properties Allows access to container or server properties Vendor dependent Not portable across implementations

61 Portlet Requests Request Parameters «interface» ActionRequest «interface» PortletRequest «interface» RenderRequest Request Parameters Name value pair String object name One or more String object values

62 Portlet Requests Request Security «interface» ActionRequest «interface» PortletRequest «interface» RenderRequest Request Security getauthtype() getremoteuser() isuserinrole() getuserprincipal()

63 Portlet Responses PortletResponse Base Interface «interface» ActionResponse «interface» PortletResponse «interface» RenderResponse Three methods setproperty(string key, String value) addproperty(string key, String value) encodeurl()

64 Portlet Responses RenderResponse Interface «interface» ActionResponse «interface» PortletResponse «interface» RenderResponse Numerous Methods createactionurl() createrenderurl() setcontenttype() settitle() getnamespace() getlocale().

65 Portlet Responses ActionResponse Interface «interface» ActionResponse «interface» PortletResponse «interface» RenderResponse Numerous Methods setwindowstate() throws WindowStateException setportletmode() throws PortletModeException sendredirect() setrenderparameter() setrenderparameters().

66 PortletContext PortletConfig Interface provides access getportletcontext() PortletContext getserverinfo() Returns a string that provides the name and version number of the portlet container getmajorversion() / getminorversion() Return major and minor versions of the portlet API

67 Portlet Sessions PortletSession Object Obtained through a PortletRequest object A façade over HTTPSession getportletsession()

68 Part Five EXO Portal

69 EXO Portlet Deployment

70 Build.xml Modifications for EXO

71 Result One WAR for Each Portal

72 Seeing the EXO Deployment

73 EXO Deployment Eclipse Plugin Demo

74 General Thoughts on EXO- Portal Deployment documentation is unclear Reasonably well organized Not written by somebody who understands How to use a spell checker The English language LocalHost deployment on Tomcat crashed and/or exhibited non-deterministic behavior frequently.

75 Part Six Jetspeed

76 Portlets on Jetspeed! Basic Requirements It is expected that the user is familiar with both the Apache Maven project tool and the Apache Ant build tool. Ant 1.5 or higher Maven 1.0 or higher Java 1.4 or higher Servlet 2.3: Tomcat 4.1.x or Tomcat 5.x

77 Portlets on Jetspeed! CVS Checkout Instructions Web Access Anonymous CVS Access This project's CVS repository can be checked out through anonymous (pserver) CVS with the following instruction set. When prompted for a password for anonymous, simply press the Enter key. cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login cvs -z3 -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic co jakarta-jetspeed-2 Updates from within the module's directory do not need the -d parameter.

78 Portlets on Jetspeed! Building Jetspeed -1

79 Portlets on Jetspeed! Building Jetspeed -2 Building Jetspeed 2 If you are using the default Hypersonic database, this procedure requires two terminal sessions. If you are using another database, skip the immediate section below on Terminal Session #1. Terminal session #2, build the portal and all components and unit test Jetspeed-2:! " #!

80 Portlets on Jetspeed! Building Jetspeed -3

81 Portlets on Jetspeed! Building Jetspeed -4 Deploying Jetspeed into Tomcat We only cover deploying to Tomcat 4 and Tomcat 5. Step #1 below is optional if you are NOT using the default Hypersonic database. 1. If you are using the Hypersonic SQL database, make sure you have terminated the test HSQLserver. Then in the same terminal, start the production Hypersonic database by typing maven start.production.server 2. (in seperate window/terminal session) cd ${jetspeed-2-home} 3. maven quickstart This will recreate the DB to deploy into. WARNING This will drop all the tables and data in the production database. 4. Start up Tomcat. With a browser, go to:

82 Portlets on Jetspeed! Building Jetspeed -5

83 Portlets on Jetspeed! Portlet Deployment 1

84 Portlets on Jetspeed! Portlet Deployment 2 Ya put your.war filed portlet in here

85 Portlets on Jetspeed! Portlet Deployment 3 <fragment id="88" type="portlet" name="dodgers::dodgersdone"> <property layout="twocolumns" name="row" value= 4" /> <property layout="twocolumns" name="column" value="0" /> </fragment> Notice the Syntax similarity with pluto dodgers.dodgersdone

86 Portlets on Jetspeed! Portlet Deployment 4 Documentation Says You don t need to Restart tomcat for the changes to be recognized Half True If you don t, it does show the portlet frame But, the portlet doesn t work until you restart tomcat

87 Portlets on Jetspeed! Portlet Deployment 5

88 Jetspeed General Thoughts Jetspeed 1 is relatively stable, but not JSR- 168 compliant Jetspeed 2 is unstable Portlets work and minutes later don t work Sometimes the container won t start. And then it will Like Pluto, there is no binary download available yet.

89 Part Seven Miscellaneous Notes & My Favorite Open Source Portal Liferay

90 Open Source Portlets

91 Liferay I ve been running a Liferay Portal 24/7 for two years using Jboss & Oracle Decent Eclipse setup instructions available Quite the Resource Pig Requires knowledge of J2EE beyond servlets &.jsp s to operate Learning curve is steeper, but the flexibility and stability far exceed other portals I ve shown here tonight.

92 Liferay Deployment

93 Thank You