org.jboss.portal.portlet.container
Class PortletContainerInvoker

java.lang.Object
  org.jboss.portal.portlet.container.PortletContainerInvoker

All Implemented Interfaces:

PortletApplicationRegistryListener, PortletInvoker

public class PortletContainerInvoker
extends java.lang.Object
implements PortletInvoker, PortletApplicationRegistryListener

An implementation of portlet invoker that makes a call to a portlet container.

Version:

$Revision: 7226 $

Author:

Julien Viet

Field Summary

static java.lang.String

PORTLET_CONTAINER The key under which the portlet container is stored in the request scope of the invocation.

Constructor Summary

PortletContainerInvoker()

Method Summary

PortletContext	createClone(PortletContext portletContext) Clone a portlet.
java.util.List	destroyClones(java.util.List portletContexts) Destroy a cloned portlet.
Portlet	getPortlet(PortletContext portletContext) Get information about a specific portlet.
java.util.Set	getPortlets() Return the set of portlet exposed.
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.
PortletApplicationRegistry	getRegistry()
InterceptorStackFactory	getStackFactory()
PortletInvocationResponse	invoke(PortletInvocation invocation) Invoke an operation on a specific portlet.
void	portletContainerRegistered(PortletContainer portletContainer) A portlet container has been registered.
void	portletContainerUnregistered(PortletContainer portletContainer) A portlet container has been unregistered.
PortletContext	setProperties(PortletContext portletContext, PropertyChange[] changes) Set the properties on the specified portlet.
void	setRegistry(PortletApplicationRegistry registry)
void	setStackFactory(InterceptorStackFactory stackFactory)
void	start()
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PORTLET_CONTAINER

public static final java.lang.String PORTLET_CONTAINER

The key under which the portlet container is stored in the request scope of the invocation.

See Also:

Constant Field Values

Constructor Detail

PortletContainerInvoker

public PortletContainerInvoker()

Method Detail

getRegistry

public PortletApplicationRegistry getRegistry()

setRegistry

public void setRegistry(PortletApplicationRegistry registry)

getStackFactory

public InterceptorStackFactory getStackFactory()

setStackFactory

public void setStackFactory(InterceptorStackFactory stackFactory)

portletContainerRegistered

public void portletContainerRegistered(PortletContainer portletContainer)

Description copied from interface: PortletApplicationRegistryListener

A portlet container has been registered.

Specified by:

portletContainerRegistered in interface PortletApplicationRegistryListener

portletContainerUnregistered

public void portletContainerUnregistered(PortletContainer portletContainer)

Description copied from interface: PortletApplicationRegistryListener

A portlet container has been unregistered.

Specified by:

portletContainerUnregistered in interface PortletApplicationRegistryListener

start

public void start()
           throws java.lang.Exception

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Throws:

java.lang.Exception

getPortlets

public java.util.Set getPortlets()

Description copied from interface: PortletInvoker

Return the set of portlet exposed.

Specified by:

getPortlets in interface PortletInvoker

Returns:

the set of exposed portlets

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 PortletInvokerException,
                                        InvocationException

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 invocation response

Throws:

PortletInvokerException

InvocationException

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.IllegalArgumentException - if the portletContext or the keys arguments are null

java.lang.UnsupportedOperationException - if the invoker does not support this operation

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.IllegalArgumentException - if the portletContext is null

java.lang.UnsupportedOperationException - if the invoker does not support this operation

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.IllegalArgumentException - if the portletId is null

java.lang.UnsupportedOperationException - if the invoker does not support this operation

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 DestroyCloneFailure, one per clone that couldn't be destroyed

Throws:

java.lang.IllegalArgumentException - if the portletContext is null

java.lang.UnsupportedOperationException - if the invoker does not support this operation

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.IllegalArgumentException - if the portletContext or the properties is null

java.lang.UnsupportedOperationException - if the invoker does not support this operation

PortletInvokerException