public abstract class EventHandler extends Object implements Runnable, Comparable<Runnable>
process()
method. Subclasses should also do all
necessary checks up in their constructor if possible -- check table exists,
is disabled, etc. -- so they fail fast rather than later when process is
running. Do it this way because process be invoked directly but event
handlers are also
run in an executor context -- i.e. asynchronously -- and in this case,
exceptions thrown at process time will not be seen by the invoker, not till
we implement a call-back mechanism so the client can pick them up later.
Event handlers have an EventHandler.EventType
.
EventHandler.EventType
is a list of ALL handler event types. We need to keep
a full list in one place -- and as enums is a good shorthand for an
implemenations -- because event handlers can be passed to executors when
they are to be run asynchronously. The
hbase executor, see ExecutorService
, has a switch for passing
event type to executor.
Event listeners can be installed and will be called pre- and post- process if
this EventHandler is run in a Thread (its a Runnable so if its run()
method gets called). Implement
EventHandler.EventHandlerListener
s, and registering using
setListener(EventHandlerListener)
.
ExecutorService
Modifier and Type | Class and Description |
---|---|
static interface |
EventHandler.EventHandlerListener
This interface provides pre- and post-process hooks for events.
|
static class |
EventHandler.EventType
List of all HBase event handler types.
|
Modifier and Type | Field and Description |
---|---|
protected EventHandler.EventType |
eventType |
protected static AtomicLong |
seqids |
protected Server |
server |
protected int |
waitingTimeForEvents |
Constructor and Description |
---|
EventHandler(Server server,
EventHandler.EventType eventType)
Default base class constructor.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Runnable o)
Default prioritized runnable comparator which implements a FIFO ordering.
|
EventHandler.EventType |
getEventType()
Return the event type
|
String |
getInformativeName()
Event implementations should override thie class to provide an
informative name about what event they are handling.
|
EventHandler.EventHandlerListener |
getListener() |
int |
getPriority()
Get the priority level for this handler instance.
|
long |
getSeqid() |
abstract void |
process()
This method is the main processing loop to be implemented by the various
subclasses.
|
void |
run() |
void |
setListener(EventHandler.EventHandlerListener listener) |
String |
toString() |
protected EventHandler.EventType eventType
protected Server server
protected static AtomicLong seqids
protected final int waitingTimeForEvents
public EventHandler(Server server, EventHandler.EventType eventType)
public abstract void process() throws IOException
IOException
public EventHandler.EventType getEventType()
public int getPriority()
Lowest priority is Integer.MAX_VALUE. Highest priority is 0.
Subclasses should override this method to allow prioritizing handlers.
Handlers with the same priority are handled in FIFO order.
public long getSeqid()
public int compareTo(Runnable o)
Subclasses should not override this. Instead, if they want to implement
priority beyond FIFO, they should override getPriority()
.
compareTo
in interface Comparable<Runnable>
public EventHandler.EventHandlerListener getListener()
public void setListener(EventHandler.EventHandlerListener listener)
listener
- Listener to call pre- and post- process()
.public String getInformativeName()
Copyright © 2014 The Apache Software Foundation. All Rights Reserved.