org.apache.hadoop.chukwa.datacollection.adaptor

Class AbstractWrapper

java.lang.Object

org.apache.hadoop.chukwa.datacollection.adaptor.AbstractWrapper

All Implemented Interfaces:

Adaptor, NotifyOnCommitAdaptor, ChunkReceiver

Direct Known Subclasses:

MemBuffered, WriteaheadBuffered

public class AbstractWrapper
extends Object
implements NotifyOnCommitAdaptor, ChunkReceiver

Constructor Summary

Constructors

Constructor and Description
AbstractWrapper()

Method Summary

Modifier and Type	Method and Description
void	add(Chunk event) Add a chunk to the queue, potentially blocking.
void	committed(long commitedByte)
String	getCurrentStatus() Return the adaptor's state Should not include class name or byte offset, which are written by caller.
String	getType()
String	parseArgs(String innerClassName, String params, AdaptorManager a) Note that the name of the inner class will get parsed out as a type
long	shutdown(AdaptorShutdownPolicy shutdownPolicy) Signals this adaptor to come to an orderly stop.
void	start(String adaptorID, String type, long offset, ChunkReceiver dest) Note that the name of the inner class will get parsed out as a type

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWrapper

public AbstractWrapper()

Method Detail

getCurrentStatus

public String getCurrentStatus()

Description copied from interface: Adaptor

Return the adaptor's state Should not include class name or byte offset, which are written by caller. The datatype should, however, be written by this method.

Specified by:

getCurrentStatus in interface Adaptor

Returns:

the adaptor state as a string

parseArgs

public String parseArgs(String innerClassName,
                        String params,
                        AdaptorManager a)

Note that the name of the inner class will get parsed out as a type

Specified by:

parseArgs in interface Adaptor

Parameters:

innerClassName - Data type

params - Adaptor parameters

a - Adaptor Manager

Returns:

Stream name as a string, null if params are malformed

shutdown

public long shutdown(AdaptorShutdownPolicy shutdownPolicy)
              throws AdaptorException

Description copied from interface: Adaptor

Signals this adaptor to come to an orderly stop. The adaptor ought to push out all the data it can before exiting depending of the shutdown policy

Specified by:

shutdown in interface Adaptor

Parameters:

shutdownPolicy - is defined as forcefully or gracefully

Returns:

the logical offset at which the adaptor was when the method return

Throws:

AdaptorException - Exception on shutdown

getType

public String getType()

Specified by:

getType in interface Adaptor

start

public void start(String adaptorID,
                  String type,
                  long offset,
                  ChunkReceiver dest)
           throws AdaptorException

Note that the name of the inner class will get parsed out as a type

Specified by:

start in interface Adaptor

Parameters:

adaptorID - Adaptor ID

type - the application type, who is starting this adaptor

offset - the stream offset of the first byte sent by this adaptor

dest - Chunk receiving destination

Throws:

AdaptorException - if adaptor can not be started

add

public void add(Chunk event)
         throws InterruptedException

Description copied from interface: ChunkReceiver

Add a chunk to the queue, potentially blocking.

Specified by:

add in interface ChunkReceiver

Parameters:

event - is a Chukwa Chunk

Throws:

InterruptedException - if thread is interrupted while blocking

committed

public void committed(long commitedByte)

Specified by:

committed in interface NotifyOnCommitAdaptor