|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.executor.EventHandler
@InterfaceAudience.Private public abstract class EventHandler
Abstract base class for all HBase event handlers. Subclasses should
implement the process()
and prepare()
methods. Subclasses
should also do all necessary checks up in their prepare() 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 EventType
.
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
Nested Class Summary | |
---|---|
static interface |
EventHandler.EventHandlerListener
This interface provides pre- and post-process hooks for events. |
Field Summary | |
---|---|
protected EventType |
eventType
|
protected static AtomicLong |
seqids
|
protected Server |
server
|
protected int |
waitingTimeForEvents
|
Constructor Summary | |
---|---|
EventHandler(Server server,
EventType eventType)
Default base class constructor. |
Method Summary | |
---|---|
int |
compareTo(Runnable o)
Default prioritized runnable comparator which implements a FIFO ordering. |
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()
|
EventHandler |
prepare()
Event handlers should do all the necessary checks in this method (rather than in the constructor, or in process()) so that the caller, which is mostly executed in the ipc context can fail fast. |
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()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected EventType eventType
protected Server server
protected static final AtomicLong seqids
protected int waitingTimeForEvents
Constructor Detail |
---|
public EventHandler(Server server, EventType eventType)
Method Detail |
---|
public EventHandler prepare() throws Exception
Exception
- when something goes wrongpublic void run()
run
in interface Runnable
public abstract void process() throws IOException
IOException
public 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 toString()
toString
in class Object
public String getInformativeName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |