org.springframework.cloud.dataflow.rest.client

Class DataFlowTemplate

java.lang.Object

org.springframework.cloud.dataflow.rest.client.DataFlowTemplate

All Implemented Interfaces:

DataFlowOperations

public class DataFlowTemplate
extends Object
implements DataFlowOperations

Implementation of DataFlowOperations delegating to sub-templates, discovered via REST relations.

Author:

Ilayaperumal Gopinathan, Mark Fisher, Glenn Renfro, Patrick Peralta, Gary Russell, Eric Bottard, Gunnar Hillert

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,org.springframework.hateoas.UriTemplate>	resources Holds discovered URLs of the API.
protected RestTemplate	restTemplate A template used for http interaction.

Constructor Summary

Constructors

Constructor and Description
DataFlowTemplate(URI baseURI) Setup a DataFlowTemplate using the provided baseURI.
DataFlowTemplate(URI baseURI, RestTemplate restTemplate) Setup a DataFlowTemplate using the provide RestTemplate.

Method Summary

Modifier and Type	Method and Description
AggregateCounterOperations	aggregateCounterOperations() Aggregate Counter related operations.
AppRegistryOperations	appRegistryOperations() Application registry related operations.
CompletionOperations	completionOperations() DSL Completion related operations.
CounterOperations	counterOperations() Counter related operations.
FieldValueCounterOperations	fieldValueCounterOperations() Field Value Counter related operations.
static RestTemplate	getDefaultDataflowRestTemplate() Invokes prepareRestTemplate(RestTemplate).
org.springframework.hateoas.Link	getLink(org.springframework.hateoas.ResourceSupport resourceSupport, String rel)
RestTemplate	getRestTemplate()
JobOperations	jobOperations() Job related operations.
static RestTemplate	prepareRestTemplate(RestTemplate restTemplate) Will augment the provided RestTemplate with the Jackson Mixins required by Spring Cloud Data Flow, specifically:
RuntimeOperations	runtimeOperations() Runtime related opertations.
StreamOperations	streamOperations() Stream related operations.
TaskOperations	taskOperations() Task related operations.

Methods inherited from class java.lang.Object

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

Field Detail

restTemplate

protected final RestTemplate restTemplate

A template used for http interaction.

resources

protected final Map<String,org.springframework.hateoas.UriTemplate> resources

Holds discovered URLs of the API.

Constructor Detail

DataFlowTemplate

public DataFlowTemplate(URI baseURI)

Setup a DataFlowTemplate using the provided baseURI. Will create a RestTemplate implicitly with the required set of Jackson MixIns. For more information, please see prepareRestTemplate(RestTemplate). Please be aware that the created RestTemplate will use the JDK's default timeout values. Consider passing in a custom RestTemplate or, depending on your JDK implementation, set System properties such as:

• sun.net.client.defaultConnectTimeout
• sun.net.client.defaultReadTimeout

For more information see this link

Parameters:

baseURI - Must not be null

DataFlowTemplate

public DataFlowTemplate(URI baseURI,
                        RestTemplate restTemplate)

Setup a DataFlowTemplate using the provide RestTemplate. Any missing Mixins for Jackson will be added implicitly. For more information, please see prepareRestTemplate(RestTemplate).

Parameters:

baseURI - Must not be null

restTemplate - Must not be null

Method Detail

getLink

public org.springframework.hateoas.Link getLink(org.springframework.hateoas.ResourceSupport resourceSupport,
                                                String rel)

streamOperations

public StreamOperations streamOperations()

Description copied from interface: DataFlowOperations

Stream related operations.

Specified by:

streamOperations in interface DataFlowOperations

counterOperations

public CounterOperations counterOperations()

Description copied from interface: DataFlowOperations

Counter related operations.

Specified by:

counterOperations in interface DataFlowOperations

fieldValueCounterOperations

public FieldValueCounterOperations fieldValueCounterOperations()

Description copied from interface: DataFlowOperations

Field Value Counter related operations.

Specified by:

fieldValueCounterOperations in interface DataFlowOperations

aggregateCounterOperations

public AggregateCounterOperations aggregateCounterOperations()

Description copied from interface: DataFlowOperations

Aggregate Counter related operations.

Specified by:

aggregateCounterOperations in interface DataFlowOperations

taskOperations

public TaskOperations taskOperations()

Description copied from interface: DataFlowOperations

Task related operations.

Specified by:

taskOperations in interface DataFlowOperations

jobOperations

public JobOperations jobOperations()

Description copied from interface: DataFlowOperations

Job related operations.

Specified by:

jobOperations in interface DataFlowOperations

appRegistryOperations

public AppRegistryOperations appRegistryOperations()

Description copied from interface: DataFlowOperations

Application registry related operations.

Specified by:

appRegistryOperations in interface DataFlowOperations

completionOperations

public CompletionOperations completionOperations()

Description copied from interface: DataFlowOperations

DSL Completion related operations.

Specified by:

completionOperations in interface DataFlowOperations

runtimeOperations

public RuntimeOperations runtimeOperations()

Description copied from interface: DataFlowOperations

Runtime related opertations.

Specified by:

runtimeOperations in interface DataFlowOperations

prepareRestTemplate

public static RestTemplate prepareRestTemplate(RestTemplate restTemplate)

Will augment the provided RestTemplate with the Jackson Mixins required by Spring Cloud Data Flow, specifically:

• JobExecutionJacksonMixIn
• JobParametersJacksonMixIn
• JobParameterJacksonMixIn
• JobInstanceJacksonMixIn
• ExitStatusJacksonMixIn
• StepExecutionJacksonMixIn
• ExecutionContextJacksonMixIn
• StepExecutionHistoryJacksonMixIn

Furthermore, this method will also register the Jackson2HalModule

Parameters:

restTemplate - Can be null. Instantiates a new RestTemplate if null

Returns:

RestTemplate with the required Jackson Mixins

getDefaultDataflowRestTemplate

public static RestTemplate getDefaultDataflowRestTemplate()

Invokes prepareRestTemplate(RestTemplate).

Returns:

RestTemplate with the required Jackson MixIns applied

getRestTemplate

public RestTemplate getRestTemplate()

Returns:

The underlying RestTemplate, will never return null