io.apiman.gateway.engine.impl

Class EngineResultImpl

java.lang.Object

io.apiman.gateway.engine.io.AbstractStream<io.apiman.gateway.engine.beans.ServiceResponse>

io.apiman.gateway.engine.impl.EngineResultImpl

All Implemented Interfaces:

IEngineResult, IAbortable, IReadStream<io.apiman.gateway.engine.beans.ServiceResponse>, IReadWriteStream<io.apiman.gateway.engine.beans.ServiceResponse>, IStream, IWriteStream

public class EngineResultImpl
extends AbstractStream<io.apiman.gateway.engine.beans.ServiceResponse>
implements IEngineResult

The result of a call through the policy engine. Encapsulates either a response or a failure.

Author:

eric.wittmann@redhat.com

Field Summary

Fields inherited from class io.apiman.gateway.engine.io.AbstractStream

bodyHandler, endHandler, finished, headHandler

Constructor Summary

Constructors

Constructor and Description
EngineResultImpl() Constructor.
EngineResultImpl(io.apiman.gateway.engine.beans.PolicyFailure policyFailure) Construct an unsuccessful EngineResult.
EngineResultImpl(io.apiman.gateway.engine.beans.ServiceResponse serviceResponse) Construct a successful EngineResult.

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Signal abort.
io.apiman.gateway.engine.beans.ServiceResponse	getHead() Return the head object's handler (e.g.
io.apiman.gateway.engine.beans.PolicyFailure	getPolicyFailure()
io.apiman.gateway.engine.beans.ServiceResponse	getServiceResponse()
protected void	handleHead(io.apiman.gateway.engine.beans.ServiceResponse head) Called to handle the head.
boolean	isFailure() Whether a failure occurred during engine execution.
boolean	isResponse() Whether a response has been set.
void	setConnectorResponseStream(ISignalReadStream<io.apiman.gateway.engine.beans.ServiceResponse> connectorResponseStream)
void	setPolicyFailure(io.apiman.gateway.engine.beans.PolicyFailure policyFailure)
void	setServiceResponse(io.apiman.gateway.engine.beans.ServiceResponse serviceResponse)

Methods inherited from class io.apiman.gateway.engine.io.AbstractStream

bodyHandler, end, endHandler, handleBody, handleEnd, headHandler, isFinished, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.apiman.gateway.engine.io.IReadStream

bodyHandler, endHandler

Methods inherited from interface io.apiman.gateway.engine.io.IStream

isFinished

Constructor Detail

EngineResultImpl

public EngineResultImpl()

Constructor.

EngineResultImpl

public EngineResultImpl(io.apiman.gateway.engine.beans.ServiceResponse serviceResponse)

Construct a successful EngineResult.

Parameters:

serviceResponse - the service response

EngineResultImpl

public EngineResultImpl(io.apiman.gateway.engine.beans.PolicyFailure policyFailure)

Construct an unsuccessful EngineResult.

Parameters:

policyFailure -

Method Detail

isResponse

public boolean isResponse()

Description copied from interface: IEngineResult

Whether a response has been set.

Specified by:

isResponse in interface IEngineResult

Returns:

true if response set, false if unset.

See Also:

IEngineResult.isResponse()

isFailure

public boolean isFailure()

Description copied from interface: IEngineResult

Whether a failure occurred during engine execution.

Specified by:

isFailure in interface IEngineResult

Returns:

true if failure set, false if unset.

See Also:

IEngineResult.isFailure()

getServiceResponse

public io.apiman.gateway.engine.beans.ServiceResponse getServiceResponse()

Specified by:

getServiceResponse in interface IEngineResult

Returns:

the serviceResponse

See Also:

IEngineResult.getServiceResponse()

setServiceResponse

public void setServiceResponse(io.apiman.gateway.engine.beans.ServiceResponse serviceResponse)

Parameters:

serviceResponse - the serviceResponse to set

getPolicyFailure

public io.apiman.gateway.engine.beans.PolicyFailure getPolicyFailure()

Specified by:

getPolicyFailure in interface IEngineResult

Returns:

the policyFailure

See Also:

IEngineResult.getPolicyFailure()

setPolicyFailure

public void setPolicyFailure(io.apiman.gateway.engine.beans.PolicyFailure policyFailure)

Parameters:

policyFailure - the policyFailure to set

handleHead

protected void handleHead(io.apiman.gateway.engine.beans.ServiceResponse head)

Description copied from class: AbstractStream

Called to handle the head.

Specified by:

handleHead in class AbstractStream<io.apiman.gateway.engine.beans.ServiceResponse>

getHead

public io.apiman.gateway.engine.beans.ServiceResponse getHead()

Description copied from interface: IReadStream

Return the head object's handler (e.g. ServiceRequest).

Specified by:

getHead in interface IReadStream<io.apiman.gateway.engine.beans.ServiceResponse>

Returns:

the head object

abort

public void abort()

Description copied from interface: IAbortable

Signal abort.

Specified by:

abort in interface IAbortable

See Also:

IAbortable.abort()

setConnectorResponseStream

public void setConnectorResponseStream(ISignalReadStream<io.apiman.gateway.engine.beans.ServiceResponse> connectorResponseStream)

Parameters:

connectorResponseStream - the connectorResponseStream to set