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

## org.jboss.portal.portlet
Class PortletInvokerInterceptor

    java.lang.Object
      org.jboss.portal.portlet.PortletInvokerInterceptor

All Implemented Interfaces:
  PortletInvoker

Direct Known Subclasses:
  BridgeInterceptor, CCPPInterceptor, ConsumerCacheInterceptor, ConsumerPortletInvoker, ContainerPortletDispatcher, ContainerPortletInvoker, ContextDispatcherInterceptor, EventPayloadInterceptor, LocalInterceptor, PortletContainerManagementInterceptorImpl, PortletCustomizationInterceptor, ProducerCacheInterceptor, ProducerPortletInvoker, RequestAttributeConversationInterceptor, SecureTransportInterceptor, ValveInterceptor

    public class PortletInvokerInterceptor

extends java.lang.Object
implements PortletInvoker

A base class for `PortletInvoker` interface interceptors. The subclasses extends it and override the intercepted methods. The next interceptor in the chain is wired in the field `next` of the interceptor. When the interceptor wants to give control to the next interceptor, it must invoke the same method on the super class. If no next interceptor is configured the invocation of the parent method will throw an `IllegalStateException`.

Version:
  $Revision: 630 $
Author:
  Julien Viet

Constructor Summary
`PortletInvokerInterceptor()`
`PortletInvokerInterceptor(PortletInvoker next)`

Method Summary
`PortletContext` | `createClone(PortletContext portletContext)` Clone a portlet.
`java.util.List<DestroyCloneFailure>` | `destroyClones(java.util.List<PortletContext> portletContexts)` Destroy a cloned portlet.
`PortletInvoker` | `getNext()`
`Portlet` | `getPortlet(PortletContext portletContext)` Get information about a specific portlet.
`java.util.Set<Portlet>` | `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<java.lang.String> keys)` Return a subset of the properties of the specified portlet.
`PortletInvocationResponse` | `invoke(PortletInvocation invocation)` Invoke an operation on a specific portlet.
`void` | `setNext(PortletInvoker next)`
`PortletContext` | `setProperties(PortletContext portletContext, 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`

Constructor Detail

### PortletInvokerInterceptor

    public PortletInvokerInterceptor()

### PortletInvokerInterceptor

    public PortletInvokerInterceptor(PortletInvoker next)

Method Detail

### getNext

    public PortletInvoker getNext()

### setNext

    public void setNext(PortletInvoker next)

### getPortlets

    public java.util.Set<Portlet> 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` - a portlet invoker exception

### 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` - a portlet invoker exception

### 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 invocation response
  Throws:
    `java.lang.IllegalArgumentException` - if the invocation is null
    `PortletInvokerException` - a portlet invoker exception

### 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`
  Parameters:
    `portletContext` - the portlet context to clone
  Returns:
    the clone id
  Throws:
    `java.lang.IllegalArgumentException` - if the portletId is null
    `PortletInvokerException` - a portlet invoker exception
    `java.lang.UnsupportedOperationException` - if the invoker does not support this operation

### destroyClones

    public java.util.List<DestroyCloneFailure> destroyClones(java.util.List<PortletContext> 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
    `PortletInvokerException` - a portlet invoker exception
    `java.lang.UnsupportedOperationException` - if the invoker does not support this operation

### getProperties

    public PropertyMap getProperties(PortletContext portletContext,
                                     java.util.Set<java.lang.String> 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
    `PortletInvokerException` - a portlet invoker exception
    `java.lang.UnsupportedOperationException` - if the invoker does not support this operation

### 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
    `PortletInvokerException` - a portlet invoker exception
    `java.lang.UnsupportedOperationException` - if the invoker does not support this operation

### 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
  Returns:
    the new portlet context
  Throws:
    `java.lang.IllegalArgumentException` - if the portletContext or the properties is null
    `PortletInvokerException` - a portlet invoker exception
    `java.lang.UnsupportedOperationException` - if the invoker does not support this operation

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

Copyright © 2008. All Rights Reserved.