Package com.flowable.serviceregistry.engine.impl.invoker.rest

Class RestServiceInvoker

java.lang.Object

com.flowable.serviceregistry.engine.impl.invoker.rest.RestServiceInvoker

All Implemented Interfaces:

ServiceInvoker

public class RestServiceInvoker
extends Object
implements ServiceInvoker

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected ServiceRegistryEngineConfiguration	serviceRegistryEngineConfiguration

Constructor Summary

Constructors

Constructor	Description
RestServiceInvoker(ServiceRegistryEngineConfiguration serviceRegistryEngineConfiguration, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
protected void	addHeader(MultiValueMap<String,String> headers, String header)
protected com.fasterxml.jackson.databind.JsonNode	applyOutputPathIfApplicable(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, com.fasterxml.jackson.databind.JsonNode resultJsonNode)
protected boolean	asBoolean(Object object)
protected int	asInt(Object object)
protected long	asLong(Object object)
protected void	configureRequest(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, org.flowable.http.common.api.HttpRequest request, ServiceInvocationVariablesContainer variablesContainer)
protected org.flowable.http.common.api.client.FlowableHttpClient	createFlowableHttpClient(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, ServiceInvocationVariablesContainer variablesContainer, ServiceInvocationContext context, org.flowable.http.common.api.HttpRequest request, ServiceRegistryEngineConfiguration engineConfiguration)
protected <T extends org.flowable.http.common.api.delegate.HttpResponseHandler & org.flowable.http.common.api.delegate.HttpRequestHandler> T	createHttpRequestOrResponseHandler(com.fasterxml.jackson.databind.JsonNode handlerNode, ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation)
protected org.flowable.http.common.api.delegate.HttpRequestHandler	createRequestHandler(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation)
protected org.flowable.http.common.api.delegate.HttpResponseHandler	createResponseHandler(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation)
protected String	decode(String string)
protected static com.fasterxml.jackson.databind.JsonNode	dictionaryValueTypeToJsonNode(com.fasterxml.jackson.databind.node.JsonNodeFactory factory, Object value)
protected String	encodeBasicAuth(String username, String password, ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation)
protected String	ensureUrlIsEncoded(String url, ServiceInvocationVariablesContainer variablesContainer)
protected URI	ensureUrlIsEncodedAndConvertToUri(URL url)
org.flowable.http.common.api.HttpResponse	execute(org.flowable.http.common.api.HttpRequest request, ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, ServiceInvocationContext context, ServiceInvocationVariablesContainer serviceDataVariablesContainer)
protected RestServiceAuthorization	getAuthorization(com.fasterxml.jackson.databind.JsonNode config)
protected RestServiceAuthorization	getAuthorization(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation)
protected String	getBody(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, org.flowable.common.engine.impl.el.ExpressionManager expressionManager, ServiceInvocationVariablesContainer serviceInvocationVariablesContainer)
protected MultiValueMap<String,String>	getHeaders(com.fasterxml.jackson.databind.JsonNode config, String serviceDefinitionKey, String serviceOperationKey)
protected MultiValueMap<String,String>	getHeadersFromGlobalProperties(String globalPropKey)
protected long	getTotalCountIfApplicable(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, com.fasterxml.jackson.databind.JsonNode resultJsonNode)
protected String	getUrl(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation)
protected String	handleInputQueryParameters(String url, org.flowable.common.engine.api.variable.VariableContainer variableContainer, ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation)
ServiceInvocationResultResponse	invoke(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, ServiceInvocationContext context)
protected boolean	isJsonContentType(String value)
protected boolean	isJsonContentType(org.flowable.http.common.api.HttpResponse httpResponse)
protected boolean	lookupBooleanProperty(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, String field, boolean defaultValue)
protected MultiValueMap<String,String>	lookupHeaders(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation)
protected int	lookupIntegerProperty(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, String field, int defaultValue)
protected long	lookupLongProperty(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, String field, int defaultValue)
protected String	lookupStringProperty(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, String field, String defaultValue)
org.flowable.http.common.api.HttpResponse	perform(org.flowable.http.common.api.client.FlowableHttpClient client, ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation, ServiceInvocationContext context, org.flowable.http.common.api.HttpRequest httpRequest, ServiceInvocationVariablesContainer variablesContainer)
protected void	processInputParameter(ServiceInvocationVariablesContainer serviceInvocationVariablesContainer, org.flowable.common.engine.impl.el.ExpressionManager expressionManager, com.fasterxml.jackson.databind.node.ObjectNode bodyJson, ServiceInputParameter inputParameter)
protected String	resolveCredentials(RestServiceAuthorization.Credentials credentials, org.flowable.common.engine.impl.el.ExpressionManager expressionManager, ServiceInvocationVariablesContainer variablesContainer, org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
protected String	resolveExpressionAsString(String value, org.flowable.common.engine.impl.el.ExpressionManager expressionManager, ServiceInvocationVariablesContainer variablesContainer)
protected MultiValueMap<String,String>	resolveHeaderExpressions(MultiValueMap<String,String> headers, org.flowable.common.engine.impl.el.ExpressionManager expressionManager, ServiceInvocationVariablesContainer variablesContainer)
protected String	resolveOAuth2ClientToken(String oauth2RegistrationKey, org.flowable.common.engine.api.variable.VariableContainer variableContainer, org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
protected String	resolveSecret(String secretName, ServiceInvocationVariablesContainer variablesContainer, org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
protected boolean	shouldIgnoreErrors(ServiceDefinitionModel serviceDefinitionModel, ServiceOperation serviceOperation)
protected void	validate(org.flowable.http.common.api.HttpRequest request, ServiceInvocationVariablesContainer variablesContainer)

Methods inherited from class java.lang.Object

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

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

serviceRegistryEngineConfiguration

protected ServiceRegistryEngineConfiguration serviceRegistryEngineConfiguration

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

RestServiceInvoker

public RestServiceInvoker(ServiceRegistryEngineConfiguration serviceRegistryEngineConfiguration,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Details

invoke

public ServiceInvocationResultResponse invoke(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 ServiceInvocationContext context)

Specified by:

invoke in interface ServiceInvoker

createRequestHandler

protected org.flowable.http.common.api.delegate.HttpRequestHandler createRequestHandler(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation)

createResponseHandler

protected org.flowable.http.common.api.delegate.HttpResponseHandler createResponseHandler(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation)

createHttpRequestOrResponseHandler

protected <T extends org.flowable.http.common.api.delegate.HttpResponseHandler & org.flowable.http.common.api.delegate.HttpRequestHandler>
T createHttpRequestOrResponseHandler(com.fasterxml.jackson.databind.JsonNode handlerNode,
 ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation)

configureRequest

protected void configureRequest(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 org.flowable.http.common.api.HttpRequest request,
 ServiceInvocationVariablesContainer variablesContainer)

getUrl

protected String getUrl(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation)

handleInputQueryParameters

protected String handleInputQueryParameters(String url,
 org.flowable.common.engine.api.variable.VariableContainer variableContainer,
 ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation)

getBody

protected String getBody(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 org.flowable.common.engine.impl.el.ExpressionManager expressionManager,
 ServiceInvocationVariablesContainer serviceInvocationVariablesContainer)

processInputParameter

protected void processInputParameter(ServiceInvocationVariablesContainer serviceInvocationVariablesContainer,
 org.flowable.common.engine.impl.el.ExpressionManager expressionManager,
 com.fasterxml.jackson.databind.node.ObjectNode bodyJson,
 ServiceInputParameter inputParameter)

dictionaryValueTypeToJsonNode

protected static com.fasterxml.jackson.databind.JsonNode dictionaryValueTypeToJsonNode(com.fasterxml.jackson.databind.node.JsonNodeFactory factory,
 Object value)

lookupStringProperty

protected String lookupStringProperty(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 String field,
 String defaultValue)

getAuthorization

protected RestServiceAuthorization getAuthorization(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation)

getAuthorization

protected RestServiceAuthorization getAuthorization(com.fasterxml.jackson.databind.JsonNode config)

lookupHeaders

protected MultiValueMap<String,String> lookupHeaders(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation)

getHeadersFromGlobalProperties

protected MultiValueMap<String,String> getHeadersFromGlobalProperties(String globalPropKey)

getHeaders

protected MultiValueMap<String,String> getHeaders(com.fasterxml.jackson.databind.JsonNode config,
 String serviceDefinitionKey,
 String serviceOperationKey)

addHeader

protected void addHeader(MultiValueMap<String,String> headers,
 String header)

resolveHeaderExpressions

protected MultiValueMap<String,String> resolveHeaderExpressions(MultiValueMap<String,String> headers,
 org.flowable.common.engine.impl.el.ExpressionManager expressionManager,
 ServiceInvocationVariablesContainer variablesContainer)

resolveCredentials

protected String resolveCredentials(RestServiceAuthorization.Credentials credentials,
 org.flowable.common.engine.impl.el.ExpressionManager expressionManager,
 ServiceInvocationVariablesContainer variablesContainer,
 org.flowable.common.engine.impl.interceptor.CommandContext commandContext)

resolveSecret

protected String resolveSecret(String secretName,
 ServiceInvocationVariablesContainer variablesContainer,
 org.flowable.common.engine.impl.interceptor.CommandContext commandContext)

resolveOAuth2ClientToken

protected String resolveOAuth2ClientToken(String oauth2RegistrationKey,
 org.flowable.common.engine.api.variable.VariableContainer variableContainer,
 org.flowable.common.engine.impl.interceptor.CommandContext commandContext)

resolveExpressionAsString

protected String resolveExpressionAsString(String value,
 org.flowable.common.engine.impl.el.ExpressionManager expressionManager,
 ServiceInvocationVariablesContainer variablesContainer)

lookupIntegerProperty

protected int lookupIntegerProperty(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 String field,
 int defaultValue)

lookupLongProperty

protected long lookupLongProperty(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 String field,
 int defaultValue)

asInt

protected int asInt(Object object)

asLong

protected long asLong(Object object)

lookupBooleanProperty

protected boolean lookupBooleanProperty(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 String field,
 boolean defaultValue)

asBoolean

protected boolean asBoolean(Object object)

applyOutputPathIfApplicable

protected com.fasterxml.jackson.databind.JsonNode applyOutputPathIfApplicable(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 com.fasterxml.jackson.databind.JsonNode resultJsonNode)

getTotalCountIfApplicable

protected long getTotalCountIfApplicable(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 com.fasterxml.jackson.databind.JsonNode resultJsonNode)

execute

public org.flowable.http.common.api.HttpResponse execute(org.flowable.http.common.api.HttpRequest request,
 ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 ServiceInvocationContext context,
 ServiceInvocationVariablesContainer serviceDataVariablesContainer)

shouldIgnoreErrors

protected boolean shouldIgnoreErrors(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation)

createFlowableHttpClient

protected org.flowable.http.common.api.client.FlowableHttpClient createFlowableHttpClient(ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 ServiceInvocationVariablesContainer variablesContainer,
 ServiceInvocationContext context,
 org.flowable.http.common.api.HttpRequest request,
 ServiceRegistryEngineConfiguration engineConfiguration)

validate

protected void validate(org.flowable.http.common.api.HttpRequest request,
 ServiceInvocationVariablesContainer variablesContainer)

perform

public org.flowable.http.common.api.HttpResponse perform(org.flowable.http.common.api.client.FlowableHttpClient client,
 ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation,
 ServiceInvocationContext context,
 org.flowable.http.common.api.HttpRequest httpRequest,
 ServiceInvocationVariablesContainer variablesContainer)

isJsonContentType

protected boolean isJsonContentType(org.flowable.http.common.api.HttpResponse httpResponse)

isJsonContentType

protected boolean isJsonContentType(String value)

encodeBasicAuth

protected String encodeBasicAuth(String username,
 String password,
 ServiceDefinitionModel serviceDefinitionModel,
 ServiceOperation serviceOperation)

ensureUrlIsEncoded

protected String ensureUrlIsEncoded(String url,
 ServiceInvocationVariablesContainer variablesContainer)

ensureUrlIsEncodedAndConvertToUri

protected URI ensureUrlIsEncodedAndConvertToUri(URL url)
                                         throws URISyntaxException

Throws:

URISyntaxException

decode

protected String decode(String string)