Package com.couchbase.client.core.endpoint.view

Class ViewHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.MessageToMessageCodec<RESPONSE,REQUEST>

com.couchbase.client.core.endpoint.AbstractGenericHandler<HttpObject,HttpRequest,ViewRequest>

com.couchbase.client.core.endpoint.view.ViewHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class ViewHandler
extends AbstractGenericHandler<HttpObject,HttpRequest,ViewRequest>

The ViewHandler is responsible for encoding ViewRequests into lower level HttpRequests as well as decoding HttpObjects into CouchbaseResponses.

Since:

1.0

Author:

Michael Nitschinger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ViewHandler.KeepAliveRequest
protected static class	ViewHandler.KeepAliveResponse

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

ChannelHandler.Sharable

Field Summary

Fields inherited from class com.couchbase.client.core.endpoint.AbstractGenericHandler

CHARSET, EMPTY_BYTES

Constructor Summary

Constructors

Constructor	Description
ViewHandler(AbstractEndpoint endpoint, com.lmax.disruptor.RingBuffer<ResponseEvent> responseBuffer, boolean isTransient, boolean pipeline)	Creates a new ViewHandler with the default queue for requests.

Method Summary

Modifier and Type	Method	Description
protected CouchbaseRequest	createKeepAliveRequest()	Override to return a non-null request to be fired in the pipeline in case a keep alive is triggered.
protected CouchbaseResponse	decodeResponse(ChannelHandlerContext ctx, HttpObject msg)	Decodes the incoming response and transforms it into a CouchbaseResponse.
protected HttpRequest	encodeRequest(ChannelHandlerContext ctx, ViewRequest msg)	Encode the outgoing request and return it in encoded format.
void	handlerRemoved(ChannelHandlerContext ctx)
protected ServiceType	serviceType()	Returns the ServiceType associated with this handler.

Methods inherited from class com.couchbase.client.core.endpoint.AbstractGenericHandler

addHttpBasicAuth, channelActive, channelInactive, channelWritabilityChanged, completeRequestSpan, connect, currentDispatchSpan, currentRequest, decode, encode, endpoint, env, exceptionCaught, finishedDecoding, getDecodingState, logIdent, onKeepAliveFired, onKeepAliveResponse, publishResponse, remoteHostname, remoteHttpHost, shouldSendKeepAlive, sideEffectRequestToCancel, userEventTriggered, write

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

acceptInboundMessage, acceptOutboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded

Constructor Detail

ViewHandler

public ViewHandler(AbstractEndpoint endpoint,
                   com.lmax.disruptor.RingBuffer<ResponseEvent> responseBuffer,
                   boolean isTransient,
                   boolean pipeline)

Creates a new ViewHandler with the default queue for requests.

Parameters:

endpoint - the AbstractEndpoint to coordinate with.

responseBuffer - the RingBuffer to push responses into.

Method Detail

encodeRequest

protected HttpRequest encodeRequest(ChannelHandlerContext ctx,
                                    ViewRequest msg)
                             throws Exception

Description copied from class: AbstractGenericHandler

Encode the outgoing request and return it in encoded format. This method needs to be implemented by the child handler and is responsible for the actual conversion.

Specified by:

encodeRequest in class AbstractGenericHandler<HttpObject,HttpRequest,ViewRequest>

Parameters:

ctx - the context passed in.

msg - the outgoing message.

Returns:

the encoded request.

Throws:

Exception - as a generic error.

decodeResponse

protected CouchbaseResponse decodeResponse(ChannelHandlerContext ctx,
                                           HttpObject msg)
                                    throws Exception

Description copied from class: AbstractGenericHandler

Decodes the incoming response and transforms it into a CouchbaseResponse. Note that the actual notification is handled by this generic handler, the implementing class only is concerned about the conversion itself.

Specified by:

decodeResponse in class AbstractGenericHandler<HttpObject,HttpRequest,ViewRequest>

Parameters:

ctx - the context passed in.

msg - the incoming message.

Returns:

a response or null if nothing should be returned.

Throws:

Exception - as a generic error. It will be bubbled up to the user (wrapped in a CouchbaseException) in the onError of the request's Observable.

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class AbstractGenericHandler<HttpObject,HttpRequest,ViewRequest>

Throws:

Exception

createKeepAliveRequest

protected CouchbaseRequest createKeepAliveRequest()

Description copied from class: AbstractGenericHandler

Override to return a non-null request to be fired in the pipeline in case a keep alive is triggered.

Overrides:

createKeepAliveRequest in class AbstractGenericHandler<HttpObject,HttpRequest,ViewRequest>

Returns:

a CouchbaseRequest to be fired in case of keep alive (null by default).

serviceType

protected ServiceType serviceType()

Description copied from class: AbstractGenericHandler

Returns the ServiceType associated with this handler.

Specified by:

serviceType in class AbstractGenericHandler<HttpObject,HttpRequest,ViewRequest>

Returns:

the service type.