Java Portlet Specification: Difference between revisions

Revision as of 00:56, 3 March 2024

Latest revision as of 14:18, 21 March 2024

(One intermediate revision by the same user not shown)

Line 1:

{{Short description|Technical standard}}

{{more citations needed|date=January 2013}}

A '''Java Portlet Specification''' ('''JSR''') defines a [[design by contract|contract]] between [[Portlet|portlets]] and their [[Portlet container|containers]]; they provides a convenient [[programming model]] for [[Java (programming language)|Java]] portlet [[Developer (software)|developers]]. It is defined through various Java Specification Requests (JSRs).

'''Portlets''' are [[Pluggable look and feel|pluggable]] [[user interface]] [[Software component|software components]] that are managed and displayed in a [[web portal]]. A portlet responds to requests from a web client with and generates dynamic content. A portlet is managed by a '''portlet container'''.

== Background ==

{{Split|date=February 2024|Portlet|discuss=Talk:Java Portlet Specification#Portlet}}

A portlet is a [[Pluggable look and feel|pluggable]] [[user interface]] [[software component]] that is managed and displayed in a [[web portal]],<ref>{{Cite web |title=PORTLET &#124; definition in the Cambridge English Dictionary |url=https://dictionary.cambridge.org/us/dictionary/english/portlet}}</ref><ref>{{Cite web |title=Portlet Definition &#124; GIS Dictionary |url=https://support.esri.com/en-us/gis-dictionary/portlet |website=support.esri.com}}</ref><ref>{{Cite web |title=Definition of portlet |url=https://www.pcmag.com/encyclopedia/term/portlet |website=PCMAG}}</ref> for example an [[enterprise portal]] or a [[web CMS]]. A portlet can [[Web aggregator (disambiguation)|aggregate]] (integrate) and personalize content from different sources within a web page. A portlet responds to requests from a web client with and generates dynamic content.<ref name=":0">{{Cite book |last=Sarin |first=Ashish |url=https://books.google.com/books?id=kTozEAAAQBAJ&dq=Portlet+standard+-java&pg=PT246 |title=Portlets in Action |date=2011-09-15 |publisher=Simon and Schuster |isbn=978-1-63835-236-5 |at=1.5.1 The portlet container |language=en}}</ref>

Portlets produce fragments of [[Markup language|markup]]<ref name=":1">{{Cite book |last1=Guo |first1=Yuanbo |url=https://books.google.com/books?id=md_zBwAAQBAJ&dq=Portlet+standard+-java&pg=PA32 |title=Web Information Systems Engineering - WISE 2005 Workshops: WISE 2005 International Workshops, New York, NY, USA, November 20-22, 2005, Proceedings |last2=Jun |first2=Woochun |last3=Kaschek |first3=Roland |last4=Krishnaswamy |first4=Shonati |last5=Pan |first5=Zhengxiang |last6=Sheng |first6=Quan Z. |date=2005-10-24 |publisher=Springer |isbn=978-3-540-32287-0 |page=22 |language=en}}</ref><ref>{{Cite web |date=2019-01-04 |title=Markup languages |url=https://www.ibm.com/docs/en/radfws/9.6.1?topic=portlet-markup-languages |access-date=2024-02-13 |website=www.ibm.com |language=en-us}}</ref> ([[HTML]], [[XHTML]], [[Wireless Markup Language|WML]]) that are aggregated into a portal.<ref name=":2">{{Cite book |last=Sarin |first=Ashish |url=https://books.google.com/books?id=kTozEAAAQBAJ&dq=Portlet+standard+-java&pg=PT246 |title=Portlets in Action |date=2011-09-15 |publisher=Simon and Schuster |isbn=978-1-63835-236-5 |at=1.3 What is a portlet? |language=en}}</ref> Hence, a portlet (or collection of portlets) resembles a [[web-based application]] that is hosted in a [[Web portal|portal]].<ref>{{Cite web |date=2014-10-01 |title=Portlets |url=https://gateway.maine.gov/cognos/documentation/en/ug_cra_c_portlets.html |access-date=2024-02-13 |website=gateway.maine.gov |language=en-us}}</ref> Some examples of portlet applications are [[e-mail]], [[Weather forecasting|weather reports]],<ref name=":2" /> [[Discussion forum|discussion forums]], and [[news]].

=== Portlet containersPortlets ===

{{Main|Portlet}}

A portlet is managed by a portlet container.<ref name=":1" /> A portlet container runs portlets, provides them with the required runtime environment, manages their life cycles.<ref name=":0" /> A container also provides persistent storage mechanisms for the portlet preferences.

'''Portlets'''A are[[portlet]] is a [[Pluggable look and feel|pluggable]] [[user interface]] [[Softwaresoftware component|software components]] that areis managed and displayed in a [[web portal]]. A portlet responds to requests from a web client with and generates dynamic content. ASome examples of portlet isapplications managedare by[[e-mail]], a[[weather '''portletforecasting|weather container'''reports]], [[discussion forum]]s, and [[news]].

==== Portlet containers ====

A portlet container receives requests from the portal to execute requests on the portlets hosted by it. A portlet container sends data to the portal for aggregation, but is not responsible for aggregating the content produced by the portlets; the portal itself handles aggregation.<ref name=":0" /> A portal and a portlet container can be built together as a single component of an application suite or as two separate components of a portal application.

A portlet is managed by a [[portlet container.<ref]], name=":1"which /> Aruns [[portlet]]s container runs portlets,and provides them with the required runtime environment,. managesA theirportlet lifecontainer cycles.<refreceives name=":0"requests />from Athe containerportal alsoto providesexecute persistentrequests storageon mechanismsthe forportlets thehosted portletby preferencesit.

== Specifications ==

Line 38 ⟶ 34:

=== JSR 286 ===

'''JSR-286''' is the Java Portlet specificationSpecification v2.0 as developed under the [[Java Community Process|JCP]] and created in alignment with the updated version 2.0 of [[Web Services for Remote Portlets|WSRP]]. It was released in June 2008.<ref>{{cite web | url = http://www.jcp.org/en/jsr/detail?id=286 | title = JSR 286: Portlet Specification 2.0}}</ref> It was developed to improve on the short-comings of the version 1.0 specification, JSR-168. Some of its major features include:<ref>

{{cite web | last = Hepper | first = Stefan | title = What's new in the Java Portlet Specification V2.0 (JSR 286)? | publisher = IBM | date = 18 March 2008 | url =http://www.ibm.com/developerworks/websphere/library/techarticles/0803_hepper/0803_hepper.html }}</ref>

* Inter-Portlet Communication through events and public render parameters

Line 46 ⟶ 42:

=== JSR 362 ===

'''JSR-362''' is the Java Portlet specificationSpecification v3.0 and was released in April 2017.<ref>{{cite web | title = JSR 362: Portlet Specification 3.0 | url = https://www.jcp.org/en/jsr/detail?id=362}}</ref> Some of its major features include:<ref>

{{cite web | last = Nicklous | first = Martin (Scott) | title = Portlet Specification 3.0 is Here! | publisher = IBM | date = September 2016 | url = https://static.rainfocus.com/oracle/oow16/sess/1462801563632001pOv8/ppt/JSR362-JavaOne-2016a.pdf }}</ref>

* Resource Dependencies