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

FederatedPortletInvokerService - 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.federation.impl
Class FederatedPortletInvokerService

java.lang.Object
  extended byorg.jboss.portal.federation.impl.FederatedPortletInvokerService
All Implemented Interfaces:
FederatedPortletInvoker, PortletInvoker
public class FederatedPortletInvokerService
extends java.lang.Object
implements FederatedPortletInvoker

Since:
2.4
Version:
$Revision: 5448 $
Author:
Julien Viet

Nested Class Summary
private  class FederatedPortletInvokerService.FederatedInstanceContext
           
 
Field Summary
private  FederatingPortletInvoker federatingPortletInvoker
          .
private  java.lang.String id
          .
private  PortletInvoker portletInvoker
          .
 
Constructor Summary
FederatedPortletInvokerService(FederatingPortletInvoker federatingPortletInvoker, PortletInvokerRegistration registration)
           
 
Method Summary
 PortletContext createClone(PortletContext compoundPortletContext)
          Clone a portlet.
private  PortletContext dereference(PortletContext compoundPortletContext)
           
 java.util.List destroyClones(java.util.List portletIds)
          Destroy a cloned portlet.
 FederatingPortletInvoker getFederatingPortletInvoker()
           
 java.lang.String getId()
          Return the invoker id.
 Portlet getPortlet(PortletContext compoundPortletContext)
          Get information about a specific portlet.
 java.util.Set getPortlets()
          Return the set of portlet exposed.
 PropertyMap getProperties(PortletContext compoundPortletContext)
          Return all the properties of the specified portlet.
 PropertyMap getProperties(PortletContext compoundPortletContext, 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.
private  PortletContext reference(PortletContext portletContext)
           
private  java.lang.String reference(java.lang.String portletId)
           
 PortletContext setProperties(PortletContext compoundPortletContext, PropertyChange[] changes)
          Set the properties on the specified portlet.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

private java.lang.String id
.

portletInvoker

private PortletInvoker portletInvoker
.

federatingPortletInvoker

private FederatingPortletInvoker federatingPortletInvoker
.

Constructor Detail

FederatedPortletInvokerService

public FederatedPortletInvokerService(FederatingPortletInvoker federatingPortletInvoker,
                                      PortletInvokerRegistration registration)
Method Detail

getId

public java.lang.String getId()
Description copied from interface: FederatedPortletInvoker
Return the invoker id.

Specified by:
getId in interface FederatedPortletInvoker
Returns:
the invoker id

getFederatingPortletInvoker

public FederatingPortletInvoker getFederatingPortletInvoker()

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 compoundPortletContext)
                   throws java.lang.IllegalArgumentException,
                          PortletInvokerException
Description copied from interface: PortletInvoker
Get information about a specific portlet.

Specified by:
getPortlet in interface PortletInvoker
Parameters:
compoundPortletContext - 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 InvocationException,
                                        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:
InvocationException
PortletInvokerException

createClone

public PortletContext createClone(PortletContext compoundPortletContext)
                           throws PortletInvokerException
Description copied from interface: PortletInvoker
Clone a portlet.

Specified by:
createClone in interface PortletInvoker
Returns:
the clone id
Throws:
PortletInvokerException

destroyClones

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

Specified by:
destroyClones in interface PortletInvoker
Parameters:
portletIds - 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 compoundPortletContext)
                          throws PortletInvokerException
Description copied from interface: PortletInvoker
Return all the properties of the specified portlet.

Specified by:
getProperties in interface PortletInvoker
Parameters:
compoundPortletContext - the portlet context
Returns:
the properties
Throws:
PortletInvokerException

getProperties

public PropertyMap getProperties(PortletContext compoundPortletContext,
                                 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:
compoundPortletContext - 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

setProperties

public PortletContext setProperties(PortletContext compoundPortletContext,
                                    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:
compoundPortletContext - 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

dereference

private PortletContext dereference(PortletContext compoundPortletContext)

reference

private PortletContext reference(PortletContext portletContext)

reference

private java.lang.String reference(java.lang.String portletId)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD