com.couchbase.client.core.service

Class AbstractService

java.lang.Object

com.couchbase.client.core.state.AbstractStateMachine<LifecycleState>

com.couchbase.client.core.service.AbstractService

All Implemented Interfaces:

Service, Stateful<LifecycleState>

Direct Known Subclasses:

ConfigService, KeyValueService, QueryService, ViewService

public abstract class AbstractService
extends AbstractStateMachine<LifecycleState>
implements Service

The base implementation for all Services.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.couchbase.client.core.service.Service

Service.EndpointFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<rx.Observable<LifecycleState>>	endpointStates The current list of endpoint states.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractService(java.lang.String hostname, java.lang.String bucket, java.lang.String password, int port, CoreEnvironment env, int numEndpoints, SelectionStrategy strategy, com.lmax.disruptor.RingBuffer<ResponseEvent> responseBuffer, Service.EndpointFactory factory) Creates a new AbstractService and instantiates needed components and flows.

Method Summary

Methods

Modifier and Type	Method and Description
rx.Observable<LifecycleState>	connect() Connects all currently enabled Service Endpoints.
rx.Observable<LifecycleState>	disconnect() Disconnects all currently enabled Service Endpoints.
protected static java.lang.String	logIdent(java.lang.String hostname, Service service) Simple log helper to give logs a common prefix.
BucketServiceMapping	mapping() Returns the mapping for the given Service.
void	send(CouchbaseRequest request) Sends a CouchbaseRequest into the service and eventually returns a CouchbaseResponse.

Methods inherited from class com.couchbase.client.core.state.AbstractStateMachine

isState, state, states, transitionState

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.couchbase.client.core.service.Service

type

Methods inherited from interface com.couchbase.client.core.state.Stateful

isState, state, states

Field Detail

endpointStates

protected java.util.List<rx.Observable<LifecycleState>> endpointStates

The current list of endpoint states.

Constructor Detail

AbstractService

protected AbstractService(java.lang.String hostname,
               java.lang.String bucket,
               java.lang.String password,
               int port,
               CoreEnvironment env,
               int numEndpoints,
               SelectionStrategy strategy,
               com.lmax.disruptor.RingBuffer<ResponseEvent> responseBuffer,
               Service.EndpointFactory factory)

Creates a new AbstractService and instantiates needed components and flows.

Parameters:

hostname - the hostname of the service.

bucket - the name of the bucket.

password - the password of the bucket.

port - the port of the service.

env - the shared environment.

numEndpoints - the number of endpoints to init.

strategy - the endpoint selection strategy used.

responseBuffer - the shared response buffer.

factory - the endpoint factory.

Method Detail

mapping

public BucketServiceMapping mapping()

Description copied from interface: Service

Returns the mapping for the given Service.

Specified by:

mapping in interface Service

Returns:

the mapping.

send

public void send(CouchbaseRequest request)

Description copied from interface: Service

Sends a CouchbaseRequest into the service and eventually returns a CouchbaseResponse.

The CouchbaseResponse is not returned directly, but is wrapped into a Observable.

Specified by:

send in interface Service

Parameters:

request - the request to send.

connect

public rx.Observable<LifecycleState> connect()

Description copied from interface: Service

Connects all currently enabled Service Endpoints.

Specified by:

connect in interface Service

Returns:

the states of the Service after the connect process for all enabled Endpoints.

disconnect

public rx.Observable<LifecycleState> disconnect()

Description copied from interface: Service

Disconnects all currently enabled Service Endpoints.

Specified by:

disconnect in interface Service

Returns:

the states of the Service after the disconnect process for all enabled Endpoints.

logIdent

protected static java.lang.String logIdent(java.lang.String hostname,
                        Service service)

Simple log helper to give logs a common prefix.

Parameters:

hostname - the address.

service - the service.

Returns:

a prefix string for logs.