|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.portal.wsrp.consumer.PortletDriverImpl
This class implements a portlet driver.
Field Summary | |
protected org.apache.wsrp4j.consumer.ConsumerEnvironment |
consumerEnv
|
protected oasis.names.tc.wsrp.v1.types.PortletDescription |
desc
|
protected oasis.names.tc.wsrp.v1.types.CookieProtocol |
initCookie
|
protected org.apache.wsrp4j.log.Logger |
logger
Our logger. |
protected oasis.names.tc.wsrp.v1.intf.WSRP_v1_Markup_PortType |
markupPort
|
protected org.apache.wsrp4j.util.ParameterChecker |
parameterChecker
|
protected org.apache.wsrp4j.consumer.WSRPPortlet |
portlet
|
protected oasis.names.tc.wsrp.v1.intf.WSRP_v1_PortletManagement_PortType |
portletPort
|
protected org.apache.wsrp4j.consumer.Producer |
producer
|
protected PortalService |
service
The portal service. |
Constructor Summary | |
PortletDriverImpl()
|
Method Summary | |
protected void |
checkInitCookie(String userID)
|
oasis.names.tc.wsrp.v1.types.PortletContext |
clonePortlet(String userID)
Clone the portlet |
oasis.names.tc.wsrp.v1.types.DestroyPortletsResponse |
destroyPortlets(String[] portletHandles,
String userID)
Destroy the producer portlets specified in the entiyHandles array. |
void |
enableLogging(Logger arg0)
|
protected oasis.names.tc.wsrp.v1.types.InteractionParams |
getInteractionParams(org.apache.wsrp4j.consumer.InteractionRequest actionRequest)
|
oasis.names.tc.wsrp.v1.types.MarkupResponse |
getMarkup(org.apache.wsrp4j.consumer.MarkupRequest markupRequest,
String userID)
This method is used to retrieve the markup generated by the portlet instance. |
protected oasis.names.tc.wsrp.v1.types.MarkupParams |
getMarkupParams(org.apache.wsrp4j.consumer.WSRPBaseRequest request)
|
protected oasis.names.tc.wsrp.v1.types.Extension[] |
getMarkupParamsExtensions()
Get the extensions for the MarkupContext. |
org.apache.wsrp4j.consumer.WSRPPortlet |
getPortlet()
Get the portlet this driver is bind to. |
oasis.names.tc.wsrp.v1.types.PortletDescriptionResponse |
getPortletDescription(String userID,
String[] desiredLocales)
Fetches information about the portlet from the producer. |
oasis.names.tc.wsrp.v1.types.PropertyList |
getPortletProperties(String[] names,
String userID)
Get the current values of the properties with the given names. |
oasis.names.tc.wsrp.v1.types.PortletPropertyDescriptionResponse |
getPortletPropertyDescription(String userID)
Fetches all published properties of an remote portlet. |
protected oasis.names.tc.wsrp.v1.types.RuntimeContext |
getRuntimeContext(org.apache.wsrp4j.consumer.WSRPBaseRequest request)
Create the runtime context for the current request. |
protected oasis.names.tc.wsrp.v1.types.UserContext |
getUserContext(String userID)
|
protected String[] |
getValidValues(String[] supported,
String[] allowed)
Calculate the valid values for modes and window states. |
void |
init(org.apache.wsrp4j.consumer.WSRPPortlet portlet)
Set the wsrp portlet and initialize this component. |
void |
initCookie()
Actual WSRP initCookie() call |
oasis.names.tc.wsrp.v1.types.BlockingInteractionResponse |
performBlockingInteraction(org.apache.wsrp4j.consumer.InteractionRequest actionRequest,
String userID)
This method is used to perform a blocking interaction on the portlet instance. |
oasis.names.tc.wsrp.v1.types.ReturnAny |
releaseSessions(String[] sessionIDs,
String userID)
Inform the producer that the sessions specified in the sessionIDs array will no longer be used by the consumer and can therefor be released. |
protected void |
resetInitCookie(String userID)
|
void |
setConsumerEnvironment(org.apache.wsrp4j.consumer.ConsumerEnvironment env)
|
void |
setPortalService(PortalService service)
|
oasis.names.tc.wsrp.v1.types.PortletContext |
setPortletProperties(oasis.names.tc.wsrp.v1.types.PropertyList properties,
String userID)
Set the portlet properties specified in the property list |
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled |
getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected org.apache.wsrp4j.consumer.WSRPPortlet portlet
protected oasis.names.tc.wsrp.v1.intf.WSRP_v1_Markup_PortType markupPort
protected oasis.names.tc.wsrp.v1.intf.WSRP_v1_PortletManagement_PortType portletPort
protected org.apache.wsrp4j.consumer.ConsumerEnvironment consumerEnv
protected org.apache.wsrp4j.consumer.Producer producer
protected org.apache.wsrp4j.util.ParameterChecker parameterChecker
protected oasis.names.tc.wsrp.v1.types.CookieProtocol initCookie
protected oasis.names.tc.wsrp.v1.types.PortletDescription desc
protected org.apache.wsrp4j.log.Logger logger
protected PortalService service
Constructor Detail |
public PortletDriverImpl()
Method Detail |
public void enableLogging(Logger arg0)
enableLogging
in interface LogEnabled
LogEnabled.enableLogging(org.apache.avalon.framework.logger.Logger)
public void setConsumerEnvironment(org.apache.wsrp4j.consumer.ConsumerEnvironment env)
setConsumerEnvironment
in interface RequiresConsumerEnvironment
RequiresConsumerEnvironment.setConsumerEnvironment(org.apache.wsrp4j.consumer.ConsumerEnvironment)
public void setPortalService(PortalService service)
setPortalService
in interface RequiresPortalService
RequiresPortalService.setPortalService(org.apache.cocoon.portal.PortalService)
public void init(org.apache.wsrp4j.consumer.WSRPPortlet portlet) throws org.apache.wsrp4j.exception.WSRPException
portlet
-
org.apache.wsrp4j.exception.WSRPException
public org.apache.wsrp4j.consumer.WSRPPortlet getPortlet()
getPortlet
in interface org.apache.wsrp4j.consumer.PortletDriver
protected void resetInitCookie(String userID) throws org.apache.wsrp4j.exception.WSRPException
org.apache.wsrp4j.exception.WSRPException
protected void checkInitCookie(String userID) throws org.apache.wsrp4j.exception.WSRPException
org.apache.wsrp4j.exception.WSRPException
protected oasis.names.tc.wsrp.v1.types.MarkupParams getMarkupParams(org.apache.wsrp4j.consumer.WSRPBaseRequest request)
protected String[] getValidValues(String[] supported, String[] allowed)
supported
- The values supported by the consumer.allowed
- The values allowed by the producer.
protected oasis.names.tc.wsrp.v1.types.RuntimeContext getRuntimeContext(org.apache.wsrp4j.consumer.WSRPBaseRequest request)
protected oasis.names.tc.wsrp.v1.types.UserContext getUserContext(String userID)
protected oasis.names.tc.wsrp.v1.types.InteractionParams getInteractionParams(org.apache.wsrp4j.consumer.InteractionRequest actionRequest)
public oasis.names.tc.wsrp.v1.types.MarkupResponse getMarkup(org.apache.wsrp4j.consumer.MarkupRequest markupRequest, String userID) throws org.apache.wsrp4j.exception.WSRPException
getMarkup
in interface org.apache.wsrp4j.consumer.PortletDriver
markupRequest
- userID
-
org.apache.wsrp4j.exception.WSRPException
public oasis.names.tc.wsrp.v1.types.BlockingInteractionResponse performBlockingInteraction(org.apache.wsrp4j.consumer.InteractionRequest actionRequest, String userID) throws org.apache.wsrp4j.exception.WSRPException
performBlockingInteraction
in interface org.apache.wsrp4j.consumer.PortletDriver
actionRequest
-
org.apache.wsrp4j.exception.WSRPException
public oasis.names.tc.wsrp.v1.types.PortletContext clonePortlet(String userID) throws org.apache.wsrp4j.exception.WSRPException
clonePortlet
in interface org.apache.wsrp4j.consumer.PortletDriver
org.apache.wsrp4j.exception.WSRPException
public oasis.names.tc.wsrp.v1.types.DestroyPortletsResponse destroyPortlets(String[] portletHandles, String userID) throws org.apache.wsrp4j.exception.WSRPException
destroyPortlets
in interface org.apache.wsrp4j.consumer.PortletDriver
org.apache.wsrp4j.exception.WSRPException
public oasis.names.tc.wsrp.v1.types.ReturnAny releaseSessions(String[] sessionIDs, String userID) throws org.apache.wsrp4j.exception.WSRPException
releaseSessions
in interface org.apache.wsrp4j.consumer.PortletDriver
org.apache.wsrp4j.exception.WSRPException
public void initCookie() throws org.apache.wsrp4j.exception.WSRPException
initCookie
in interface org.apache.wsrp4j.consumer.PortletDriver
org.apache.wsrp4j.exception.WSRPException
public oasis.names.tc.wsrp.v1.types.PortletDescriptionResponse getPortletDescription(String userID, String[] desiredLocales) throws org.apache.wsrp4j.exception.WSRPException
getPortletDescription
in interface org.apache.wsrp4j.consumer.PortletDriver
userID
- is used to get the user context of the user from the user registrydesiredLocales
- Array of locales the description should be provided
org.apache.wsrp4j.exception.WSRPException
public oasis.names.tc.wsrp.v1.types.PortletPropertyDescriptionResponse getPortletPropertyDescription(String userID) throws org.apache.wsrp4j.exception.WSRPException
getPortletPropertyDescription
in interface org.apache.wsrp4j.consumer.PortletDriver
userID
- The ID of the user this request is done for
org.apache.wsrp4j.exception.WSRPException
public oasis.names.tc.wsrp.v1.types.PropertyList getPortletProperties(String[] names, String userID) throws org.apache.wsrp4j.exception.WSRPException
getPortletProperties
in interface org.apache.wsrp4j.consumer.PortletDriver
names
- The names of the propertiesuserID
- The ID of the user is used to get the user context
org.apache.wsrp4j.exception.WSRPException
public oasis.names.tc.wsrp.v1.types.PortletContext setPortletProperties(oasis.names.tc.wsrp.v1.types.PropertyList properties, String userID) throws org.apache.wsrp4j.exception.WSRPException
setPortletProperties
in interface org.apache.wsrp4j.consumer.PortletDriver
properties
- List of properties to be set.userID
- The ID of the user is used to get the user context
org.apache.wsrp4j.exception.WSRPException
protected oasis.names.tc.wsrp.v1.types.Extension[] getMarkupParamsExtensions()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |