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

Class RestValueProvider

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.datasense.valueprovider.RestValueProvider

All Implemented Interfaces:

org.mule.runtime.extension.api.values.ValueProvider

public abstract class RestValueProvider
extends Object
implements org.mule.runtime.extension.api.values.ValueProvider

An implementation of a ValueProvider that consumes a remote endpoint and extracts the values and its names using the provided expressions.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected RestConnection	connection
protected String	itemNameExpression
protected String	itemsExpression
protected String	itemValueExpression

Constructor Summary

Constructors

Constructor and Description
RestValueProvider(String itemsExpression, String itemValueExpression, String itemNameExpression)

Method Summary

Modifier and Type	Method and Description
protected org.mule.runtime.api.metadata.MediaType	getDefaultResponseMediaType()
protected abstract RequestParameterBinding	getParameterBinding() Returns the parameter binding configuration of this RestPollingSource.
protected abstract org.mule.runtime.api.util.MultiMap<String,org.mule.runtime.api.metadata.TypedValue<?>>	getParameterValues() Returns a MultiMap containing all the parameters this source exposes to the user.
protected abstract String	getPathTemplate() Returns the request path for this RestPollingSource with placeholders for its uri parameters.
protected abstract RestRequestBuilder	getRequestBuilder(String path) Return a RequestBuilder configured to do the request to the endpoint this source must poll.
Set<org.mule.runtime.api.value.Value>	resolve()

Methods inherited from class java.lang.Object

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

Field Detail

connection

@Connection
protected RestConnection connection

itemsExpression

protected final String itemsExpression

itemValueExpression

protected final String itemValueExpression

itemNameExpression

protected final String itemNameExpression

Constructor Detail

RestValueProvider

public RestValueProvider(String itemsExpression,
                         String itemValueExpression,
                         String itemNameExpression)

Method Detail

getParameterBinding

protected abstract RequestParameterBinding getParameterBinding()

Returns the parameter binding configuration of this RestPollingSource.

getPathTemplate

protected abstract String getPathTemplate()

Returns the request path for this RestPollingSource with placeholders for its uri parameters. i.e: /user/{username}/events

getRequestBuilder

protected abstract RestRequestBuilder getRequestBuilder(String path)

Return a RequestBuilder configured to do the request to the endpoint this source must poll. BaseUri, Path and Method must be configured.

Parameters:

path - The request path with the placeholders replaced with its corresponding values.

getParameterValues

protected abstract org.mule.runtime.api.util.MultiMap<String,org.mule.runtime.api.metadata.TypedValue<?>> getParameterValues()

Returns a MultiMap containing all the parameters this source exposes to the user. Each entry must contain the parameter name as key and its value represented as a TypedValue.

resolve

public Set<org.mule.runtime.api.value.Value> resolve()
                                              throws org.mule.runtime.extension.api.values.ValueResolvingException

Specified by:

resolve in interface org.mule.runtime.extension.api.values.ValueProvider

Throws:

org.mule.runtime.extension.api.values.ValueResolvingException

getDefaultResponseMediaType

protected org.mule.runtime.api.metadata.MediaType getDefaultResponseMediaType()