org.apache.oozie.fluentjob.api.action

Class ErrorHandler

java.lang.Object

org.apache.oozie.fluentjob.api.action.ErrorHandler

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class ErrorHandler
extends Object

A class encapsulating an action so that it can be used as an error handler in a workflow. In an Oozie workflow definition (XML), every action has an "ok-transition" that is taken if the action completed successfully and an "error-transition" that is taken if the action failed. In this API, the dependency relations specified will be translated into "ok-transitions". If you would like to provide some error handling in case of action failure, you should add an ErrorHandler to the Node representing the action. The error handler action will be added as the "error-transition" of the original action in the generated Oozie workflow XML. Both the "ok-transition" and the "error-transition" of the error handler action itself will lead to an autogenerated kill node.

Method Summary

Modifier and Type	Method and Description
static ErrorHandler	buildAsErrorHandler(Builder<? extends Node> builder) Creates a new ErrorHandler.
Node	getHandlerNode() Returns the error handler action node.
String	getName() Returns the name of the error handler action.

Methods inherited from class java.lang.Object

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

Method Detail

buildAsErrorHandler

public static ErrorHandler buildAsErrorHandler(Builder<? extends Node> builder)

Creates a new ErrorHandler. The provided builder is used to build the underlying error handler action. The builder should be in a state where no parents are specified, otherwise an exception is thrown.

Parameters:

builder - The builder that is used to build the underlying error handler node.

Returns:

A new ErrorHandler.

Throws:

IllegalStateException - if the provided builder has parents registered.

getName

public String getName()

Returns the name of the error handler action.

Returns:

The name of the error handler action.

getHandlerNode

public Node getHandlerNode()

Returns the error handler action node.

Returns:

The error handler action node.