org.camunda.bpm.connect.ConnectorRequest Maven / Gradle / Ivy
/* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.connect;
import java.util.Map;
/**
* A connector request. The request opens an interaction with the connector.
* Because a request represents a single interaction, the request is not threadsafe.
* Request objects should not be shared between multiple threads.
*
* The parameters of a request can be provided using the generic map of input
* parameters. See ({@link #setRequestParameters(Map)}):
*
* SomeConnectorRequest req = connector.createRequest();
* req.setRequestParameter("endpointUrl", "http://mysystem.loc/foo");
* req.setRequestParameter("payload", "some important payload");
* req.execute();
*
* This makes it possible to use the connector in a generic / configurable system like
* the camunda process engine.
*
*
* Optionally, a connector may also extend the request interface and provide
* dedicated (typesafe) methods for configuring a request, preferably in a
* fluent API fashion:
*
* conntector.createRequest()
* .endpointUrl("http://mysystem.loc/foo")
* .payload("some important payload")
* .execute();
*
* This makes it easy to use the connector in a standalone way.
*
*
* The request may return a value representing the output of the connector
* invocation. Requests not returning a value should be of type {@link Void}.
*
* @author Daniel Meyer
*
*/
public interface ConnectorRequest {
/**
* Provides the named input parameters of the request.
*
* @param the named input parameters of the request.
*/
void setRequestParameters(Map params);
/**
* Provides a named input parameters to the request.
* @param name the name of the parameter
* @param value the value of the parameter
*/
void setRequestParameter(String name, Object value);
/**
* Returns the map of request parameters
* @return the map of request parameters
*/
Map getRequestParameters();
/**
* Returns the value of a request parameter
* @param the name of the request parameter
* @return the value of the request parameter of 'null' if the parameter is not set.
*/
V getRequestParameter(String name);
/**
* Execute the request. Once a request is configured with all input
* parameters, it can be executed.
*
* @return the return value of the request.
*/
T execute();
}