org.apache.gobblin.service

Class FlowConfigResourceLocalHandler

java.lang.Object

org.apache.gobblin.service.FlowConfigResourceLocalHandler

All Implemented Interfaces:

FlowConfigsResourceHandler

Direct Known Subclasses:

FlowConfigV2ResourceLocalHandler

public class FlowConfigResourceLocalHandler
extends Object
implements FlowConfigsResourceHandler

A FlowConfigsResourceHandler that handles Restli locally.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContextAwareMeter	createFlow
protected ContextAwareMeter	deleteFlow
protected FlowCatalog	flowCatalog
static Schedule	NEVER_RUN_CRON_SCHEDULE
protected ContextAwareMeter	runImmediatelyFlow

Constructor Summary

Constructors

Constructor and Description
FlowConfigResourceLocalHandler(FlowCatalog flowCatalog)

Method Summary

Modifier and Type	Method and Description
com.linkedin.restli.server.CreateResponse	createFlowConfig(FlowConfig flowConfig) Add flowConfig locally and trigger all listeners
com.linkedin.restli.server.CreateResponse	createFlowConfig(FlowConfig flowConfig, boolean triggerListener) Add flowConfig locally and trigger all listeners iff @param triggerListener is set to true
static FlowSpec	createFlowSpecForConfig(FlowConfig flowConfig) Build a FlowSpec from a FlowConfig
com.linkedin.restli.server.UpdateResponse	deleteFlowConfig(FlowId flowId, Properties header) Delete flowConfig locally and trigger all listeners
com.linkedin.restli.server.UpdateResponse	deleteFlowConfig(FlowId flowId, Properties header, boolean triggerListener) Delete flowConfig locally and trigger all listeners iff @param triggerListener is set to true
Collection<FlowConfig>	getAllFlowConfigs() Get all flow configs
FlowConfig	getFlowConfig(FlowId flowId) Get flow config given a FlowId
Collection<FlowConfig>	getFlowConfig(FlowSpecSearchObject flowSpecSearchObject) Get flow config given a FlowSpecSearchObject
com.linkedin.restli.server.UpdateResponse	partialUpdateFlowConfig(FlowId flowId, com.linkedin.restli.common.PatchRequest<FlowConfig> flowConfigPatch) Partial update a FlowConfig
com.linkedin.restli.server.UpdateResponse	updateFlowConfig(FlowId flowId, FlowConfig flowConfig) Update flowConfig locally and trigger all listeners
com.linkedin.restli.server.UpdateResponse	updateFlowConfig(FlowId flowId, FlowConfig flowConfig, boolean triggerListener) Update flowConfig locally and trigger all listeners iff @param triggerListener is set to true

Methods inherited from class java.lang.Object

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

Field Detail

NEVER_RUN_CRON_SCHEDULE

public static final Schedule NEVER_RUN_CRON_SCHEDULE

flowCatalog

protected FlowCatalog flowCatalog

createFlow

protected final ContextAwareMeter createFlow

deleteFlow

protected final ContextAwareMeter deleteFlow

runImmediatelyFlow

protected final ContextAwareMeter runImmediatelyFlow

Constructor Detail

FlowConfigResourceLocalHandler

@Inject
public FlowConfigResourceLocalHandler(FlowCatalog flowCatalog)

Method Detail

getFlowConfig

public FlowConfig getFlowConfig(FlowId flowId)
                         throws FlowConfigLoggedException

Get flow config given a FlowId

Specified by:

getFlowConfig in interface FlowConfigsResourceHandler

Throws:

FlowConfigLoggedException

getFlowConfig

public Collection<FlowConfig> getFlowConfig(FlowSpecSearchObject flowSpecSearchObject)
                                     throws FlowConfigLoggedException

Get flow config given a FlowSpecSearchObject

Specified by:

getFlowConfig in interface FlowConfigsResourceHandler

Returns:

all the FlowConfigs that satisfy the FlowSpecSearchObject

Throws:

FlowConfigLoggedException

getAllFlowConfigs

public Collection<FlowConfig> getAllFlowConfigs()

Get all flow configs

Specified by:

getAllFlowConfigs in interface FlowConfigsResourceHandler

createFlowConfig

public com.linkedin.restli.server.CreateResponse createFlowConfig(FlowConfig flowConfig,
                                                                  boolean triggerListener)
                                                           throws FlowConfigLoggedException

Add flowConfig locally and trigger all listeners iff @param triggerListener is set to true

Throws:

FlowConfigLoggedException

createFlowConfig

public com.linkedin.restli.server.CreateResponse createFlowConfig(FlowConfig flowConfig)
                                                           throws FlowConfigLoggedException

Add flowConfig locally and trigger all listeners

Specified by:

createFlowConfig in interface FlowConfigsResourceHandler

Throws:

FlowConfigLoggedException

updateFlowConfig

public com.linkedin.restli.server.UpdateResponse updateFlowConfig(FlowId flowId,
                                                                  FlowConfig flowConfig,
                                                                  boolean triggerListener)

Update flowConfig locally and trigger all listeners iff @param triggerListener is set to true

updateFlowConfig

public com.linkedin.restli.server.UpdateResponse updateFlowConfig(FlowId flowId,
                                                                  FlowConfig flowConfig)
                                                           throws FlowConfigLoggedException

Update flowConfig locally and trigger all listeners

Specified by:

updateFlowConfig in interface FlowConfigsResourceHandler

Throws:

FlowConfigLoggedException

partialUpdateFlowConfig

public com.linkedin.restli.server.UpdateResponse partialUpdateFlowConfig(FlowId flowId,
                                                                         com.linkedin.restli.common.PatchRequest<FlowConfig> flowConfigPatch)
                                                                  throws FlowConfigLoggedException

Description copied from interface: FlowConfigsResourceHandler

Partial update a FlowConfig

Specified by:

partialUpdateFlowConfig in interface FlowConfigsResourceHandler

Throws:

FlowConfigLoggedException

deleteFlowConfig

public com.linkedin.restli.server.UpdateResponse deleteFlowConfig(FlowId flowId,
                                                                  Properties header,
                                                                  boolean triggerListener)
                                                           throws FlowConfigLoggedException

Delete flowConfig locally and trigger all listeners iff @param triggerListener is set to true

Throws:

FlowConfigLoggedException

deleteFlowConfig

public com.linkedin.restli.server.UpdateResponse deleteFlowConfig(FlowId flowId,
                                                                  Properties header)
                                                           throws FlowConfigLoggedException

Delete flowConfig locally and trigger all listeners

Specified by:

deleteFlowConfig in interface FlowConfigsResourceHandler

Throws:

FlowConfigLoggedException

createFlowSpecForConfig

public static FlowSpec createFlowSpecForConfig(FlowConfig flowConfig)

Build a FlowSpec from a FlowConfig

Parameters:

flowConfig - flow configuration

Returns:

FlowSpec created with attributes from flowConfig