io.cdap.cdap.etl.api

Class AlertPublisher

java.lang.Object

io.cdap.cdap.etl.api.AlertPublisher

All Implemented Interfaces:

Destroyable, PipelineConfigurable, StageLifecycle<AlertPublisherContext>

public abstract class AlertPublisher
extends Object
implements PipelineConfigurable, StageLifecycle<AlertPublisherContext>

A pipeline stage that can publish any alerts emitted by the previous stage.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_TYPE

Constructor Summary

Constructors

Constructor and Description
AlertPublisher()

Method Summary

Modifier and Type	Method and Description
void	configurePipeline(PipelineConfigurer pipelineConfigurer) Configure an ETL pipeline, registering datasets and plugins that the stage needs.
void	destroy() Invoked for resources cleanup.
protected AlertPublisherContext	getContext()
void	initialize(AlertPublisherContext context) Initialize the Stage.
abstract void	publish(Iterator<Alert> alerts) Publish a collection of alerts.

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_TYPE

public static final String PLUGIN_TYPE

See Also:

Constant Field Values

Constructor Detail

AlertPublisher

public AlertPublisher()

Method Detail

configurePipeline

public void configurePipeline(PipelineConfigurer pipelineConfigurer)

Description copied from interface: PipelineConfigurable

Configure an ETL pipeline, registering datasets and plugins that the stage needs. Validation should be performed in this method, throwing a ValidationException if there are any invalid config properties, or if the input or output schema is not compatible. Output schema should also be set. This method is called many times during the lifecycle of a pipeline so it should not generate any side effects. When the pipeline is being constructed, this is called in order to validate the pipeline and propagate schema. Any datasets registered at this time will be ignored. Config properties that contain macros will not have been evaluated yet. When the pipeline is deployed, this is called in order to validate the pipeline and create any datasets that are registered. Config properties that contain macros will not have been evaluated yet.

Specified by:

configurePipeline in interface PipelineConfigurable

Parameters:

pipelineConfigurer - the configurer used to register required datasets and plugins

initialize

public void initialize(AlertPublisherContext context)
                throws Exception

Description copied from interface: StageLifecycle

Initialize the Stage. Can be used to setup resources.

Specified by:

initialize in interface StageLifecycle<AlertPublisherContext>

Parameters:

context - execution context

Throws:

Exception - if there is any error during initialization

destroy

public void destroy()

Description copied from interface: Destroyable

Invoked for resources cleanup.

Specified by:

destroy in interface Destroyable

publish

public abstract void publish(Iterator<Alert> alerts)
                      throws Exception

Publish a collection of alerts.

Parameters:

alerts - iterator over the alerts

Throws:

Exception - if there was an exception publishing the alerts

getContext

protected AlertPublisherContext getContext()