org.apache.wsrp4j.consumer.app.driver
Class WSRPRequestImpl

java.lang.Object
  extended byorg.apache.wsrp4j.consumer.driver.GenericWSRPBaseRequestImpl
      extended byorg.apache.wsrp4j.consumer.app.driver.WSRPRequestImpl
All Implemented Interfaces:
InteractionRequest, MarkupRequest, WSRPBaseRequest

public class WSRPRequestImpl
extends GenericWSRPBaseRequestImpl
implements InteractionRequest, MarkupRequest

Version:
$Id: WSRPRequestImpl.java,v 1.3 2005/08/10 14:45:38 cziegeler Exp $

Field Summary
private  ConsumerEnvironment consEnv
           
protected  Logger logger
           
private  Request request
           
private  SimplePortletWindowSession windowSession
           
 
Constructor Summary
WSRPRequestImpl(SimplePortletWindowSession session, Request req, ConsumerEnvironment env)
           
 
Method Summary
 oasis.names.tc.wsrp.v1.types.MarkupContext getCachedMarkup()
          Get the markup context if there is cached markup for this portlet instance or null in case of an empty markup cache.
 java.lang.String[] getCharacterEncodingSet()
          Get the character sets the consumer wants the remote portlet to use for encoding the markup.
 oasis.names.tc.wsrp.v1.types.ClientData getClientData()
          Get the ClientData structure which carries information about the end user agent.
 oasis.names.tc.wsrp.v1.types.NamedString[] getFormParameters()
          Get all name/value pairs aa result of processing an form
 java.lang.String getInteractionState()
          Get all the interaction state
 java.lang.String[] getLocales()
          Get the locales which are supported by the portlet according to the client connecting to it.
 java.lang.String[] getMimeTypes()
          Get an array of mime types which are supported by the end user device.
 java.lang.String getMode()
          Get the current mode of the portlet
 java.lang.String[] getModes()
          Get the list of wsrp modes which are supported by the portlet.
 java.lang.String getNavigationalState()
          Get the current navigational state of the portlet
 java.lang.String getPortletInstanceKey()
          Get an opaque string which corresponds to a unique reference to this use of the portlet.
 java.lang.String getSessionID()
          Get the ID of the session context
 java.lang.String getUserAuthentication()
          Get the method which is used by the consumer to authenticate its users.
 java.lang.String getWindowState()
          Get the current window state of the portlet
 java.lang.String[] getWindowStates()
          Get the list of wsrp window states which are supported by the portlet.
 
Methods inherited from class org.apache.wsrp4j.consumer.driver.GenericWSRPBaseRequestImpl
isModeSupported, isWindowStateSupported
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.wsrp4j.consumer.WSRPBaseRequest
isModeSupported, isWindowStateSupported
 

Field Detail

windowSession

private SimplePortletWindowSession windowSession

request

private Request request

consEnv

private ConsumerEnvironment consEnv

logger

protected Logger logger
Constructor Detail

WSRPRequestImpl

public WSRPRequestImpl(SimplePortletWindowSession session,
                       Request req,
                       ConsumerEnvironment env)
Method Detail

getSessionID

public java.lang.String getSessionID()
Description copied from interface: WSRPBaseRequest
Get the ID of the session context

Specified by:
getSessionID in interface WSRPBaseRequest
Specified by:
getSessionID in class GenericWSRPBaseRequestImpl

getPortletInstanceKey

public java.lang.String getPortletInstanceKey()
Description copied from interface: WSRPBaseRequest
Get an opaque string which corresponds to a unique reference to this use of the portlet.

Specified by:
getPortletInstanceKey in interface WSRPBaseRequest
Specified by:
getPortletInstanceKey in class GenericWSRPBaseRequestImpl

getNavigationalState

public java.lang.String getNavigationalState()
Description copied from interface: WSRPBaseRequest
Get the current navigational state of the portlet

Specified by:
getNavigationalState in interface WSRPBaseRequest
Specified by:
getNavigationalState in class GenericWSRPBaseRequestImpl

getWindowState

public java.lang.String getWindowState()
Description copied from interface: WSRPBaseRequest
Get the current window state of the portlet

Specified by:
getWindowState in interface WSRPBaseRequest
Specified by:
getWindowState in class GenericWSRPBaseRequestImpl

getMode

public java.lang.String getMode()
Description copied from interface: WSRPBaseRequest
Get the current mode of the portlet

Specified by:
getMode in interface WSRPBaseRequest
Specified by:
getMode in class GenericWSRPBaseRequestImpl

getClientData

public oasis.names.tc.wsrp.v1.types.ClientData getClientData()
Description copied from interface: WSRPBaseRequest
Get the ClientData structure which carries information about the end user agent.

Specified by:
getClientData in interface WSRPBaseRequest
Specified by:
getClientData in class GenericWSRPBaseRequestImpl

getLocales

public java.lang.String[] getLocales()
Description copied from interface: WSRPBaseRequest
Get the locales which are supported by the portlet according to the client connecting to it. The Locales returned are in the form of (ISO-639 + "-" + ISO-3166)

Specified by:
getLocales in interface WSRPBaseRequest
Specified by:
getLocales in class GenericWSRPBaseRequestImpl

getModes

public java.lang.String[] getModes()
Description copied from interface: WSRPBaseRequest
Get the list of wsrp modes which are supported by the portlet. This should returned the list of all actuall supported modes and not necessarily the modes returned in the portlet description of the producer.

Specified by:
getModes in interface WSRPBaseRequest
Specified by:
getModes in class GenericWSRPBaseRequestImpl

getWindowStates

public java.lang.String[] getWindowStates()
Description copied from interface: WSRPBaseRequest
Get the list of wsrp window states which are supported by the portlet. This should returned the list of all actuall supported window states and not necessarily the window states returned in the portlet description of the producer.

Specified by:
getWindowStates in interface WSRPBaseRequest
Specified by:
getWindowStates in class GenericWSRPBaseRequestImpl

getMimeTypes

public java.lang.String[] getMimeTypes()
Description copied from interface: WSRPBaseRequest
Get an array of mime types which are supported by the end user device. The order in the array defines the order of preference of the end user.

Specified by:
getMimeTypes in interface WSRPBaseRequest
Specified by:
getMimeTypes in class GenericWSRPBaseRequestImpl

getCharacterEncodingSet

public java.lang.String[] getCharacterEncodingSet()
Description copied from interface: WSRPBaseRequest
Get the character sets the consumer wants the remote portlet to use for encoding the markup. Valid character sets are defined here

Specified by:
getCharacterEncodingSet in interface WSRPBaseRequest
Specified by:
getCharacterEncodingSet in class GenericWSRPBaseRequestImpl

getUserAuthentication

public java.lang.String getUserAuthentication()
Description copied from interface: WSRPBaseRequest
Get the method which is used by the consumer to authenticate its users.

Specified by:
getUserAuthentication in interface WSRPBaseRequest
Specified by:
getUserAuthentication in class GenericWSRPBaseRequestImpl

getInteractionState

public java.lang.String getInteractionState()
Description copied from interface: InteractionRequest
Get all the interaction state

Specified by:
getInteractionState in interface InteractionRequest
Returns:
Interaction state

getFormParameters

public oasis.names.tc.wsrp.v1.types.NamedString[] getFormParameters()
Description copied from interface: InteractionRequest
Get all name/value pairs aa result of processing an form

Specified by:
getFormParameters in interface InteractionRequest
Returns:
Array of name/value pairs

getCachedMarkup

public oasis.names.tc.wsrp.v1.types.MarkupContext getCachedMarkup()
Description copied from interface: MarkupRequest
Get the markup context if there is cached markup for this portlet instance or null in case of an empty markup cache.

Specified by:
getCachedMarkup in interface MarkupRequest
Returns:
The cached markup context


--