com.github.lookout.whoas

Class AbstractHookQueue

java.lang.Object

com.github.lookout.whoas.AbstractHookQueue

Direct Known Subclasses:

InMemoryQueue, RedisQueue

public abstract class AbstractHookQueue
extends java.lang.Object

Interface defining how 'HookQueue' providers should behave This allows for different queueing implementations behind whoas

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	started

Constructor Summary

Constructors

Constructor and Description
AbstractHookQueue()

Method Summary

Modifier and Type	Method and Description
abstract int	getSize()
abstract void	pop(QueueAction action)
abstract java.lang.Boolean	push(HookRequest request)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

started

protected java.lang.Boolean started

Constructor Detail

AbstractHookQueue

public AbstractHookQueue()

Method Detail

start

public void start()

stop

public void stop()

getSize

public abstract int getSize()
                     throws java.lang.Exception

Returns:

Size of the queue, if not implemented by the provider, returns -1

Throws:

java.lang.Exception - implementors may throw Exceptions

pop

public abstract void pop(QueueAction action)
                  throws java.lang.Exception

Parameters:

action - a QueueAction to invoke

Throws:

java.lang.Exception - the underlying QueueAction may throw any form of exception

push

public abstract java.lang.Boolean push(HookRequest request)
                                throws java.lang.Exception

Parameters:

request - A valid HookRequest

Returns:

true if the HookRequest was successfully added to the queue

Throws:

java.lang.Exception - implementors may throw Exceptions