Java Doc for WSRPEngine.java in » Portal » liferay-portal-4.4.2 » org » apache » wsrp4j » producer » driver » 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.driver

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.apache.wsrp4j.producer.driver .WSRPEngine

WSRPEngine

public class WSRPEngine implements oasis.names.tc.wsrp.v1.intf.WSRP_v1_PortletManagement_PortType,oasis.names.tc.wsrp.v1.intf.WSRP_v1_Markup_PortType,oasis.names.tc.wsrp.v1.intf.WSRP_v1_Registration_PortType,oasis.names.tc.wsrp.v1.intf.WSRP_v1_ServiceDescription_PortType(Code)

Implements the WSRP-interfaces:

Service Description Interface (required): Defines an operation for acquiring the Producer's metadata.
Markup Interface (required): Defines operations for getting markup from a portlet as well as processing user interactions with that markup. Contains also the operation for Consumer assistance in pre-initializing HTTP-cookies.
Registration Interface (optional): Defines operations for establishing, updating and destroying a regisration. Each registration reflects a particular relationship between a Consumer and a Producer.
Portlet Management Interface (optional): Defines operations for getting portlet metadata, cloning portlets for further customization and interacting with the property interface.

All methods are implemented by calling the corresponding sub-components (Producer- and Provider-side components). Additionally each method implementation performs high level checks (e.g. a parameter validation to ensure that all required input parameters are available) and maps internal exceptions to exceptions defined vy WSRP.

Involves additional servlet related objects -> no mapping of the interfaces possible

Method Summary
public PortletContext	clonePortlet(ClonePortlet request) Calls the PortletPool to clone a portlet. Throws InvalidHandleFault if there is no portlet to be cloned in the PortletPool that corresponds to the provided portlet handle.
public ReturnAny	deregister(RegistrationContext request) Deregisters a certain consumer identified by a registration handle within the ConsumerRegistry.
public DestroyPortletsResponse	destroyPortlets(DestroyPortlets request) Removes all portlets corresponding to the provided portlet handles from the PortletPool.
public static synchronized WSRPEngine	getInstance() Internal method.
public MarkupResponse	getMarkup(GetMarkup request) Requests the markup for rendering the current state of a portlet by calling the PortletInvoker. Throws InvalidHandleFault if there is no portlet in the PortletPool that corresponds to the provided portlet handle.
public PortletDescriptionResponse	getPortletDescription(GetPortletDescription request) Fetches a PortletDescription from the DescriptionHandler. Throws InvalidHandleFault if there is no portlet in the PortletPool that corresponds to the provided portlet handle.
public PropertyList	getPortletProperties(GetPortletProperties request) Fetches the current property values of a portlet and returns them. Throws InvalidHandleFault if there is no portlet in the PortletPool that corresponds to the provided portlet handle.
public PortletPropertyDescriptionResponse	getPortletPropertyDescription(GetPortletPropertyDescription request) Returns a model description containing the property descriptions of all properties of a portlet. Throws InvalidHandleFault if there is no portlet in the PortletPool that corresponds to the provided portlet handle.
public ServiceDescription	getServiceDescription(GetServiceDescription request) Allows a Producer to provide information about its capabilities.
public ReturnAny	initCookie(InitCookie request)
public RegistrationState	modifyRegistration(ModifyRegistration request) Modifies the registration of a certain consumer.
public BlockingInteractionResponse	performBlockingInteraction(PerformBlockingInteraction request) Invokes a blocking interaction with the adressed portlet by calling the PortletInvoker Throws InvalidHandleFault if there is no portlet in the PortletPool that corresponds to the provided portlet handle.
public RegistrationContext	register(RegistrationData request) Calls the ConsumerRegistry to register a certain consumer. Returns a registration context including a new registration handle.
public ReturnAny	releaseSessions(ReleaseSessions request) Destroys the sessions adressed by the delivered sessionIDs.
public PortletContext	setPortletProperties(SetPortletProperties request) Sets the properties of a portlet. Throws InvalidHandleFault if there is no portlet in the PortletPool that corresponds to the provided portlet handle.

Method Detail

clonePortlet

public PortletContext clonePortlet(ClonePortlet request) throws java.rmi.RemoteException(Code)

Calls the PortletPool to clone a portlet.

Throws InvalidHandleFault if there is no portlet to be cloned in the PortletPool that corresponds to the provided portlet handle. Throws InvalidRegistration if there is no registration with the given registration handle available within the ConsumerRegistry (case registration is required).

Parameters:
request - a generated wrapper containing all input arguments for this method
exception:
java.rmi.RemoteException -

deregister
public ReturnAny deregister(RegistrationContext request) throws java.rmi.RemoteException(Code)
	Deregisters a certain consumer identified by a registration handle within the ConsumerRegistry. Throws an InvalidRegistration if there is no consumer registered with the given registration handle. Parameters: request - a generated wrapper containing all input arguments for this method exception: java.rmi.RemoteException - throws: InvalidRegistration - The given registrationhandle is invalid / not yet registered

destroyPortlets

public DestroyPortletsResponse destroyPortlets(DestroyPortlets request) throws java.rmi.RemoteException(Code)

Removes all portlets corresponding to the provided portlet handles from the PortletPool. All portlet handles refering to portlets that cannot be destroyed (e.g. portlet handles from Producer Offered Portlets) will be returned within the DestroyPortletResponse as DestroyFailed-objects.

Throws InvalidRegistration if there is no registration with the given registration handle available within the ConsumerRegistry (case registration is required).

Parameters:
request - a generated wrapper containing all input arguments for this method
exception:
java.rmi.RemoteException -

getInstance
public static synchronized WSRPEngine getInstance() throws java.rmi.RemoteException(Code)
	Internal method. Returns an instance of the WSRPEngine WSRPEngine

getMarkup

public MarkupResponse getMarkup(GetMarkup request) throws java.rmi.RemoteException(Code)

Requests the markup for rendering the current state of a portlet by calling the PortletInvoker.

Throws InvalidHandleFault if there is no portlet in the PortletPool that corresponds to the provided portlet handle. Throws InvalidRegistration if there is no registration with the given registration handle available within the ConsumerRegistry (case registration is required).

Fetches the portlet description from the DescriptionHandler to figure out whether the portlet supports template processing or not. If so, it checks whether templates are provided or not.

Parameters:
request - a generated wrapper containing all input arguments for this method MarkupResponse
exception:
java.rmi.RemoteException -

getPortletDescription

public PortletDescriptionResponse getPortletDescription(GetPortletDescription request) throws java.rmi.RemoteException(Code)

Fetches a PortletDescription from the DescriptionHandler.

Parameters:
request - a generated wrapper containing all input arguments for this method
exception:
java.rmi.RemoteException -

getPortletProperties

public PropertyList getPortletProperties(GetPortletProperties request) throws java.rmi.RemoteException(Code)

Fetches the current property values of a portlet and returns them.

Parameters:
request - a generated wrapper containing all input arguments for this method PropertyList containing all properties of the adressed portlet
exception:
java.rmi.RemoteException -

getPortletPropertyDescription

public PortletPropertyDescriptionResponse getPortletPropertyDescription(GetPortletPropertyDescription request) throws java.rmi.RemoteException(Code)

Returns a model description containing the property descriptions of all properties of a portlet.

Parameters:
request - a generated wrapper containing all input arguments for this method
exception:
java.rmi.RemoteException -

getServiceDescription

public ServiceDescription getServiceDescription(GetServiceDescription request) throws java.rmi.RemoteException(Code)

Allows a Producer to provide information about its capabilities. Producers may choose to restrict the information returned in ServiceDescription based on the supplied RegistrationContext.

Checks registration (if required) by querying the ConsumerRegistry and calls the DescriptionHandler to get the service description.

Parameters:
request - a generated wrapper containing all input arguments for this method ServiceDescription
exception:
java.rmi.RemoteException -

initCookie
public ReturnAny initCookie(InitCookie request) throws java.rmi.RemoteException(Code)
	Creates a new HTTP session and initializes it Throws InvalidRegistration if there is no registration with the given registration handle available within the ConsumerRegistry (if registration is required). Parameters: request - a generated wrapper containing all input arguments for this method exception: java.rmi.RemoteException - null throws: MissingParameterFault - throws: InvalidRegistration -

modifyRegistration
public RegistrationState modifyRegistration(ModifyRegistration request) throws java.rmi.RemoteException(Code)
	Modifies the registration of a certain consumer. Throws an InvalidRegistration if there is no consumer registered with the given registration handle. Parameters: request - a generated wrapper containing all input arguments for this method A RegistrationState-object if the Producer chooses to have the Consumer providepersistent storage for those registration states, else null. exception: java.rmi.RemoteException -

performBlockingInteraction

public BlockingInteractionResponse performBlockingInteraction(PerformBlockingInteraction request) throws java.rmi.RemoteException(Code)

Invokes a blocking interaction with the adressed portlet by calling the PortletInvoker

Parameters:
request - a generated wrapper containing all input arguments for this method BlockingInteractionResponse
exception:
java.rmi.RemoteException -

register
public RegistrationContext register(RegistrationData request) throws java.rmi.RemoteException(Code)
	Calls the ConsumerRegistry to register a certain consumer. Returns a registration context including a new registration handle. Parameters: request - a generated wrapper containing all input arguments for this method RegistrationContext exception: java.rmi.RemoteException -

releaseSessions

public ReturnAny releaseSessions(ReleaseSessions request) throws java.rmi.RemoteException(Code)

Destroys the sessions adressed by the delivered sessionIDs. Returns null by default.

Throws InvalidRegistration if there is no registration with the given registration handle available within the ConsumerRegistry (case registration is required).

Parameters:
request - a generated wrapper containing all input arguments for this method null

setPortletProperties

public PortletContext setPortletProperties(SetPortletProperties request) throws java.rmi.RemoteException(Code)

Sets the properties of a portlet.

Parameters:
request - a generated wrapper containing all input arguments for this method
exception:
java.rmi.RemoteException -

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.