eu.clarussecure.proxy.protocol.plugins.pgsql.raw.handler.codec

Class PgsqlRawPartAccumulator

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<I>

eu.clarussecure.proxy.protocol.plugins.pgsql.raw.handler.codec.MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

eu.clarussecure.proxy.protocol.plugins.pgsql.raw.handler.codec.PgsqlRawPartAccumulator

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

public class PgsqlRawPartAccumulator
extends MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
PgsqlRawPartAccumulator(int... types)

Method Summary

Modifier and Type	Method and Description
boolean	acceptInboundMessage(Object msg)
protected void	aggregate(MutablePgsqlRawMessage msg, PgsqlRawContent part) Transfers the information provided by the specified content message to the specified aggregated message.
protected MutablePgsqlRawMessage	beginAggregation(PgsqlRawHeader start, io.netty.buffer.ByteBuf bytes) Creates a new aggregated message from the specified start message and the specified content.
protected boolean	closeAfterContinueResponse(Object msg) Determine if the channel should be closed after the result of #newContinueResponse(Object) is written.
protected void	finishAggregation(MutablePgsqlRawMessage msg) Invoked when the specified aggregated message is about to be passed to the next handler in the pipeline.
protected boolean	ignoreContentAfterContinueResponse(Object msg) Determine if all objects for the current request/response should be ignored or not.
protected boolean	isAggregated(PgsqlRawPart msg) Returns true if and only if the specified message is already aggregated.
protected boolean	isContentLengthInvalid(PgsqlRawHeader start, int maxContentLength) Determine if the message start's content length is known, and if it greater than maxContentLength.
protected boolean	isContentMessage(PgsqlRawPart msg) Returns true if and only if the specified message is a content message.
protected boolean	isLastContentMessage(PgsqlRawContent msg) Returns true if and only if the specified message is the last content message.
protected boolean	isStartMessage(PgsqlRawPart msg) Returns true if and only if the specified message is a start message.
protected Object	newContinueResponse(PgsqlRawHeader start, int maxContentLength, io.netty.channel.ChannelPipeline pipeline) Returns the 'continue response' for the specified start message if necessary.

Methods inherited from class eu.clarussecure.proxy.protocol.plugins.pgsql.raw.handler.codec.MessageAccumulator

channelInactive, ctx, decode, handleOversizedMessage, handlerAdded, handlerRemoved, isHandlingOversizedMessage, maxContentLength, maxCumulationBufferComponents, setMaxCumulationBufferComponents

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder

channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

isSharable

Methods inherited from class java.lang.Object

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

Constructor Detail

PgsqlRawPartAccumulator

public PgsqlRawPartAccumulator(int... types)

Method Detail

acceptInboundMessage

public boolean acceptInboundMessage(Object msg)
                             throws Exception

Overrides:

acceptInboundMessage in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Throws:

Exception

isStartMessage

protected boolean isStartMessage(PgsqlRawPart msg)
                          throws Exception

Description copied from class: MessageAccumulator

Returns true if and only if the specified message is a start message. Typically, this method is implemented as a single return statement with instanceof:

 return msg instanceof MyStartMessage;
 

Specified by:

isStartMessage in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Throws:

Exception

isContentMessage

protected boolean isContentMessage(PgsqlRawPart msg)
                            throws Exception

Description copied from class: MessageAccumulator

Returns true if and only if the specified message is a content message. Typically, this method is implemented as a single return statement with instanceof:

 return msg instanceof MyContentMessage;
 

Specified by:

isContentMessage in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Throws:

Exception

isLastContentMessage

protected boolean isLastContentMessage(PgsqlRawContent msg)
                                throws Exception

Description copied from class: MessageAccumulator

Returns true if and only if the specified message is the last content message. Typically, this method is implemented as a single return statement with instanceof:

 return msg instanceof MyLastContentMessage;
 

or with instanceof and boolean field check:

 return msg instanceof MyContentMessage && msg.isLastFragment();
 

Specified by:

isLastContentMessage in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Throws:

Exception

isAggregated

protected boolean isAggregated(PgsqlRawPart msg)
                        throws Exception

Description copied from class: MessageAccumulator

Returns true if and only if the specified message is already aggregated. If this method returns true, this handler will simply forward the message to the next handler as-is.

Specified by:

isAggregated in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Throws:

Exception

isContentLengthInvalid

protected boolean isContentLengthInvalid(PgsqlRawHeader start,
                                         int maxContentLength)
                                  throws Exception

Description copied from class: MessageAccumulator

Determine if the message start's content length is known, and if it greater than maxContentLength.

Specified by:

isContentLengthInvalid in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Parameters:

start - The message which may indicate the content length.

maxContentLength - The maximum allowed content length.

Returns:

true if the message start's content length is known, and if it greater than maxContentLength. false otherwise.

Throws:

Exception

newContinueResponse

protected Object newContinueResponse(PgsqlRawHeader start,
                                     int maxContentLength,
                                     io.netty.channel.ChannelPipeline pipeline)
                              throws Exception

Description copied from class: MessageAccumulator

Returns the 'continue response' for the specified start message if necessary. For example, this method is useful to handle an HTTP 100-continue header.

Specified by:

newContinueResponse in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Returns:

the 'continue response', or null if there's no message to send

Throws:

Exception

closeAfterContinueResponse

protected boolean closeAfterContinueResponse(Object msg)
                                      throws Exception

Description copied from class: MessageAccumulator

Determine if the channel should be closed after the result of #newContinueResponse(Object) is written.

Specified by:

closeAfterContinueResponse in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Parameters:

msg - The return value from #newContinueResponse(Object).

Returns:

true if the channel should be closed after the result of #newContinueResponse(Object) is written. false otherwise.

Throws:

Exception

ignoreContentAfterContinueResponse

protected boolean ignoreContentAfterContinueResponse(Object msg)
                                              throws Exception

Description copied from class: MessageAccumulator

Determine if all objects for the current request/response should be ignored or not. Messages will stop being ignored the next time MessageAccumulator.isContentMessage(Object) returns true.

Specified by:

ignoreContentAfterContinueResponse in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Parameters:

msg - The return value from #newContinueResponse(Object).

Returns:

true if all objects for the current request/response should be ignored or not. false otherwise.

Throws:

Exception

beginAggregation

protected MutablePgsqlRawMessage beginAggregation(PgsqlRawHeader start,
                                                  io.netty.buffer.ByteBuf bytes)
                                           throws Exception

Description copied from class: MessageAccumulator

Creates a new aggregated message from the specified start message and the specified content. If the start message implements ByteBufHolder, its content is appended to the specified content. This aggregator will continue to append the received content to the specified content.

Specified by:

beginAggregation in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Throws:

Exception

aggregate

protected void aggregate(MutablePgsqlRawMessage msg,
                         PgsqlRawContent part)
                  throws Exception

Description copied from class: MessageAccumulator

Transfers the information provided by the specified content message to the specified aggregated message. Note that the content of the specified content message has been appended to the content of the specified aggregated message already, so that you don't need to. Use this method to transfer the additional information that the content message provides to aggregated.

Overrides:

aggregate in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Throws:

Exception

finishAggregation

protected void finishAggregation(MutablePgsqlRawMessage msg)
                          throws Exception

Description copied from class: MessageAccumulator

Invoked when the specified aggregated message is about to be passed to the next handler in the pipeline.

Overrides:

finishAggregation in class MessageAccumulator<PgsqlRawPart,PgsqlRawHeader,PgsqlRawContent,MutablePgsqlRawMessage>

Throws:

Exception