io.apiman.gateway.engine.io

Class AbstractStream<H>

java.lang.Object

io.apiman.gateway.engine.io.AbstractStream<H>

Type Parameters:

H - Type of head

All Implemented Interfaces:

IReadStream<H>, IReadWriteStream<H>, IStream, IWriteStream

Direct Known Subclasses:

AbstractSignalStream, Chain, EngineResultImpl

public abstract class AbstractStream<H>
extends Object
implements IReadWriteStream<H>

Generic representation of a three part stream: head, body and end, with handlers and operators for each. For example: The head might represent a ServiceRequest; the body is a stream of IApimanBuffer chunks; end() is used indicate that transmission of the body has completed. The head handler is also used to indicate the result of the operation.

Author:

Marc Savy

Field Summary

Fields

Modifier and Type	Field and Description
protected IAsyncHandler<IApimanBuffer>	bodyHandler
protected IAsyncHandler<Void>	endHandler
protected boolean	finished
protected IAsyncHandler<H>	headHandler

Constructor Summary

Constructors

Constructor and Description
AbstractStream()

Method Summary

Methods

Modifier and Type	Method and Description
void	bodyHandler(IAsyncHandler<IApimanBuffer> bodyHandler) Handler called when a body chunk has arrived.
void	end() Signal transmission has ended.
void	endHandler(IAsyncHandler<Void> endHandler) Handler signals when transmission has completed; no further calls to IReadStream.bodyHandler(IAsyncHandler) should occur after this has been invoked.
protected void	handleBody(IApimanBuffer chunk) Called to handle a body chunk.
protected void	handleEnd() Signals the end of the stream.
protected abstract void	handleHead(H head) Called to handle the head.
void	headHandler(IAsyncHandler<H> headHandler) Sets the head handler.
boolean	isFinished() Indicates whether the stream has finished.
void	write(IApimanBuffer chunk) Write a chunk to the stream.

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

getHead

Field Detail

headHandler

protected IAsyncHandler<H> headHandler

bodyHandler

protected IAsyncHandler<IApimanBuffer> bodyHandler

endHandler

protected IAsyncHandler<Void> endHandler

finished

protected boolean finished

Constructor Detail

AbstractStream

public AbstractStream()

Method Detail

headHandler

public void headHandler(IAsyncHandler<H> headHandler)

Sets the head handler.

Parameters:

headHandler - head handler

bodyHandler

public void bodyHandler(IAsyncHandler<IApimanBuffer> bodyHandler)

Description copied from interface: IReadStream

Handler called when a body chunk has arrived.

Specified by:

bodyHandler in interface IReadStream<H>

Parameters:

bodyHandler - the handler

See Also:

IReadStream.bodyHandler(io.apiman.gateway.engine.async.IAsyncHandler)

endHandler

public void endHandler(IAsyncHandler<Void> endHandler)

Description copied from interface: IReadStream

Handler signals when transmission has completed; no further calls to IReadStream.bodyHandler(IAsyncHandler) should occur after this has been invoked.

Specified by:

endHandler in interface IReadStream<H>

Parameters:

endHandler - the handler

See Also:

IReadStream.endHandler(io.apiman.gateway.engine.async.IAsyncHandler)

write

public void write(IApimanBuffer chunk)

Description copied from interface: IWriteStream

Write a chunk to the stream. No writes should be made after IWriteStream.end() has been signalled.

Specified by:

write in interface IWriteStream

See Also:

IWriteStream.write(io.apiman.gateway.engine.io.IApimanBuffer)

end

public void end()

Description copied from interface: IWriteStream

Signal transmission has ended. This should only be called once, after which no further calls to IWriteStream.write(IApimanBuffer) should be made.

Specified by:

end in interface IWriteStream

See Also:

IWriteStream.end()

isFinished

public boolean isFinished()

Description copied from interface: IStream

Indicates whether the stream has finished.

Specified by:

isFinished in interface IStream

Returns:

true when finished; else false.

See Also:

IStream.isFinished()

handleHead

protected abstract void handleHead(H head)

Called to handle the head.

Parameters:

head -

handleBody

protected void handleBody(IApimanBuffer chunk)

Called to handle a body chunk.

Parameters:

chunk -

handleEnd

protected void handleEnd()

Signals the end of the stream.