WSRP Interfaces

1

• WSRP Interfaces
• Transient Properties

2
Overview

• Transient properties are consumer managed
  transient state.
• Distinguished from Navigational Parameters in
  that they are state vs being inputs.
• Should we add in 2.0? Yes, reflect in draft 12

3
Transient Properties

• Transient Property  a piece of shared consumer
  managed state with a defined-nonpersistent
  lifetime declared by the producer and supplied to
  that producer in all non-initialization calls in
  its Markup port .
• i.e. not initCookie() or releaseSessions()

4
Transient Properties

• shared ... state the property can be
  set/received by any constituent of the consumer
  including the declaring portlet.
• consumer managed state  the consumer maintains
  the property and supplies it to the producer at
  appropriate times.
• defined non-persistent lifetime  lifetimes are
  defined by scope (names).

5
Transient Properties

• declared by the producer  the basic declaration
  includes a name, type, suggested default, scope.
• Property uniquely described by its scope name
• supplied to that producer on all
  non-initialization calls in its Markup port
• PerformBlockingInteraction(), HandleEvents(),
  GetMarkup(), and GetResource().

6
Scopes

• wsrpconsumerSession lifetime consumer session
  with client/user lt- define in v2
• wsrpconsumerRequest  lifetime consumer
  request. lt- do not define in v2
• wsrpconsumerApplication lifetime consumer
  active/running lt- do not define in v2

7
Structure/Details

•  ScopedPropertyDescription    R QName       
  name    R QName        type    O string   
     scope O LocalizedString    label    O
  LocalizedString    hint    O string    
  capabilities    O Extension     extensions
  
• Rather than introduce scopes for existing
  property usage, have this extend
  PropertyDescription and have the containing
  structure also have a ModelTypes

8
Possible Scopes

• Define
• wsrpconsumerSession duration of consumer's user
  session - Only one defined and required but
  null-able
• Do not define in v2
• wsrpconsumerRequest  single consumer request
• wsrpconsumerApplication duration of active
  consumer.
• wsrppersistent duration is persistent across
  consumer activations.
• wsrpregistration duration of this registration
• Unkown scopes get a value of null

9
PortletDescription

• Add a transientPropertyDescriptions field
• PortletDescription . O QName   
   handledEvents O ScopedPropertyDescription
  transientPropertyDescriptions O
  ModelTypes schemas O string
     userCategories .

10
Property Type

•  Property    R QName    name    O string   
  xmlLang    O Object    value
• // null is name with no value
• Note no indication of scope the property is at
  the scope where the portlet defined it

11
RuntimeContext

• Add transientProperties field
• RuntimeContext   R string   
  userAuthentication   O Key   
     portletInstanceKey   O string
     namespacePrefix   O string   
  interactionFieldPrefix   O Templates templates
     O ID        sessionID   O Property
  transientProperties   O Extension extensions
  

12
Registration Data

• Declaring custom consumer scopes?
• String customConsumerScopes
• wsrpconsumerSession scope is required but not to
  be passed (carry this to custom mode and
  windowState definitions)

13
Portlet setting a value

• PBIA and HandleEvents return a transientProperty
  array in response
• No encoding in URLs
• Should we allow return from getMarkup that is
  used in subsequent requests? No for now.