org.camunda.connect.spi
Interface ConnectorInvocation

All Known Implementing Classes:

AbstractRequestInvocation

public interface ConnectorInvocation

Represents a request invocation / request execution.

Author:

Daniel Meyer

See Also:

ConnectorRequestInterceptor.handleInvocation(ConnectorInvocation)

Method Summary

ConnectorRequest<?>	getRequest() The connector request as created through the API.
Object	getTarget() The underlying raw request.
Object	proceed() Makes the request proceed through the interceptor chain.

Method Detail

getTarget

Object getTarget()

The underlying raw request.

Returns:

the raw request as executed by the connector

getRequest

ConnectorRequest<?> getRequest()

The connector request as created through the API. Accessing the request from an interceptor may be useful for setting additional properties on the raw request (returned by getTarget()) that are not supported by the connector.

NOTE: setting parameters on the request (via) ConnectorRequest.setRequestParameter(String, Object) will not have any effects once the request is executed.

Returns:

the connector request

proceed

Object proceed()
               throws Exception

Makes the request proceed through the interceptor chain. ConnectorRequestInterceptor implementations are responsible for calling this method on the invocation.

Returns:

the result of the invocation.

Throws:

Exception