org.apache.gobblin.service

Class FlowConfigsResource

java.lang.Object

com.linkedin.restli.server.resources.ResourceContextHolder

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

org.apache.gobblin.service.FlowConfigsResource

All Implemented Interfaces:

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

public class FlowConfigsResource
extends com.linkedin.restli.server.resources.ComplexKeyResourceTemplate<FlowId,com.linkedin.restli.common.EmptyRecord,FlowConfig>

Resource for handling flow configuration requests

Field Summary

Fields

Modifier and Type	Field and Description
static String	INJECT_READY_TO_USE

Constructor Summary

Constructors

Constructor and Description
FlowConfigsResource()

Method Summary

Modifier and Type	Method and Description
static void	checkRequester(RequesterService requesterService, FlowConfig originalFlowConfig, List<ServiceRequester> requesterList) Check that all ServiceRequesters in this request are contained within the original service requester list when the flow was submitted.
com.linkedin.restli.server.CreateResponse	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,com.linkedin.restli.common.EmptyRecord> key) Delete a configured flow.
FlowConfig	get(com.linkedin.restli.common.ComplexResourceKey<FlowId,com.linkedin.restli.common.EmptyRecord> key) Retrieve the flow configuration with the given key
com.linkedin.restli.server.UpdateResponse	update(com.linkedin.restli.common.ComplexResourceKey<FlowId,com.linkedin.restli.common.EmptyRecord> key, FlowConfig flowConfig) Update the flow configuration with the specified key.

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

batchCreate, batchDelete, batchGet, batchUpdate, batchUpdate, getAll, update

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

Constructor Detail

FlowConfigsResource

public FlowConfigsResource()

Method Detail

get

public FlowConfig get(com.linkedin.restli.common.ComplexResourceKey<FlowId,com.linkedin.restli.common.EmptyRecord> 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,com.linkedin.restli.common.EmptyRecord>,FlowConfig>

Overrides:

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

Parameters:

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

Returns:

FlowConfig with flow configuration

create

public com.linkedin.restli.server.CreateResponse 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,com.linkedin.restli.common.EmptyRecord>,FlowConfig>

Overrides:

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

Parameters:

flowConfig - flow configuration

Returns:

CreateResponse

update

public com.linkedin.restli.server.UpdateResponse update(com.linkedin.restli.common.ComplexResourceKey<FlowId,com.linkedin.restli.common.EmptyRecord> 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,com.linkedin.restli.common.EmptyRecord>,FlowConfig>

Overrides:

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

Parameters:

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

flowConfig - new flow configuration

Returns:

UpdateResponse

delete

public com.linkedin.restli.server.UpdateResponse delete(com.linkedin.restli.common.ComplexResourceKey<FlowId,com.linkedin.restli.common.EmptyRecord> 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,com.linkedin.restli.common.EmptyRecord>,FlowConfig>

Overrides:

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

Parameters:

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

Returns:

UpdateResponse

checkRequester

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

Check that all ServiceRequesters in this request are contained within the original service requester list 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:

requesterService - the RequesterService used to verify the requester

originalFlowConfig - original flow config to find original requester

requesterList - list of requesters for this request