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.common.invocation
Class Invocation

    java.lang.Object
      org.jboss.portal.common.invocation.Invocation

Direct Known Subclasses:
  Command, ControllerCommand, PortletInvocation, ServerInvocation

    public abstract class Invocation

extends java.lang.Object

A generic invocation object.

Version:
  $Revision: 5597 $
Author:
  Julien Viet

Field Summary
`static InterceptorStack` | `EMPTY_STACK` .

Constructor Summary
`Invocation()`

Method Summary
`java.lang.Object` | `getAttribute(Scope attrScope, java.lang.Object attrKey)`
`abstract InvocationContext` | `getContext()` Return the invocation context or throw IllegalStateException.
`InvocationHandler` | `getHandler()`
`java.lang.Object` | `invoke(InterceptorStack newStack)` Execute the invocation through the chain of interceptors.
`java.lang.Object` | `invokeNext()` Invoke the next interceptor in the chain.
`void` | `removeAttribute(Scope attrScope, java.lang.Object attrKey)`
`void` | `setAttribute(Scope attrScope, java.lang.Object attrKey, java.lang.Object attrValue)`
`void` | `setHandler(InvocationHandler handler)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### EMPTY_STACK

    public static final InterceptorStack EMPTY_STACK

  .

Constructor Detail

### Invocation

    public Invocation()

Method Detail

### getContext

    public abstract InvocationContext getContext()
                                          throws java.lang.IllegalStateException

  Return the invocation context or throw IllegalStateException.

  Returns:
    the invocation context
  Throws:
    `java.lang.IllegalStateException` - if no context is associated with this invocation

### getAttribute

    public java.lang.Object getAttribute(Scope attrScope,
                                         java.lang.Object attrKey)
                                  throws java.lang.IllegalArgumentException

  Throws:
    `java.lang.IllegalArgumentException`
  See Also:
    `InvocationContext.getAttribute(Scope,Object)`

### setAttribute

    public void setAttribute(Scope attrScope,
                             java.lang.Object attrKey,
                             java.lang.Object attrValue)
                      throws java.lang.IllegalArgumentException

  Throws:
    `java.lang.IllegalArgumentException`
  See Also:
    `InvocationContext.setAttribute(Scope,Object,Object)`

### removeAttribute

    public void removeAttribute(Scope attrScope,
                                java.lang.Object attrKey)
                         throws java.lang.IllegalArgumentException

  Throws:
    `java.lang.IllegalArgumentException`
  See Also:
    `InvocationContext.removeAttribute(Scope,Object)`

### getHandler

    public InvocationHandler getHandler()

### setHandler

    public void setHandler(InvocationHandler handler)

### invokeNext

    public java.lang.Object invokeNext()
                                throws java.lang.Exception,
                                       InvocationException

  Invoke the next interceptor in the chain. If the end of the chain is reached then the `dispatch()` is invoked.

  Throws:
    `java.lang.Exception`
    `InvocationException`

### invoke

    public java.lang.Object invoke(InterceptorStack newStack)
                            throws java.lang.Exception,
                                   InvocationException

  Execute the invocation through the chain of interceptors.

  Throws:
    `java.lang.Exception`
    `InvocationException`

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