com.mulesoft.connectivity.rest.commons.api.datasense.sampledata

Class RestSampleDataProvider

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.datasense.sampledata.RestSampleDataProvider

All Implemented Interfaces:

org.mule.sdk.api.data.sample.SampleDataProvider<InputStream,HttpResponseAttributes>

public abstract class RestSampleDataProvider
extends Object

A base implementation of sample data for operations and triggers.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected RestConfiguration	config
protected RestConnection	connection
protected org.mule.runtime.api.el.ExpressionLanguage	expressionLanguage

Constructor Summary

Constructors

Constructor and Description
RestSampleDataProvider()

Method Summary

Modifier and Type	Method and Description
protected abstract void	build(SampleDataResolverExpressionBuilder builder) Allows building the sample data expression that will be executed by this value provider.
protected EvaluationContext	buildEvaluationContext(EvaluationContextBuilderFactory evaluationContextBuilderFactory) Allows child classes to configure the evaluation context.
protected Optional<EvaluationContext>	getGlobalEvaluationContext() Allows child classes to provide a global evaluation context.
String	getId()
org.mule.sdk.api.runtime.operation.Result<T,U>	getSample()
protected org.mule.sdk.api.runtime.operation.Result<InputStream,HttpResponseAttributes>	transformOutputTypedValueResult(org.mule.sdk.api.runtime.operation.Result<org.mule.runtime.api.metadata.TypedValue<InputStream>,HttpResponseAttributes> output) Transforms the output wrapped with a TypedValue of the sample data sequence expression to a result for the corresponding sample data type.

Methods inherited from class java.lang.Object

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

Field Detail

config

@Config
protected RestConfiguration config

connection

@Connection
protected RestConnection connection

expressionLanguage

@Inject
protected org.mule.runtime.api.el.ExpressionLanguage expressionLanguage

Constructor Detail

RestSampleDataProvider

public RestSampleDataProvider()

Method Detail

transformOutputTypedValueResult

protected org.mule.sdk.api.runtime.operation.Result<InputStream,HttpResponseAttributes> transformOutputTypedValueResult(org.mule.sdk.api.runtime.operation.Result<org.mule.runtime.api.metadata.TypedValue<InputStream>,HttpResponseAttributes> output)

Transforms the output wrapped with a TypedValue of the sample data sequence expression to a result for the corresponding sample data type.

Parameters:

output - The Result sequence data expression with output wrapped with a TypedValue.

Returns:

A result processed for sample data response.

getId

public String getId()

Specified by:

getId in interface org.mule.sdk.api.data.sample.SampleDataProvider<T,U>

build

protected abstract void build(SampleDataResolverExpressionBuilder builder)

Allows building the sample data expression that will be executed by this value provider.

Parameters:

builder - An empty builder where the value provider that is going to be executed must be built.

getGlobalEvaluationContext

protected Optional<EvaluationContext> getGlobalEvaluationContext()

Allows child classes to provide a global evaluation context. This is useful when a value provider is a global definition that need to be reused by reference, in that case the returned EvaluationContext would contain the declaration of that definition.

Returns:

The global evaluation context for this value provider.

buildEvaluationContext

protected EvaluationContext buildEvaluationContext(EvaluationContextBuilderFactory evaluationContextBuilderFactory)

Allows child classes to configure the evaluation context. This is useful for defining operation specific parameters in that evaluation context, i.e. parameters defined in the operation that the value provider needs to use.

Parameters:

evaluationContextBuilderFactory - The operation evaluation context builder.

getSample

public org.mule.sdk.api.runtime.operation.Result<T,U> getSample()
                                                         throws org.mule.sdk.api.data.sample.SampleDataException

Specified by:

getSample in interface org.mule.sdk.api.data.sample.SampleDataProvider<T,U>

Throws:

org.mule.sdk.api.data.sample.SampleDataException