Index

A B C D E G H I M N O P Q R S T

A

abort() - Method in interface org.apache.excalibur.event.PreparedEnqueue: Abort a previously prepared provisional enqueue operation (from the prepareEnqueue method).
accept(Object, Sink) - Method in interface org.apache.excalibur.event.EnqueuePredicate: Tests the given element for acceptance onto the m_sink.
accept(Object[], Sink) - Method in interface org.apache.excalibur.event.EnqueuePredicate: Tests the given element for acceptance onto the m_sink.
acquire() - Method in interface org.apache.excalibur.mpool.Pool: Acquire an instance of the pooled object.
after(Source) - Method in interface org.apache.excalibur.event.DequeueInterceptor: An operation executed after dequeing events from the queue.
attach(Object) - Method in interface org.apache.excalibur.event.Message: Attach an Object to the message.

B

before(Source) - Method in interface org.apache.excalibur.event.DequeueInterceptor: An operation executed before dequeing events from the queue.

C

canAccept() - Method in interface org.apache.excalibur.event.Sink: Deprecated.
Use the EnqueuePredicate to control this instead.
clear() - Method in interface org.apache.excalibur.event.Message: Clear the attachment.
Command - Interface in org.apache.excalibur.event.command: A Command is a specific type of Signal that denotes an asynchronous execution unit that must be performed by the CommandManager.
CommandFailureHandler - Interface in org.apache.excalibur.event.command: CommandFailureHandler is used by the CommandManager to handle any exceptions that might be thrown by a Command.
commit() - Method in interface org.apache.excalibur.event.PreparedEnqueue: Commit a previously prepared provisional enqueue operation (from the prepareEnqueue method).

D

DelayedCommand - Interface in org.apache.excalibur.event.command: A DelayedCommand is a specific type of Command that denotes a an execution unit that will be delayed at least X number of milliseconds.
dequeue() - Method in interface org.apache.excalibur.event.Source: Dequeues the next element, or null if there is nothing left on the queue or in case of a timeout while attempting to obtain the mutex
dequeue(int) - Method in interface org.apache.excalibur.event.Source: Dequeues at most num available elements.
dequeueAll() - Method in interface org.apache.excalibur.event.Source: Dequeues all available elements.
DequeueInterceptor - Interface in org.apache.excalibur.event: The dequeue executable interface describes operations that are executed before and after elements are pulled from a queue.
deregister(EventPipeline) - Method in interface org.apache.excalibur.event.command.ThreadManager: Deregister an EventPipeline with the ThreadManager
deregisterAll() - Method in interface org.apache.excalibur.event.command.ThreadManager: Deregisters all EventPipelines from this ThreadManager
dispose(Object) - Method in interface org.apache.excalibur.mpool.ObjectFactory: Performs any deconstruction that is necessary for the object.

E

enqueue(Object) - Method in interface org.apache.excalibur.event.Sink: Enqueues the given element onto the Sink.
enqueue(Object[]) - Method in interface org.apache.excalibur.event.Sink: Given an array of elements, atomically enqueues all of the elements in the array.
EnqueuePredicate - Interface in org.apache.excalibur.event: Enqueue predicates allow users to specify a method that will 'screen' elements being enqueued onto a sink, either accepting or rejecting them.
EventHandler - Interface in org.apache.excalibur.event: An EventHandler takes care of processing specific events in an event-based architecture.
EventPipeline - Interface in org.apache.excalibur.event.command: An EventPipeline is used by the ThreadManager to manage the event Queue and EventHandler relationship.

G

getAttachment() - Method in interface org.apache.excalibur.event.Message: Get the attachment associated with this Message.
getCause() - Method in exception org.apache.excalibur.event.SinkException: Retrieve root cause of the exception.
getCreatedClass() - Method in interface org.apache.excalibur.mpool.ObjectFactory: Get the class of the object you are creating.
getDelayInterval() - Method in interface org.apache.excalibur.event.command.DelayedCommand: Sets the initial delay for the Command.
getDequeueInterceptor() - Method in interface org.apache.excalibur.event.Queue: Return the dequeue executable for this sink.
getEnqueuePredicate() - Method in interface org.apache.excalibur.event.Queue: Return the enqueue predicate for this sink.
getEventHandler() - Method in interface org.apache.excalibur.event.command.EventPipeline: Returns the reference to the EventHandler that the events from all the Sinks get merged into.
getManagedPool(ObjectFactory, int) - Method in interface org.apache.excalibur.mpool.PoolManager: Return a managed pool that has a controller.
getNumberOfRepeats() - Method in interface org.apache.excalibur.event.command.RepeatedCommand: If the value is less than 1 (0 or negative), the command repeats for as long as the CommandManager is running.
getRepeatInterval() - Method in interface org.apache.excalibur.event.command.RepeatedCommand: Gets the repeat interval so that the CommandQueue keeps it for the specified amount of time before enqueuing it again.
getSources() - Method in interface org.apache.excalibur.event.command.EventPipeline: There can be many different sources to merge into a pipeline.
grow(int, long) - Method in interface org.apache.excalibur.mpool.ManagablePool: Grow by the specified amount.

H

handleCommandFailure(Command, Throwable) - Method in interface org.apache.excalibur.event.command.CommandFailureHandler: Handle a command failure.
handleEvent(Object) - Method in interface org.apache.excalibur.event.EventHandler: Handle one event at a time.
handleEvents(Object[]) - Method in interface org.apache.excalibur.event.EventHandler: Handle a whole array of events at a time.

I

isFull() - Method in interface org.apache.excalibur.event.Sink: Deprecated.
Use the EnqueuePredicate to control this instead

M

m_throwable - Variable in exception org.apache.excalibur.event.SinkException: The Throwable that caused this exception to be thrown.
ManagablePool - Interface in org.apache.excalibur.mpool: This is the interface for Pools that are not a fixed size.
maxSize() - Method in interface org.apache.excalibur.event.Sink: Deprecated.
Use the EnqueuePredicate to control this instead.
Message - Interface in org.apache.excalibur.event: A Source implements the side of an event queue where queue elements are dequeued operations only.

N

newInstance() - Method in interface org.apache.excalibur.mpool.ObjectFactory: Create a new instance of the object being pooled.
newInstance() - Method in interface org.apache.excalibur.mpool.Pool: Create a new instance of the object being pooled.

O

ObjectFactory - Interface in org.apache.excalibur.mpool: This interface is to define how an ObjectFactory is defined.
org.apache.excalibur.event - package org.apache.excalibur.event
org.apache.excalibur.event.command - package org.apache.excalibur.event.command
org.apache.excalibur.mpool - package org.apache.excalibur.mpool

P

Pool - Interface in org.apache.excalibur.mpool: This interface is to define how a Pool is used.
PoolManager - Interface in org.apache.excalibur.mpool: This interface is for a PoolManager that creates pools that are managed asynchronously.
PreparedEnqueue - Interface in org.apache.excalibur.event: A PreparedEnqueue is an object returned from a prepareEnqueue method that allows you to either commit or abort the enqueue operation.
prepareEnqueue(Object[]) - Method in interface org.apache.excalibur.event.Sink: Support for transactional enqueue.

Q

Queue - Interface in org.apache.excalibur.event: A Source implements the side of an event queue where QueueElements are dequeued operations only.

R

register(EventPipeline) - Method in interface org.apache.excalibur.event.command.ThreadManager: Register an EventPipeline with the ThreadManager.
release(Object) - Method in interface org.apache.excalibur.mpool.Pool: Release the instance of the pooled object.
RepeatedCommand - Interface in org.apache.excalibur.event.command: A Signal is a specific type of QueueElement that denotes a Control code for the Queue system.
reset() - Method in interface org.apache.excalibur.mpool.Resettable: This method should be implemented to remove all costly resources in object.
Resettable - Interface in org.apache.excalibur.mpool: This interface standardizes the behaviour of a resettable object.
ROLE - Static variable in interface org.apache.excalibur.event.command.ThreadManager
ROLE - Static variable in interface org.apache.excalibur.event.Queue
ROLE - Static variable in interface org.apache.excalibur.event.Sink
ROLE - Static variable in interface org.apache.excalibur.mpool.ObjectFactory
ROLE - Static variable in interface org.apache.excalibur.mpool.PoolManager

S

setDequeueInterceptor(DequeueInterceptor) - Method in interface org.apache.excalibur.event.Queue: Set the dequeue executable for this sink.
setEnqueuePredicate(EnqueuePredicate) - Method in interface org.apache.excalibur.event.Queue: Set the enqueue predicate for this sink.
setTimeout(long) - Method in interface org.apache.excalibur.event.Source: Sets the timeout on a blocking Source.
shrink(int, long) - Method in interface org.apache.excalibur.mpool.ManagablePool: Shrink the pool by the specified amount.
Signal - Interface in org.apache.excalibur.event: A Signal is a specific type of queue element that denotes a Control code for the Queue system.
Sink - Interface in org.apache.excalibur.event: A Sink implements the end of a finite-length event queue where elements are enqueued.
SinkClosedException - Exception in org.apache.excalibur.event: A SinkClosedException is thrown when an enqueue operation occurs on a queue that is already closed.
SinkClosedException(String) - Constructor for exception org.apache.excalibur.event.SinkClosedException: Create a SinkClosedException with an associated message.
SinkClosedException(String, Throwable) - Constructor for exception org.apache.excalibur.event.SinkClosedException: Create a SinkClosedException with an associated message and the original exception that caused the problem.
SinkException - Exception in org.apache.excalibur.event: A SourceException is thrown when an enqueue operation fails.
SinkException(String) - Constructor for exception org.apache.excalibur.event.SinkException: Construct a new SinkException instance.
SinkException(String, Throwable) - Constructor for exception org.apache.excalibur.event.SinkException: Construct a new SinkException instance.
SinkFullException - Exception in org.apache.excalibur.event: A SinkException is thrown when an enqueue operation occurs on a queue that is already full.
SinkFullException(String) - Constructor for exception org.apache.excalibur.event.SinkFullException: Create a SinkFullException with an associated message.
SinkFullException(String, Throwable) - Constructor for exception org.apache.excalibur.event.SinkFullException: Create a SinkClosedException with an associated message and the original exception that caused the problem.
size() - Method in interface org.apache.excalibur.event.Sink: Returns the number of elements waiting in this Sink.
size() - Method in interface org.apache.excalibur.event.Source: Returns the number of elements waiting in this Source.
size(long) - Method in interface org.apache.excalibur.mpool.ManagablePool: Determine the pool's current size.
Source - Interface in org.apache.excalibur.event: A Source implements the side of an event queue where QueueElements are dequeued operations only.

T

ThreadManager - Interface in org.apache.excalibur.event.command: A ThreadManager handles the thread policies for EventPipelines.
tryEnqueue(Object) - Method in interface org.apache.excalibur.event.Sink: Tries to enqueue an event, but instead of throwing exceptions, it returns a boolean value of whether the attempt was successful.

A B C D E G H I M N O P Q R S T