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

FederatingPortletInvokerService - JBOSS Portal 2.6 API 英文版文档


org.jboss.portal.federation.impl
Class FederatingPortletInvokerService

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport
      extended byorg.jboss.system.ServiceMBeanSupport
          extended byorg.jboss.portal.jems.as.system.AbstractJBossService
              extended byorg.jboss.portal.federation.impl.FederatingPortletInvokerService
All Implemented Interfaces:
FederatingPortletInvoker, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, PortletInvoker, org.jboss.system.Service, org.jboss.system.ServiceMBean

public class FederatingPortletInvokerService
extends AbstractJBossService
implements FederatingPortletInvoker

Since:
2.4
Version:
$Revision: 5448 $
Author:
Julien Viet, Chris Laprun

Field Summary
private  java.util.Map registry
          The registred FederatedPortletInvokers.
(package private) static java.lang.String SEPARATOR
          The separator used in the id to route to the correct invoker.
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport
log, server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport
 
Fields inherited from interface org.jboss.system.ServiceMBean
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
FederatingPortletInvokerService()
           
 
Method Summary
 PortletContext createClone(PortletContext compoundPortletContext)
          Clone a portlet.
 java.util.List destroyClones(java.util.List portletIds)
          Destroy a cloned portlet.
 FederatedPortletInvoker getFederatedInvoker(java.lang.String id)
          Return a portlet invoker registered or null if not found
 java.util.Collection getFederatedInvokers()
          Return the registered portlet invokers.
private  FederatedPortletInvoker getFederatedPortletInvokerFor(PortletContext compoundPortletContext)
          Retrieves the portlet invoker associated with the specified compound portlet id or null if it is not found.
private  FederatedPortletInvoker getFederatedPortletInvokerFor(java.lang.String compoundPortletId)
          Retrieves the portlet invoker associated with the specified compound portlet id or null if it is not found.
 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.
 void registerInvoker(PortletInvokerRegistration registration)
          Register an invoker.
 PortletContext setProperties(PortletContext compoundPortletContext, PropertyChange[] changes)
          Set the properties on the specified portlet.
 void unregisterInvoker(PortletInvokerRegistration registration)
          Unregister an invoker.
 
Methods inherited from class org.jboss.portal.jems.as.system.AbstractJBossService
create, destroy, getState, getStateString, start, stop
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport
createService, destroyService, getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister, startService, stopService
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport
addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEPARATOR

static final java.lang.String SEPARATOR
The separator used in the id to route to the correct invoker.

See Also:
Constant Field Values

registry

private java.util.Map registry
The registred FederatedPortletInvokers.

Constructor Detail

FederatingPortletInvokerService

public FederatingPortletInvokerService()
Method Detail

registerInvoker

public void registerInvoker(PortletInvokerRegistration registration)
Description copied from interface: FederatingPortletInvoker
Register an invoker.

Specified by:
registerInvoker in interface FederatingPortletInvoker
Parameters:
registration - the invoker to register

unregisterInvoker

public void unregisterInvoker(PortletInvokerRegistration registration)
Description copied from interface: FederatingPortletInvoker
Unregister an invoker.

Specified by:
unregisterInvoker in interface FederatingPortletInvoker
Parameters:
registration - the invoker to register

getFederatedInvoker

public FederatedPortletInvoker getFederatedInvoker(java.lang.String id)
                                            throws java.lang.IllegalArgumentException
Description copied from interface: FederatingPortletInvoker
Return a portlet invoker registered or null if not found

Specified by:
getFederatedInvoker in interface FederatingPortletInvoker
Parameters:
id - the id
Returns:
the invoker
Throws:
java.lang.IllegalArgumentException - if the id is null

getFederatedInvokers

public java.util.Collection getFederatedInvokers()
Description copied from interface: FederatingPortletInvoker
Return the registered portlet invokers.

Specified by:
getFederatedInvokers in interface FederatingPortletInvoker
Returns:
a collection that contains the portlet invokers

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 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:
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,
                                 java.util.Set keys)
                          throws PortletInvokerException
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:
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

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

getFederatedPortletInvokerFor

private FederatedPortletInvoker getFederatedPortletInvokerFor(PortletContext compoundPortletContext)
                                                       throws java.lang.IllegalArgumentException,
                                                              NoSuchPortletException
Retrieves the portlet invoker associated with the specified compound portlet id or null if it is not found.

Parameters:
compoundPortletContext - the portlet context for which the invoker is to be retrieved
Returns:
the portlet invoker associated with the specified compound portlet id
Throws:
java.lang.IllegalArgumentException - if the compound portlet id is not well formed or null
NoSuchPortletException

getFederatedPortletInvokerFor

private FederatedPortletInvoker getFederatedPortletInvokerFor(java.lang.String compoundPortletId)
                                                       throws java.lang.IllegalArgumentException,
                                                              NoSuchPortletException
Retrieves the portlet invoker associated with the specified compound portlet id or null if it is not found.

Parameters:
compoundPortletId - the portlet id for which the invoker is to be retrieved
Returns:
the portlet invoker associated with the specified compound portlet id
Throws:
java.lang.IllegalArgumentException - if the compound portlet id is not well formed or null
NoSuchPortletException