io.cdap.cdap.api.customaction

Class AbstractCustomAction

java.lang.Object

io.cdap.cdap.api.customaction.AbstractCustomAction

All Implemented Interfaces:

CustomAction, ProgramLifecycle<CustomActionContext>

public abstract class AbstractCustomAction
extends Object
implements CustomAction

This abstract class provides a default implementation of CustomAction methods for easy extensions.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCustomAction()
protected	AbstractCustomAction(String name)

Method Summary

Modifier and Type	Method and Description
protected void	configure()
void	configure(CustomActionConfigurer configurer) Configure the custom action.
void	destroy() Destroy is the last thing that gets called before the program is shutdown.
protected CustomActionContext	getContext()
protected void	initialize() Classes derived from AbstractCustomAction can override this method to initialize the CustomAction.
void	initialize(CustomActionContext context) Initializes a Program.
protected void	setDescription(String description)
protected void	setName(String name)
protected void	setProperties(Map<String,String> properties)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.cdap.cdap.api.customaction.CustomAction

run

Constructor Detail

AbstractCustomAction

protected AbstractCustomAction()

AbstractCustomAction

protected AbstractCustomAction(String name)

Method Detail

configure

public final void configure(CustomActionConfigurer configurer)

Description copied from interface: CustomAction

Configure the custom action.

Specified by:

configure in interface CustomAction

Parameters:

configurer - the CustomActionConfigurer used to configure the action.

configure

protected void configure()

setName

protected void setName(String name)

setDescription

protected void setDescription(String description)

setProperties

protected void setProperties(Map<String,String> properties)

initialize

public final void initialize(CustomActionContext context)
                      throws Exception

Description copied from interface: ProgramLifecycle

Initializes a Program.

This method will be called only once per ProgramLifecycle instance.

Specified by:

initialize in interface ProgramLifecycle<CustomActionContext>

Parameters:

context - An instance of RuntimeContext

Throws:

Exception - If there is any error during initialization.

initialize

protected void initialize()
                   throws Exception

Classes derived from AbstractCustomAction can override this method to initialize the CustomAction.

Throws:

Exception - if there is any error in initializing the custom action

destroy

public void destroy()

Description copied from interface: ProgramLifecycle

Destroy is the last thing that gets called before the program is shutdown. So, if there are any cleanups then they can be specified here.

Specified by:

destroy in interface ProgramLifecycle<CustomActionContext>

getContext

protected final CustomActionContext getContext()