RE: [wsrp][interfaces and protocols]: Portal using WSRP Service

[Thomas Schaeck <SCHAECK@de.ibm.com>]

I added some more detail, adding the separation between creating bindings
and templates ...

I had to write it up in a hurry, so some details may be a little imprecise;
I'll refine it after the next call, maybe in a document since the note is
getting quite large.

Binding to a WSRP Service
-------------------------

Pre: - The Portal and the WSRP Portlet Service are not bound -

1. The administrator browses the directory for WSRP services using the
portal admin UI -->
- The Portal finds the WSRP Portlet Service in the directory

2. The administrator selects a WSRP service -->
- The Portal makes a call or series of calls to the WSRP Portlet Service to
establish a relation (bind) (may include establishing a trust relation, see
my security note)

Post: - The portal is bound to the WSRP service through the consumer ID -

Creating Portlet Template(s)
----------------------------

Note: Not all services will require explicit creation of templates on the
server side. Many will not support templates and will not need to expose
the create/.../delete template operations. For them, it is sufficient to
create a template on the consumer's side referencing the service itself
rather than distinct templates of the service.

Pre: - The portal is bound to the WSRP service through the consumer ID

3. The Portal creates a portlet template referencing the WSRP portlet
service.

3'.Optionally, the WSRP portlet service may support create/.../delete
template operations. In this case, the portal also requests creation of a
template on the server side and lets the client side portlet template
reference the service and the server side template.

Note: The server side template may need to be parameterized with template
settings to become usable, this may be done via a config mode in the WSRP
service's UI or via exposed template properties.

Post: - The portal is bound to the WSRP service through the consumer ID. In
the scope of the consumer ID, 1 or more templates exist. Users may now see
the template(s) beeing offered in the portal's customizer -

Creation of Instances
---------------------

Pre: - The portal is bound to the WSRP service (and optionally to a server
side template "within" the service) through the client side portlet
template, users may now see the client side template beeing offered in the
portal's customizer/toolbox -

4. A portal user selects the portlet template to be put on a page -->
- The portal server creates a portlet instance from the portlet template,
obtaining an instance ID
- The portal server links the instance to the user's page

Post: - The portal is bound to the WSRP service (and optionally to a server
side template "within" the service) through the client side portlet
template. In the scope of the consumer ID, 1 or more templates exist. Users
may now see the client side template beeing offered in the portal's
customizer/toolbox and a unique instance which may have persistent data now
exists for the user -

Usage of Instances
------------------

Pre: - The portal is bound to the WSRP service (and optionally to a server
side template "within" the service) through the client side portlet
template. In the scope of the consumer ID, 1 or more templates exist. Users
may now see the client side template beeing offered in the portal's
customizer/toolbox and a unique instance which may have persistent data now
exists for the user -

5. The portal user navigates to a page that shows the portlet instance -->
a) The portal sends a getMarkup request to the WSRP portlet service,
providing the instance ID
b) The WSRP portlet service returns markup, optionally the markup may have
embedded action links
c) If the returned merkup has embedded action links, the user may click
them
c1) The portal calls the processAction operation with the instance ID
c2) cont. at 5 b) or c), depending on whether the service interacts with
other services via backend state (if it does, processAction and getMarkup
must be separated, otherwise the processAction operation may immediately
return markup)

Post: - The portal is bound to the WSRP service (and optionally to a server
side template "within" the service) through the client side portlet
template. In the scope of the consumer ID, 1 or more templates exist. Users
may now see the client side template beeing offered in the portal's
customizer/toolbox and a unique instance which may have persistent data now
exists for the user -

Destruction of Instances
------------------------

Pre: - The portal is bound to the WSRP service through the portlet
template, users may now see the template beeing offered in the portal's
customizer/toolbox and a unique instance which may have persistent data now
exists for the user -

5. A portal user discards a portlet instance from a page -->
- The portal discards the link from the page to the instance
- The portal discards the instance

Pre: - The portal is bound to the WSRP service through the portlet
template, users may now see the template beeing offered in the portal's
customizer/toolbox, the unique instance does no longer exist -

Destruction of Templates (optional)
-----------------------------------

Pre: - The portal is bound to a WSRP service through a consumer ID, a
portlet templates exists in the scope of the consumer ID, users may see the
template beeing offered in the portal's customizer -

6. The adminstrator browses the list of portlet tempplates and discards a
portlet template -->
- The portal makes a call to the WSRP Portlet Service referenced in the
portlet template to discard it
- The portal discards the client side representation of the portlet
template

Post: - The portal is bound to a WSRP service through a consumer ID, the
portlet template in the scope of the consumer ID does no longer exist

Unbinding a WSRP service
------------------------

Pre: - The portal is bound to a WSRP service through a consumer ID -

7. The administrator uses an administration UI to unbind from a service.
- The unbinding operation automatically invalidates all instances and
template instances in the scope if the binding together with the consumer
ID that identifies the binding.

Post: - The Portal and the WSRP Portlet Service are not bound anymore -

Best regards,

Thomas


Sasha Aickin <AlexanderA@plumtree.com> on 04/12/2002 05:00:49 AM

Please respond to Sasha Aickin <AlexanderA@plumtree.com>

To:    Thomas Schaeck/Germany/IBM@IBMDE, Michael Freedman
       <Michael.Freedman@oracle.com>, wsrp@lists.oasis-open.org
cc:
Subject:    RE: [wsrp][interfaces and protocols]: Portal using WSRP Service



Thomas,

I would separate your step 2 into two different steps: binding the
portlet service and creating a portlet template.  We talked about this
today in the Interfaces & Protocols concall, and I think it is an
important distinction.  As a portal, you probably want to register the
portlet web service (negotiating trust and behavior, etc.) just once,
but you will probably want to create many templates (giving different
administrative parameterizations to the portlet).  We came up with the
term "Bound Portlet Service" to describe what you have when you have
bound to a service but have not created any templates yet.  What do
folks think of the term?

Cheers,
Sasha.

-----Original Message-----
From: Thomas Schaeck [mailto:SCHAECK@de.ibm.com]
Sent: Sunday, April 07, 2002 8:19 AM
To: Michael Freedman; wsrp@lists.oasis-open.org
Subject: Re: [wsrp][interfaces and protocols]: Portal using WSRP Service



Hi Mike,

here's the life-cycle writeup I promised:

Binding to a WSRP Service
-------------------------

Pre: - The Portal and the WSRP Portlet Service are not bound -

1. The administrator browses the directory for WSRP services using the
portal admin UI -->
- The Portal finds the WSRP Portlet Service in the directory

2. The administrator selects a WSRP service -->
- The Portal makes a call or series of calls to the WSRP Portlet Service
to
establish a relation (bind) (may include establishing a trust relation,
see
my security note)
- The Portal creates a portlet template referencing the WSRP portlet
service. (Potentially, the template may need to be parameterized with
template settings to become usable.)

Post: - The portal is bound to the WSRP service through the portlet
template, users may now see the template beeing offered in the portal's
customizer -

Creation of Instances
---------------------

Pre: - The portal is bound to the WSRP service through the portlet
template, users may now see the template beeing offered in the portal's
customizer/toolbox -

3. A portal user selects the portlet template to be put on a page -->
- The portal server creates a portlet instance from the portlet template
- The portal server links the instance to the user's page

Post: - The portal is bound to the WSRP service through the portlet
template, users may now see the template beeing offered in the portal's
customizer/toolbox and a unique instance which may have persistent data
now
exists for the user

Destruction of Instances
------------------------

Pre: - The portal is bound to the WSRP service through the portlet
template, users may now see the template beeing offered in the portal's
customizer/toolbox and a unique instance which may have persistent data
now
exists for the user

4. A portal user discards a portlet instance from a page -->
- The portal discards the link from the page to the instance
- The portal discards the instance

Pre: - The portal is bound to the WSRP service through the portlet
template, users may now see the template beeing offered in the portal's
customizer/toolbox, the unique instance does no longer exist

Unbinding a WSRP service
------------------------

Pre: - The portal is bound to a WSRP service through a portlet template,
users may now see the template beeing offered in the portal's customizer
-

5. The adminstrator browses the list of portlet tempplates and discards
the
portlet template -->
- The portal makes a call to the WSRP Portlet Service referenced in the
portlet template to undo the binding
- The portal discards the portlet template

Post: - The Portal and the WSRP Portlet Service are not bound -

Best regards,

Thomas



----------------------------------------------------------------
To subscribe or unsubscribe from this elist use the subscription
manager: <http://lists.oasis-open.org/ob/adm.pl>

----------------------------------------------------------------
To subscribe or unsubscribe from this elist use the subscription
manager: <http://lists.oasis-open.org/ob/adm.pl>