org.apache.streams.util

Class ComponentUtils

java.lang.Object

org.apache.streams.util.ComponentUtils

public class ComponentUtils
extends Object

Common utilities for Streams components.

Constructor Summary

Constructors

Constructor and Description
ComponentUtils()

Method Summary

Modifier and Type	Method and Description
static <T> void	offerUntilSuccess(T entry, Queue<T> queue) Certain types of queues will fail to Queue.offer(Object) an item due to many factors depending on the type of queue.
static <T> T	pollWhileNotEmpty(Queue<T> queue) Certain types of queues will return null when calling Queue.poll() due to many factors depending on the type of queue.
static <V> void	registerLocalMBean(String name, V mbean) Attempts to register an object with local MBeanServer.
static void	removeAllMBeansOfDomain(String domain) Removes all mbeans registered undered a specific domain.
static void	shutdownExecutor(ExecutorService stream, int initialWait, int secondaryWait) Attempts to safely ExecutorService.shutdown() and ExecutorService.awaitTermination(long, java.util.concurrent.TimeUnit) of an ExecutorService.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentUtils

public ComponentUtils()

Method Detail

offerUntilSuccess

public static <T> void offerUntilSuccess(T entry,
                                         Queue<T> queue)

Certain types of queues will fail to Queue.offer(Object) an item due to many factors depending on the type of queue. offerUntilSuccess will not return until the item has been successfully queued onto the desired queue

Type Parameters:

T - type

Parameters:

entry - item to queue

queue - queue to add the entry to

pollWhileNotEmpty

public static <T> T pollWhileNotEmpty(Queue<T> queue)

Certain types of queues will return null when calling Queue.poll() due to many factors depending on the type of queue. pollWhileNotEmpty will poll the queue until an item from the queue is returned or the queue is empty. If the queue is empty it will return NULL.

Type Parameters:

T - type

Parameters:

queue - queue to read the entry from

Returns:

result

shutdownExecutor

public static void shutdownExecutor(ExecutorService stream,
                                    int initialWait,
                                    int secondaryWait)

Attempts to safely ExecutorService.shutdown() and ExecutorService.awaitTermination(long, java.util.concurrent.TimeUnit) of an ExecutorService.

Parameters:

stream - service to be shutdown

initialWait - time in seconds to wait for currently running threads to finish execution

secondaryWait - time in seconds to wait for running threads that did not terminate to acknowledge their forced termination

removeAllMBeansOfDomain

public static void removeAllMBeansOfDomain(String domain)
                                    throws Exception

Removes all mbeans registered undered a specific domain. Made specificly to clean up at unit tests

Parameters:

domain - mbean domain

Throws:

Exception

registerLocalMBean

public static <V> void registerLocalMBean(String name,
                                          V mbean)

Attempts to register an object with local MBeanServer. Throws runtime exception on errors.

Parameters:

name - name to register bean with

mbean - mbean to register