Java Doc for PortletPool.java in » Portal » liferay-portal-4.4.2 » org » apache » wsrp4j » producer » provider » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » liferay portal 4.4.2 » org.apache.wsrp4j.producer.provider

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.apache.wsrp4j.producer.provider .PortletPool

All known Subclasses:   com.liferay.portal.wsrp .PortletPoolImpl,
PortletPool
public interface PortletPool (Code)

This class provides the interface to the portlet pool. All portlets (producer offered as well as consumer configured portlets) should be kept within the portlet pool. It is recommended that this interface is implemented by a container associating portlet handles with portlet-objects.

author:
   Stefan Behl

Method Summary
public Portlet clone(String portletHandle)

Clones an portlet (Producer Offered or Consumer Configured Portlet) associated by portlet-handle.
public boolean destroy(String portletHandle)

Deletes the portlet identified by portletHandle from the PortletPool. Only consumer configured portlets can be deleted, NOT producer offered ones. After update, the persistent file store is refreshed.

Deletes all existing portlet sessions (SessionHandler) and portlet states (PortletStateManager) as well.

Throws CommonException if portlet corresponding to portletHandle could not be found.

Parameters:
  portletHandle - String representing the portletHandle.
public Iterator destroySeveral(Iterator portletHandles)
     Deletes several portlets from the PortletPool.
Parameters:
  portletHandles - Iterator of portletHandles.
public Portlet get(String portletHandle)
     Returns a certain portlet identified by portletHandle. Throws CommonException if there is no portlet corresponding to portletHandle.
Parameters:
  portletHandle - String representing the portletHandle.
public Iterator getAllConsumerConfiguredPortlets()
     Returns all portlets that are currently stored within the PortletPool.
public Iterator getAllProducerOfferedPortlets()
     Returns all portlets that are currently stored within the PortletPool.

Method Detail
clone
public Portlet clone(String portletHandle) throws WSRPException(Code)

Clones an portlet (Producer Offered or Consumer Configured Portlet) associated by portlet-handle. Only the portlet-object should be cloned, not the portlet-description the portlet references.

Adds the new Consumer Configured Portlet (after assigning a new portletHandle)to the hashmap after cloning.

Creates a new portlet state corresponding to the portlet state of the portlet to be cloned by calling the PortletStateManager.

Throws CommonException if portlet to be cloned could not be found

Parameters:
  portletHandle - String identifying the portlet to be cloned. ConsumerConfiguredPortlet The portlet-clone.

destroy
public boolean destroy(String portletHandle) throws WSRPException(Code)

Deletes the portlet identified by portletHandle from the PortletPool. Only consumer configured portlets can be deleted, NOT producer offered ones. After update, the persistent file store is refreshed.

Deletes all existing portlet sessions (SessionHandler) and portlet states (PortletStateManager) as well.

Throws CommonException if portlet corresponding to portletHandle could not be found.

Parameters:
  portletHandle - String representing the portletHandle. Boolean indicating if deletion was successful. Returns false, if portletHandlerefers to a producer offered portlet.

destroySeveral
public Iterator destroySeveral(Iterator portletHandles)(Code)
Deletes several portlets from the PortletPool.
Parameters:
  portletHandles - Iterator of portletHandles. Iterator containing those portletHandles refering to portletsthat could not be deleted (e.g. producer offered portlets).

get
public Portlet get(String portletHandle) throws WSRPException(Code)
Returns a certain portlet identified by portletHandle. Throws CommonException if there is no portlet corresponding to portletHandle.
Parameters:
  portletHandle - String representing the portletHandle. ProducerOfferedPortlet portlet-object identified by portletHandle.

getAllConsumerConfiguredPortlets
public Iterator getAllConsumerConfiguredPortlets()(Code)
Returns all portlets that are currently stored within the PortletPool. Iterator of an portlet collection containing all portlets.

getAllProducerOfferedPortlets
public Iterator getAllProducerOfferedPortlets()(Code)
Returns all portlets that are currently stored within the PortletPool. Iterator of an portlet collection containing all portlets.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.