io.apiman.gateway.engine.impl

Class ServiceRequestExecutorImpl

java.lang.Object

io.apiman.gateway.engine.impl.ServiceRequestExecutorImpl

All Implemented Interfaces:

IServiceRequestExecutor

public class ServiceRequestExecutorImpl
extends Object
implements IServiceRequestExecutor

Manages a single request-response sequence. It is executed in the following order: - Invoke and evaluate request chain. - Invoke back-end connector IServiceConnector. - Invoke handler set on streamHandler(IAsyncHandler) chunks stream through request chain, into connector). - Invoke and evaluate response chain. - Return results via resultHandler. In the case of failure, the resultHandler is called at the earliest opportunity.

Author:

Marc Savy

Constructor Summary

Constructors

Constructor and Description
ServiceRequestExecutorImpl(io.apiman.gateway.engine.beans.ServiceRequest serviceRequest, IAsyncResultHandler<IEngineResult> resultHandler, IRegistry registry, IPolicyContext context, IPolicyFactory policyFactory, IConnectorFactory connectorFactory, IMetrics metrics) Constructs a new ServiceRequestExecutorImpl.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the policy chain and request.
protected void	handleStream() Called when the service connector is ready to receive data from the inbound client request.
boolean	isFinished() Policy request-response sequence has completed.
protected void	recordErrorMetrics(Throwable error)
protected void	recordFailureMetrics(io.apiman.gateway.engine.beans.PolicyFailure failure)
protected void	recordSuccessMetrics(io.apiman.gateway.engine.beans.ServiceResponse response)
void	streamHandler(IAsyncHandler<ISignalWriteStream> handler) Indicates when the back-end connector is ready to handle streamed data.
protected void	validateRequest(io.apiman.gateway.engine.beans.ServiceRequest request) Validates that the contract being used for the request is valid against the service information included in the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceRequestExecutorImpl

public ServiceRequestExecutorImpl(io.apiman.gateway.engine.beans.ServiceRequest serviceRequest,
                          IAsyncResultHandler<IEngineResult> resultHandler,
                          IRegistry registry,
                          IPolicyContext context,
                          IPolicyFactory policyFactory,
                          IConnectorFactory connectorFactory,
                          IMetrics metrics)

Constructs a new ServiceRequestExecutorImpl.

Parameters:

serviceRequest - the service request

resultHandler - the result handler

registry - the registry

context - the context

policyFactory - the policy factory

connectorFactory - the connector factory

metrics - the metrics instance

Method Detail

recordSuccessMetrics

protected void recordSuccessMetrics(io.apiman.gateway.engine.beans.ServiceResponse response)

Parameters:

response -

recordFailureMetrics

protected void recordFailureMetrics(io.apiman.gateway.engine.beans.PolicyFailure failure)

Parameters:

failure -

recordErrorMetrics

protected void recordErrorMetrics(Throwable error)

Parameters:

error -

execute

public void execute()

Description copied from interface: IServiceRequestExecutor

Execute the policy chain and request.

Specified by:

execute in interface IServiceRequestExecutor

See Also:

IServiceRequestExecutor.execute()

validateRequest

protected void validateRequest(io.apiman.gateway.engine.beans.ServiceRequest request)
                        throws io.apiman.gateway.engine.beans.exceptions.InvalidContractException

Validates that the contract being used for the request is valid against the service information included in the request. Basically the request includes information indicating which specific service is being invoked. This method ensures that the service information in the contract matches the requested service.

Parameters:

request -

Throws:

io.apiman.gateway.engine.beans.exceptions.InvalidContractException

handleStream

protected void handleStream()

Called when the service connector is ready to receive data from the inbound client request.

isFinished

public boolean isFinished()

Description copied from interface: IServiceRequestExecutor

Policy request-response sequence has completed.

Specified by:

isFinished in interface IServiceRequestExecutor

Returns:

true if finished, else false.

See Also:

IServiceRequestExecutor.isFinished()

streamHandler

public void streamHandler(IAsyncHandler<ISignalWriteStream> handler)

Description copied from interface: IServiceRequestExecutor

Indicates when the back-end connector is ready to handle streamed data.

Specified by:

streamHandler in interface IServiceRequestExecutor

See Also:

IServiceRequestExecutor.streamHandler(io.apiman.gateway.engine.async.IAsyncHandler)