org.apache.gobblin.service

Class FlowConfigsV2Resource

java.lang.Object

com.linkedin.restli.server.resources.ResourceContextHolder

com.linkedin.restli.server.resources.ComplexKeyResourceTemplate<FlowId,FlowStatusId,FlowConfig>

org.apache.gobblin.service.FlowConfigsV2Resource

All Implemented Interfaces:

com.linkedin.restli.server.resources.BaseResource, com.linkedin.restli.server.resources.CollectionResource<com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId>,FlowConfig>, com.linkedin.restli.server.resources.ComplexKeyResource<FlowId,FlowStatusId,FlowConfig>, com.linkedin.restli.server.resources.KeyValueResource<com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId>,FlowConfig>

public class FlowConfigsV2Resource
extends com.linkedin.restli.server.resources.ComplexKeyResourceTemplate<FlowId,FlowStatusId,FlowConfig>

Resource for handling flow configuration requests

Field Summary

Fields

Modifier and Type	Field and Description
static FlowConfigsResourceHandler	global_flowConfigsResourceHandler
static String	INJECT_READY_TO_USE

Constructor Summary

Constructors

Constructor and Description
FlowConfigsV2Resource()

Method Summary

Modifier and Type	Method and Description
void	checkPropertyUpdatesAllowed(List<ServiceRequester> requesterList, FlowConfig updatedFlowConfig) Check that the properties being updated are allowed to be updated.
void	checkRequester(FlowConfig originalFlowConfig, List<ServiceRequester> requesterList) Check that all ServiceRequesters in this request are contained within the original service requester list or is part of the original requester's owning group when the flow was submitted.
void	checkUpdateDeleteAllowed(FlowConfig originalFlowConfig, FlowConfig updatedFlowConfig) Check that this update or delete operation is allowed, throw a FlowConfigLoggedException if not.
com.linkedin.restli.server.CreateKVResponse	create(FlowConfig flowConfig) Create a flow configuration that the service will forward to execution instances for execution
com.linkedin.restli.server.UpdateResponse	delete(com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId> key) Delete a configured flow.
FlowConfig	get(com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId> key) Retrieve the flow configuration with the given key
List<FlowConfig>	getAll(com.linkedin.restli.server.PagingContext pagingContext) Retrieve all the flow configurations
List<FlowConfig>	getFilteredFlows(com.linkedin.restli.server.PagingContext context, String flowGroup, String flowName, String templateUri, String userToProxy, String sourceIdentifier, String destinationIdentifier, String schedule, Boolean isRunImmediately, String owningGroup, String propertyFilter) Get all FlowConfigs that matches the provided parameters.
String	runImmediately(com.linkedin.restli.server.PathKeys pathKeys) Trigger a new execution of an existing flow
com.linkedin.restli.server.UpdateResponse	update(com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId> key, FlowConfig flowConfig) Update the flow configuration with the specified key.
com.linkedin.restli.server.UpdateResponse	update(com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId> key, com.linkedin.restli.common.PatchRequest<FlowConfig> flowConfigPatch) Partial update the flowConfig specified

Methods inherited from class com.linkedin.restli.server.resources.ComplexKeyResourceTemplate

batchCreate, batchDelete, batchGet, batchUpdate, batchUpdate

Methods inherited from class com.linkedin.restli.server.resources.ResourceContextHolder

getContext, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linkedin.restli.server.resources.BaseResource

getContext, setContext

Field Detail

INJECT_READY_TO_USE

public static final String INJECT_READY_TO_USE

See Also:

Constant Field Values

global_flowConfigsResourceHandler

public static FlowConfigsResourceHandler global_flowConfigsResourceHandler

Constructor Detail

FlowConfigsV2Resource

public FlowConfigsV2Resource()

Method Detail

get

public FlowConfig get(com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId> key)

Retrieve the flow configuration with the given key

Specified by:

get in interface com.linkedin.restli.server.resources.CollectionResource<com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId>,FlowConfig>

Overrides:

get in class com.linkedin.restli.server.resources.ComplexKeyResourceTemplate<FlowId,FlowStatusId,FlowConfig>

Parameters:

key - flow config id key containing group name and flow name

Returns:

FlowConfig with flow configuration

getAll

public List<FlowConfig> getAll(com.linkedin.restli.server.PagingContext pagingContext)

Retrieve all the flow configurations

Specified by:

getAll in interface com.linkedin.restli.server.resources.CollectionResource<com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId>,FlowConfig>

Overrides:

getAll in class com.linkedin.restli.server.resources.ComplexKeyResourceTemplate<FlowId,FlowStatusId,FlowConfig>

getFilteredFlows

public List<FlowConfig> getFilteredFlows(com.linkedin.restli.server.PagingContext context,
                                         String flowGroup,
                                         String flowName,
                                         String templateUri,
                                         String userToProxy,
                                         String sourceIdentifier,
                                         String destinationIdentifier,
                                         String schedule,
                                         Boolean isRunImmediately,
                                         String owningGroup,
                                         String propertyFilter)

Get all FlowConfigs that matches the provided parameters. All the parameters are optional. If a parameter is null, it is ignored. FlowConfigV2Resource#getFilteredFlows

create

public com.linkedin.restli.server.CreateKVResponse create(FlowConfig flowConfig)

Create a flow configuration that the service will forward to execution instances for execution

Specified by:

create in interface com.linkedin.restli.server.resources.CollectionResource<com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId>,FlowConfig>

Overrides:

create in class com.linkedin.restli.server.resources.ComplexKeyResourceTemplate<FlowId,FlowStatusId,FlowConfig>

Parameters:

flowConfig - flow configuration

Returns:

CreateResponse

update

public com.linkedin.restli.server.UpdateResponse update(com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId> key,
                                                        FlowConfig flowConfig)

Update the flow configuration with the specified key. Running flows are not affected. An error is raised if the flow configuration does not exist.

Specified by:

update in interface com.linkedin.restli.server.resources.CollectionResource<com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId>,FlowConfig>

Overrides:

update in class com.linkedin.restli.server.resources.ComplexKeyResourceTemplate<FlowId,FlowStatusId,FlowConfig>

Parameters:

key - composite key containing group name and flow name that identifies the flow to update

flowConfig - new flow configuration

Returns:

UpdateResponse

update

public com.linkedin.restli.server.UpdateResponse update(com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId> key,
                                                        com.linkedin.restli.common.PatchRequest<FlowConfig> flowConfigPatch)

Partial update the flowConfig specified

Specified by:

update in interface com.linkedin.restli.server.resources.CollectionResource<com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId>,FlowConfig>

Overrides:

update in class com.linkedin.restli.server.resources.ComplexKeyResourceTemplate<FlowId,FlowStatusId,FlowConfig>

Parameters:

key - composite key containing group name and flow name that identifies the flow to update

flowConfigPatch - patch describing what fields to change

Returns:

UpdateResponse

delete

public com.linkedin.restli.server.UpdateResponse delete(com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId> key)

Delete a configured flow. Running flows are not affected. The schedule will be removed for scheduled flows.

Specified by:

delete in interface com.linkedin.restli.server.resources.CollectionResource<com.linkedin.restli.common.ComplexResourceKey<FlowId,FlowStatusId>,FlowConfig>

Overrides:

delete in class com.linkedin.restli.server.resources.ComplexKeyResourceTemplate<FlowId,FlowStatusId,FlowConfig>

Parameters:

key - composite key containing flow group and flow name that identifies the flow to remove from the flow catalog

Returns:

UpdateResponse

runImmediately

public String runImmediately(com.linkedin.restli.server.PathKeys pathKeys)

Trigger a new execution of an existing flow

Parameters:

pathKeys - key of FlowId specified in path

checkUpdateDeleteAllowed

public void checkUpdateDeleteAllowed(FlowConfig originalFlowConfig,
                                     FlowConfig updatedFlowConfig)

Check that this update or delete operation is allowed, throw a FlowConfigLoggedException if not.

checkPropertyUpdatesAllowed

public void checkPropertyUpdatesAllowed(List<ServiceRequester> requesterList,
                                        FlowConfig updatedFlowConfig)

Check that the properties being updated are allowed to be updated. This includes: 1. Checking that the requester is part of the owningGroup if it is being modified 2. Checking if the RequesterService.REQUESTER_LIST is being modified, and only allow it if a user is changing it to themselves.

checkRequester

public void checkRequester(FlowConfig originalFlowConfig,
                           List<ServiceRequester> requesterList)

Check that all ServiceRequesters in this request are contained within the original service requester list or is part of the original requester's owning group when the flow was submitted. If they are not, throw a FlowConfigLoggedException with HttpStatus.S_401_UNAUTHORIZED. If there is a failure when deserializing the original requester list, throw a FlowConfigLoggedException with HttpStatus.S_400_BAD_REQUEST.

Parameters:

originalFlowConfig - original flow config to find original requester

requesterList - list of requesters for this request