Skip navigation links

com.bea.wlevs.management.configuration
Interface EventQueueMBean

All Known Subinterfaces:

EventChannelMBean, StreamMBean

public interface EventQueueMBean

Method Summary

abstract void	configureQueueing(int consumerThreads, int queueSize) This method sets both the max threads and the max size.
abstract int	getCurrentSize() Returns the current (used) size of Event Queue
abstract int	getMaxSize() This method reads the size of the Channel.
abstract int	getMaxThreads() This method reads the maximum number of Threads associated with the Stream's WorkManager
abstract long	getOfferTimeout() Returns the timeout value used for waiting up until space becomes available in the event queue.
abstract boolean	isFailWhenRejected() Returns true if an event processing exception should be raised when event queue is full and no space is available after offer timeout expires.
abstract void	setFailWhenRejected(boolean value) Raise an EventProcessingException if the event queue is full when the offer timeout expires.
abstract void	setMaxSize(int size) This method sets the size of the Channel.
abstract void	setMaxThreads(int size) This method sets the maximum number of Threads associated with the Stream's WorkManager
abstract void	setOfferTimeout(long timeout) Sets the timeout value used when the event queue is full and a pending insert (offer) is blocked.

Method Detail

getMaxSize

public int getMaxSize()
               throws javax.management.JMException

This method reads the size of the Channel. Only applicable if maxThreads is greater than zero.

Returns:

int - size of the stream

Throws:

javax.management.JMException -

setMaxSize

public void setMaxSize(int size)
                throws javax.management.JMException

This method sets the size of the Channel. Only applicable if maxThreads is greater than zero.

Parameters:

size - - size of the Stream to set

Throws:

javax.management.JMException -

getMaxThreads

public int getMaxThreads()
                  throws javax.management.JMException

This method reads the maximum number of Threads associated with the Stream's WorkManager

Returns:

int - Number of threads WorkManager can spawn

Throws:

javax.management.JMException -

setMaxThreads

public void setMaxThreads(int size)
                   throws javax.management.JMException

This method sets the maximum number of Threads associated with the Stream's WorkManager

Parameters:

size - - Number of maximum threads that is associated with the WorkManager

Throws:

javax.management.JMException -

configureQueueing

public void configureQueueing(int consumerThreads,
                              int queueSize)
                       throws javax.management.JMException

This method sets both the max threads and the max size. There are cases when it is useful to set both attributes in the same operation.

Parameters:

consumerThreads -

queueSize -

getCurrentSize

public int getCurrentSize()
                   throws javax.management.JMException

Returns the current (used) size of Event Queue

Returns:

size - int current size

getOfferTimeout

public long getOfferTimeout()
                     throws javax.management.JMException

Returns the timeout value used for waiting up until space becomes available in the event queue. This is only applicable for event queue's whose max-size is greater than 0. The time unit is nanoseconds. The default offer timeout is 60 seconds.

Returns:

long offer timeout

setOfferTimeout

public void setOfferTimeout(long timeout)
                     throws javax.management.JMException

Sets the timeout value used when the event queue is full and a pending insert (offer) is blocked. When the timeout expires the pending event will either be dropped or an exception raised, depending on setFailWhenRejected(boolean). This is only applicable for event queue's whose max-size is greater than 0. The time unit is nanoseconds. The default offer timeout is 60 seconds.

Parameters:

timeout - offer timeout

Throws:

javax.management.JMException -

setFailWhenRejected

public void setFailWhenRejected(boolean value)
                         throws javax.management.JMException

Raise an EventProcessingException if the event queue is full when the offer timeout expires. If set to false, or not set at all, then the event is dropped rather than exception being raised. This configuration is only applicable for event queue's whose max-size is greater than 0.

The default value is false.

Parameters:

value - true if exception should be raised when rejected, false if event should be dropped instead.

isFailWhenRejected

public boolean isFailWhenRejected()
                           throws javax.management.JMException

Returns true if an event processing exception should be raised when event queue is full and no space is available after offer timeout expires. If set to false, then event is dropped rather than exception being raised. This configuration is only applicable for event queue's whose max-size is greater than 0. If this is not the case, then configuration is ignored.

Returns:

boolean true if exception should be raised when rejected, false if event should be dropped instead.