WSRPEngine

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.wsrp4j.producer.driver
Class WSRPEngine

java.lang.Object
  org.apache.wsrp4j.producer.driver.WSRPEngine

All Implemented Interfaces:: java.rmi.Remote, WSRP_v1_Markup_PortType, WSRP_v1_PortletManagement_PortType, WSRP_v1_Registration_PortType, WSRP_v1_ServiceDescription_PortType

public class WSRPEngine
extends java.lang.Object
implements WSRP_v1_PortletManagement_PortType, WSRP_v1_Markup_PortType, WSRP_v1_Registration_PortType, WSRP_v1_ServiceDescription_PortType

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
`PortletContext`	`clonePortlet(ClonePortlet request)` Calls the PortletPool to clone a portlet.
`ReturnAny`	`deregister(RegistrationContext request)` Deregisters a certain consumer identified by a registration handle within the ConsumerRegistry.
`DestroyPortletsResponse`	`destroyPortlets(DestroyPortlets request)` Removes all portlets corresponding to the provided portlet handles from the PortletPool.
`static WSRPEngine`	`getInstance()` Internal method.
`MarkupResponse`	`getMarkup(GetMarkup request)` Requests the markup for rendering the current state of a portlet by calling the PortletInvoker.
`PortletDescriptionResponse`	`getPortletDescription(GetPortletDescription request)` Fetches a PortletDescription from the DescriptionHandler.
`PropertyList`	`getPortletProperties(GetPortletProperties request)` Fetches the current property values of a portlet and returns them.
`PortletPropertyDescriptionResponse`	`getPortletPropertyDescription(GetPortletPropertyDescription request)` Returns a model description containing the property descriptions of all properties of a portlet.
`ServiceDescription`	`getServiceDescription(GetServiceDescription request)` Allows a Producer to provide information about its capabilities.
`ReturnAny`	`initCookie(InitCookie request)` Creates a new HTTP session and initializes it
`RegistrationState`	`modifyRegistration(ModifyRegistration request)` Modifies the registration of a certain consumer.
`BlockingInteractionResponse`	`performBlockingInteraction(PerformBlockingInteraction request)` Invokes a blocking interaction with the adressed portlet by calling the PortletInvoker
`RegistrationContext`	`register(RegistrationData request)` Calls the ConsumerRegistry to register a certain consumer.
`ReturnAny`	`releaseSessions(ReleaseSessions request)` Destroys the sessions adressed by the delivered sessionIDs.
`PortletContext`	`setPortletProperties(SetPortletProperties request)` Sets the properties of a portlet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static WSRPEngine getInstance()
                              throws java.rmi.RemoteException

Internal method. Returns an instance of the WSRPEngine

Returns:: WSRPEngine
Throws:: java.rmi.RemoteException

getServiceDescription

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

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.

Specified by:: getServiceDescription in interface WSRP_v1_ServiceDescription_PortType

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

register

public RegistrationContext register(RegistrationData request)
                             throws java.rmi.RemoteException

Calls the ConsumerRegistry to register a certain consumer. Returns a registration context including a new registration handle.

Specified by:: register in interface WSRP_v1_Registration_PortType

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

deregister

public ReturnAny deregister(RegistrationContext request)
                     throws java.rmi.RemoteException

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.

Specified by:: deregister in interface WSRP_v1_Registration_PortType

Parameters:: request - a generated wrapper containing all input arguments for this method
Throws:: java.rmi.RemoteException; InvalidRegistration - The given registrationhandle is invalid / not yet registered

modifyRegistration

public RegistrationState modifyRegistration(ModifyRegistration request)
                                     throws java.rmi.RemoteException

Modifies the registration of a certain consumer. Throws an InvalidRegistration if there is no consumer registered with the given registration handle.

Specified by:: modifyRegistration in interface WSRP_v1_Registration_PortType

Parameters:: request - a generated wrapper containing all input arguments for this method
Returns:: A RegistrationState-object if the Producer chooses to have the Consumer provide persistent storage for those registration states, else null.
Throws:: java.rmi.RemoteException

getMarkup

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

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.

Specified by:: getMarkup in interface WSRP_v1_Markup_PortType

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

performBlockingInteraction

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

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

Specified by:: performBlockingInteraction in interface WSRP_v1_Markup_PortType

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

initCookie

public ReturnAny initCookie(InitCookie request)
                     throws java.rmi.RemoteException

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).

Specified by:: initCookie in interface WSRP_v1_Markup_PortType

Parameters:: request - a generated wrapper containing all input arguments for this method
Returns:: null
Throws:: java.rmi.RemoteException; MissingParameterFault; InvalidRegistration

releaseSessions

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

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).

Specified by:: releaseSessions in interface WSRP_v1_Markup_PortType

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

getPortletDescription

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

Fetches a PortletDescription from the DescriptionHandler.

Specified by:: getPortletDescription in interface WSRP_v1_PortletManagement_PortType

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

clonePortlet

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

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).

Specified by:: clonePortlet in interface WSRP_v1_PortletManagement_PortType

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

destroyPortlets

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

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.