Package com.couchbase.client.core.endpoint.search

Class SearchHandler

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,SearchRequest>

com.couchbase.client.core.endpoint.search.SearchHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class SearchHandler
extends AbstractGenericHandler<HttpObject,HttpRequest,SearchRequest>

The SearchHandler is responsible for encoding SearchRequests into lower level HttpRequests as well as decoding HttpObjects into CouchbaseResponses.

Since:

1.2

Author:

Sergey Avseyev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SearchHandler.KeepAliveRequest
protected static class	SearchHandler.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
SearchHandler(AbstractEndpoint endpoint, com.lmax.disruptor.EventSink<ResponseEvent> responseBuffer, boolean isTransient, boolean pipeline)

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, SearchRequest msg)	Encode the outgoing request and return it in encoded format.
protected void	finishedDecoding()	Notify that decoding is finished.
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, 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

SearchHandler

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

Method Detail

encodeRequest

protected HttpRequest encodeRequest(ChannelHandlerContext ctx,
                                    SearchRequest 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,SearchRequest>

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,SearchRequest>

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.

finishedDecoding

protected void finishedDecoding()

Description copied from class: AbstractGenericHandler

Notify that decoding is finished. This needs to be called by the child handlers in order to signal that operations are done.

Overrides:

finishedDecoding in class AbstractGenericHandler<HttpObject,HttpRequest,SearchRequest>

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class AbstractGenericHandler<HttpObject,HttpRequest,SearchRequest>

Throws:

Exception

serviceType

protected ServiceType serviceType()

Description copied from class: AbstractGenericHandler

Returns the ServiceType associated with this handler.

Specified by:

serviceType in class AbstractGenericHandler<HttpObject,HttpRequest,SearchRequest>

Returns:

the service type.

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,SearchRequest>

Returns:

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