站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

ConsumerPortletInvoker - JBOSS Portal 2.6 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.portlet.state.consumer
Class ConsumerPortletInvoker

java.lang.Object
  extended byorg.jboss.portal.portlet.state.consumer.ConsumerPortletInvoker
All Implemented Interfaces:
PortletInvoker
public class ConsumerPortletInvoker
extends java.lang.Object
implements PortletInvoker

Version:
$Revision: 1.1 $
Author:
Julien Viet

Nested Class Summary
private  class ConsumerPortletInvoker.ConsumerContext
           
private static class ConsumerPortletInvoker.StatefulInstanceContextImpl
           
 
Field Summary
private static java.lang.String CLONE_ID_PREFIX
          .
private  ConsumerPersistenceManager persistenceManager
          .
private  PortletInvoker producer
          .
 
Constructor Summary
ConsumerPortletInvoker()
           
 
Method Summary
 PortletContext createClone(PortletContext portletContext)
          Clone a portlet.
 java.util.List destroyClones(java.util.List portletContexts)
          Destroy a cloned portlet.
private  ConsumerPortletInvoker.ConsumerContext getConsumerContext(PortletContext portletContext)
           
 Portlet getPortlet(PortletContext portletContext)
          Get information about a specific portlet.
 java.util.Set getPortlets()
          Return the set of portlet exposed.
 PortletInvoker getProducer()
           
 PropertyMap getProperties(PortletContext portletContext)
          Return all the properties of the specified portlet.
 PropertyMap getProperties(PortletContext portletContext, java.util.Set keys)
          Return a subset of the properties of the specified portlet.
 PortletInvocationResponse invoke(PortletInvocation invocation)
          Invoke an operation on a specific portlet.
 void setPersistenceManager(ConsumerPersistenceManager persistenceManager)
           
 void setProducer(PortletInvoker producer)
           
 PortletContext setProperties(PortletContext portletContext, PropertyChange[] changes)
          Set the properties on the specified portlet.
 PortletContext unwrapCCP(java.lang.String wrappedCCP)
           
 PortletContext unwrapPOP(java.lang.String wrappedPOPId)
           
 java.lang.String wrapCCP(PortletContext ccpCtx)
           
 java.lang.String wrapPOP(PortletContext popCtx)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLONE_ID_PREFIX

private static final java.lang.String CLONE_ID_PREFIX
.

See Also:
Constant Field Values

producer

private PortletInvoker producer
.

persistenceManager

private ConsumerPersistenceManager persistenceManager
.

Constructor Detail

ConsumerPortletInvoker

public ConsumerPortletInvoker()
Method Detail

unwrapCCP

public PortletContext unwrapCCP(java.lang.String wrappedCCP)
                         throws InvalidPortletIdException
Throws:
InvalidPortletIdException

unwrapPOP

public PortletContext unwrapPOP(java.lang.String wrappedPOPId)
                         throws InvalidPortletIdException
Throws:
InvalidPortletIdException

wrapCCP

public java.lang.String wrapCCP(PortletContext ccpCtx)
                         throws InvalidPortletIdException
Throws:
InvalidPortletIdException

wrapPOP

public java.lang.String wrapPOP(PortletContext popCtx)
                         throws InvalidPortletIdException
Throws:
InvalidPortletIdException

getProducer

public PortletInvoker getProducer()

setProducer

public void setProducer(PortletInvoker producer)

setPersistenceManager

public void setPersistenceManager(ConsumerPersistenceManager persistenceManager)

getPortlets

public java.util.Set getPortlets()
                          throws PortletInvokerException
Description copied from interface: PortletInvoker
Return the set of portlet exposed.

Specified by:
getPortlets in interface PortletInvoker
Returns:
the set of exposed portlets
Throws:
PortletInvokerException

getPortlet

public Portlet getPortlet(PortletContext portletContext)
                   throws java.lang.IllegalArgumentException,
                          PortletInvokerException
Description copied from interface: PortletInvoker
Get information about a specific portlet.

Specified by:
getPortlet in interface PortletInvoker
Parameters:
portletContext - the portlet context in the scope of this invoker
Returns:
the PortletInfo for the specified portlet
Throws:
java.lang.IllegalArgumentException - if the portlet context is null
PortletInvokerException

invoke

public PortletInvocationResponse invoke(PortletInvocation invocation)
                                 throws java.lang.IllegalArgumentException,
                                        PortletInvokerException
Description copied from interface: PortletInvoker
Invoke an operation on a specific portlet.

Specified by:
invoke in interface PortletInvoker
Parameters:
invocation - the portlet invocation
Returns:
the invocatin response
Throws:
java.lang.IllegalArgumentException - if the invocation is null
PortletInvokerException

createClone

public PortletContext createClone(PortletContext portletContext)
                           throws java.lang.IllegalArgumentException,
                                  PortletInvokerException,
                                  java.lang.UnsupportedOperationException
Description copied from interface: PortletInvoker
Clone a portlet.

Specified by:
createClone in interface PortletInvoker
Returns:
the clone id
Throws:
java.lang.UnsupportedOperationException - if the invoker does not support this operation
java.lang.IllegalArgumentException - if the portletId is null
PortletInvokerException

destroyClones

public java.util.List destroyClones(java.util.List portletContexts)
                             throws java.lang.IllegalArgumentException,
                                    PortletInvokerException,
                                    java.lang.UnsupportedOperationException
Description copied from interface: PortletInvoker
Destroy a cloned portlet.

Specified by:
destroyClones in interface PortletInvoker
Parameters:
portletContexts - a list of portlet contexts to destroy
Returns:
a list of portlet ids that were not destroyed during the operation
Throws:
java.lang.IllegalArgumentException - if the portletId is null
java.lang.UnsupportedOperationException - if the invoker does not support this operation
PortletInvokerException

getProperties

public PropertyMap getProperties(PortletContext portletContext,
                                 java.util.Set keys)
                          throws java.lang.IllegalArgumentException,
                                 PortletInvokerException,
                                 java.lang.UnsupportedOperationException
Description copied from interface: PortletInvoker
Return a subset of the properties of the specified portlet.

Specified by:
getProperties in interface PortletInvoker
Parameters:
portletContext - the portlet context
keys - the set of keys to retrieve
Returns:
the properties
Throws:
java.lang.UnsupportedOperationException - if the invoker does not support this operation
java.lang.IllegalArgumentException - if the portletId or the keys arguments are null
PortletInvokerException

getProperties

public PropertyMap getProperties(PortletContext portletContext)
                          throws java.lang.IllegalArgumentException,
                                 PortletInvokerException,
                                 java.lang.UnsupportedOperationException
Description copied from interface: PortletInvoker
Return all the properties of the specified portlet.

Specified by:
getProperties in interface PortletInvoker
Parameters:
portletContext - the portlet context
Returns:
the properties
Throws:
java.lang.UnsupportedOperationException - if the invoker does not support this operation
java.lang.IllegalArgumentException - if the portletId is null
PortletInvokerException

setProperties

public PortletContext setProperties(PortletContext portletContext,
                                    PropertyChange[] changes)
                             throws java.lang.IllegalArgumentException,
                                    PortletInvokerException,
                                    java.lang.UnsupportedOperationException
Description copied from interface: PortletInvoker
Set the properties on the specified portlet.

Specified by:
setProperties in interface PortletInvoker
Parameters:
portletContext - the portlet context
changes - the changes
Throws:
java.lang.UnsupportedOperationException - if the invoker does not support this operation
java.lang.IllegalArgumentException - if the portletId or the properties is null
PortletInvokerException

getConsumerContext

private ConsumerPortletInvoker.ConsumerContext getConsumerContext(PortletContext portletContext)
                                                           throws java.lang.IllegalArgumentException,
                                                                  NoSuchPortletException,
                                                                  InvalidPortletIdException
Throws:
java.lang.IllegalArgumentException
NoSuchPortletException
InvalidPortletIdException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD