eu.europeana.cloud.service.dps.storm

Class AbstractDpsBolt

java.lang.Object

org.apache.storm.topology.base.BaseComponent

org.apache.storm.topology.base.BaseRichBolt

eu.europeana.cloud.service.dps.storm.AbstractDpsBolt

All Implemented Interfaces:

Serializable, org.apache.storm.task.IBolt, org.apache.storm.topology.IComponent, org.apache.storm.topology.IRichBolt

Direct Known Subclasses:

ProgressBolt

public abstract class AbstractDpsBolt
extends org.apache.storm.topology.base.BaseRichBolt

Abstract class for all Storm bolts used in Europeana Cloud.

Author:

Pavel Kefurt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.storm.tuple.Tuple	inputTuple
protected eu.europeana.cloud.service.dps.TaskExecutionKillService	killService
static String	NOTIFICATION_STREAM_NAME
protected org.apache.storm.task.OutputCollector	outputCollector
protected Map	stormConfig
protected org.apache.storm.task.TopologyContext	topologyContext
protected String	topologyName

Constructor Summary

Constructors

Constructor and Description
AbstractDpsBolt()

Method Summary

Methods

Modifier and Type	Method and Description
void	declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer declarer)
protected void	emitDropNotification(long taskId, String resource, String message, String additionalInformations) Emit NotificationTuple with error notification to NOTIFICATION_STREAM_NAME.
protected void	emitErrorNotification(long taskId, String resource, String message, String additionalInformations) Emit NotificationTuple with error notification to NOTIFICATION_STREAM_NAME.
protected void	emitKillNotification(long taskId, String resource, String message, String additionalInformations) Emit NotificationTuple with kill notification to NOTIFICATION_STREAM_NAME.
protected void	emitSuccess(StormTaskTuple t)
protected void	endTask(long taskId, String info, eu.europeana.cloud.common.model.dps.TaskState state, Date finishTime)
abstract void	execute(StormTaskTuple t)
void	execute(org.apache.storm.tuple.Tuple tuple)
protected void	logAndEmitError(StormTaskTuple t, String message)
protected void	logAndEmitError(StormTaskTuple t, String message, Exception e)
abstract void	prepare()
void	prepare(Map stormConfig, org.apache.storm.task.TopologyContext tc, org.apache.storm.task.OutputCollector oc)
protected void	updateTask(long taskId, String info, eu.europeana.cloud.common.model.dps.TaskState state, Date startTime)

Methods inherited from class org.apache.storm.topology.base.BaseRichBolt

cleanup

Methods inherited from class org.apache.storm.topology.base.BaseComponent

getComponentConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.storm.topology.IComponent

getComponentConfiguration

Field Detail

NOTIFICATION_STREAM_NAME

public static final String NOTIFICATION_STREAM_NAME

See Also:

Constant Field Values

inputTuple

protected org.apache.storm.tuple.Tuple inputTuple

stormConfig

protected Map stormConfig

topologyContext

protected org.apache.storm.task.TopologyContext topologyContext

outputCollector

protected org.apache.storm.task.OutputCollector outputCollector

killService

protected eu.europeana.cloud.service.dps.TaskExecutionKillService killService

topologyName

protected String topologyName

Constructor Detail

AbstractDpsBolt

public AbstractDpsBolt()

Method Detail

execute

public abstract void execute(StormTaskTuple t)

prepare

public abstract void prepare()

execute

public void execute(org.apache.storm.tuple.Tuple tuple)

prepare

public void prepare(Map stormConfig,
           org.apache.storm.task.TopologyContext tc,
           org.apache.storm.task.OutputCollector oc)

declareOutputFields

public void declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer declarer)

emitDropNotification

protected void emitDropNotification(long taskId,
                        String resource,
                        String message,
                        String additionalInformations)

Emit NotificationTuple with error notification to NOTIFICATION_STREAM_NAME. Only one notification call per resource per task.

Parameters:

taskId - task ID

resource - affected resource (e.g. file URL)

message - short text

additionalInformations - the rest of informations (e.g. stack trace)

emitErrorNotification

protected void emitErrorNotification(long taskId,
                         String resource,
                         String message,
                         String additionalInformations)

Emit NotificationTuple with error notification to NOTIFICATION_STREAM_NAME. Only one notification call per resource per task.

Parameters:

taskId - task ID

resource - affected resource (e.g. file URL)

message - short text

additionalInformations - the rest of informations (e.g. stack trace)

emitKillNotification

protected void emitKillNotification(long taskId,
                        String resource,
                        String message,
                        String additionalInformations)

Emit NotificationTuple with kill notification to NOTIFICATION_STREAM_NAME. Only one notification call per resource per task.

Parameters:

taskId - task ID

resource - affected resource (e.g. file URL)

message - short text

additionalInformations - the rest of informations

endTask

protected void endTask(long taskId,
           String info,
           eu.europeana.cloud.common.model.dps.TaskState state,
           Date finishTime)

updateTask

protected void updateTask(long taskId,
              String info,
              eu.europeana.cloud.common.model.dps.TaskState state,
              Date startTime)

logAndEmitError

protected void logAndEmitError(StormTaskTuple t,
                   String message)

logAndEmitError

protected void logAndEmitError(StormTaskTuple t,
                   String message,
                   Exception e)

emitSuccess

protected void emitSuccess(StormTaskTuple t)