io.cdap.cdap.api.app

Class AbstractApplication<T extends Config>

java.lang.Object

io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable<T>

io.cdap.cdap.internal.api.AbstractPluginConfigurable<ApplicationConfigurer>

io.cdap.cdap.api.app.AbstractApplication<T>

Type Parameters:

T - Config config class that represents the configuration of the Application.

All Implemented Interfaces:

Application<T>

Direct Known Subclasses:

PartitionExploreCorrector

public abstract class AbstractApplication<T extends Config>
extends AbstractPluginConfigurable<ApplicationConfigurer>
implements Application<T>

A support class for Applications which reduces repetition and results in a more readable configuration.

Implement the configure() method to define your application.

See Also:

io.cdap.cdap.api.app

Constructor Summary

Constructors

Constructor and Description
AbstractApplication()

Method Summary

Modifier and Type	Method and Description
protected void	addMapReduce(MapReduce mapReduce)
protected void	addService(Service service)
protected void	addService(String name, HttpServiceHandler handler, HttpServiceHandler... handlers) Adds a Service that consists of the given HttpServiceHandler.
protected void	addSpark(Spark spark)
protected void	addWorker(Worker worker)
protected void	addWorkflow(Workflow workflow)
protected ScheduleBuilder	buildSchedule(String scheduleName, ProgramType programType, String programName) Get a ScheduleBuilder for the specified program.
abstract void	configure() Override this method to declare and configure the application.
void	configure(ApplicationConfigurer configurer, ApplicationContext<T> context) Configures the Application.
protected T	getConfig() Get the configuration object.
protected ApplicationConfigurer	getConfigurer()
protected ApplicationContext<T>	getContext()
protected TriggerFactory	getTriggerFactory() Get a TriggerFactory to get triggers.
protected void	schedule(ScheduleCreationSpec scheduleCreationSpec) Schedules a program, using the given scheduleCreationSpec.
protected void	setDescription(String description)
protected void	setName(String name)

Methods inherited from class io.cdap.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

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.app.Application

isUpdateSupported, updateConfig

Constructor Detail

AbstractApplication

public AbstractApplication()

Method Detail

configure

public abstract void configure()

Override this method to declare and configure the application.

configure

public final void configure(ApplicationConfigurer configurer,
                            ApplicationContext<T> context)

Description copied from interface: Application

Configures the Application.

Specified by:

configure in interface Application<T extends Config>

Parameters:

configurer - Collects the Application configuration

context - Used to access the environment, application configuration, and application (deployment) arguments

getConfigurer

protected ApplicationConfigurer getConfigurer()

Specified by:

getConfigurer in class AbstractPluginConfigurable<ApplicationConfigurer>

Returns:

The ApplicationConfigurer used to configure the Application

getContext

protected final ApplicationContext<T> getContext()

Returns:

The ApplicationContext of the Application

getConfig

protected T getConfig()

Get the configuration object.

Returns:

application configuration provided during application creation

setName

protected void setName(String name)

See Also:

ApplicationConfigurer.setName(String)

setDescription

protected void setDescription(String description)

See Also:

ApplicationConfigurer.setDescription(String)

addMapReduce

protected void addMapReduce(MapReduce mapReduce)

See Also:

ApplicationConfigurer.addMapReduce(MapReduce)

addSpark

protected void addSpark(Spark spark)

See Also:

ApplicationConfigurer.addSpark(Spark)

addWorkflow

protected void addWorkflow(Workflow workflow)

See Also:

ApplicationConfigurer.addWorkflow(Workflow)

addService

protected void addService(Service service)

See Also:

ApplicationConfigurer.addService(Service)

addWorker

protected void addWorker(Worker worker)

See Also:

ApplicationConfigurer.addWorker(Worker)

addService

protected void addService(String name,
                          HttpServiceHandler handler,
                          HttpServiceHandler... handlers)

Adds a Service that consists of the given HttpServiceHandler.

Parameters:

name - Name of the Service

handler - handler for the Service

handlers - more handlers for the Service

buildSchedule

protected ScheduleBuilder buildSchedule(String scheduleName,
                                        ProgramType programType,
                                        String programName)

Get a ScheduleBuilder for the specified program.

Parameters:

scheduleName - the name of the schedule

programType - the type of the program; currently, only ProgramType.WORKFLOW can be scheduled

programName - the name of the program

Returns:

The ScheduleBuilder used to build the schedule

schedule

protected void schedule(ScheduleCreationSpec scheduleCreationSpec)

Schedules a program, using the given scheduleCreationSpec.

Parameters:

scheduleCreationSpec - defines the schedule.

getTriggerFactory

protected TriggerFactory getTriggerFactory()

Get a TriggerFactory to get triggers.

Returns:

The TriggerFactory used to get triggers