org.objectweb.dream.queue
Interface PushQueueAttributeController

All Superinterfaces:
AttributeController
All Known Subinterfaces:
PushQueuePrimitiveComponentAttributeController
All Known Implementing Classes:
AbstractPushIncomingHandlerOverflowImpl, PushPullQueueNotSynchronizedImpl

public interface PushQueueAttributeController
extends AttributeController

Attribute controller for queue implementation with a push input. It defines an overflow policy attribute with three default values (specific implementations can define other).


Field Summary
static String BLOCK_OVERFLOW_POLICY
          An overflow policy that block incoming messages until a message is delivered on the output.
static String DROP_FIRST_OVERFLOW_POLICY
          An overflow policy that drops the first message of the queue when it is full.
static String DROP_LAST_OVERFLOW_POLICY
          An overflow policy that drops the last message of the queue when it is full.
static String DROP_PROCESSED_MESSAGE_OVERFLOW_POLICY
          An overflow policy that drops the current message when the queue is full: this means that the message will not be inserted into the queue.
static String DROP_QUEUE_MESSAGE_OVERFLOW_POLICY
          An overflow policy that drops a message message from the queue when it is full.
static String EXCEPTION_OVERFLOW_POLICY
          An overflow policy that causes the Push server interface to throw a BufferOverflowException
 
Method Summary
 String getOverflowPolicy()
          Returns the overflow policy.
 void setOverflowPolicy(String policy)
          Sets the overflow policy.
 

Field Detail

BLOCK_OVERFLOW_POLICY

public static final String BLOCK_OVERFLOW_POLICY
An overflow policy that block incoming messages until a message is delivered on the output.
Warning when using this overflow policy a InterruptedPushExceptionmay be thrown.

See Also:
Constant Field Values

DROP_QUEUE_MESSAGE_OVERFLOW_POLICY

public static final String DROP_QUEUE_MESSAGE_OVERFLOW_POLICY
An overflow policy that drops a message message from the queue when it is full.

See Also:
Constant Field Values

DROP_FIRST_OVERFLOW_POLICY

public static final String DROP_FIRST_OVERFLOW_POLICY
An overflow policy that drops the first message of the queue when it is full.

See Also:
Constant Field Values

DROP_LAST_OVERFLOW_POLICY

public static final String DROP_LAST_OVERFLOW_POLICY
An overflow policy that drops the last message of the queue when it is full.

See Also:
Constant Field Values

DROP_PROCESSED_MESSAGE_OVERFLOW_POLICY

public static final String DROP_PROCESSED_MESSAGE_OVERFLOW_POLICY
An overflow policy that drops the current message when the queue is full: this means that the message will not be inserted into the queue.

See Also:
Constant Field Values

EXCEPTION_OVERFLOW_POLICY

public static final String EXCEPTION_OVERFLOW_POLICY
An overflow policy that causes the Push server interface to throw a BufferOverflowException

See Also:
Constant Field Values
Method Detail

getOverflowPolicy

public String getOverflowPolicy()
Returns the overflow policy.

Returns:
the overflow policy.

setOverflowPolicy

public void setOverflowPolicy(String policy)
Sets the overflow policy.

Parameters:
policy - the overflow policy.
Throws:
IllegalArgumentException - if the given string is not reconized as a valid policy.


Copyright © 2003, 2004 - INRIA Rhone-Alpes - All Rights Reserved.