Package com.couchbase.client.core.env

Class AbstractServiceConfig

java.lang.Object

com.couchbase.client.core.env.AbstractServiceConfig

Direct Known Subclasses:

AnalyticsServiceConfig, KeyValueServiceConfig, QueryServiceConfig, SearchServiceConfig, ViewServiceConfig

public abstract class AbstractServiceConfig
extends Object

Defines a general config for a Service.

Since:

1.4.2

Author:

Michael Nitschinger

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_IDLE_TIME	The default idle time for pooled services.
static int	NO_IDLE_TIME	Constant to use if no idle time should be used.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractServiceConfig(int minEndpoints, int maxEndpoints, boolean pipelined, int idleTime)	Creates a new service config.

Method Summary

Modifier and Type	Method	Description
protected void	checkIdleTime(int idleTime)	Helper method to check if the idle time is within proper range.
int	idleTime()	The time in seconds (minimum, approx) after when idle the socket will be closed.
boolean	isPipelined()	If this service is pipelined (more than one request at the same time on the same socket).
int	maxEndpoints()	The maximum endpoints per node which will be established.
int	minEndpoints()	The minimum endpoints per node which will always be established.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_IDLE_TIME

public static final int NO_IDLE_TIME

Constant to use if no idle time should be used.

See Also:

Constant Field Values

DEFAULT_IDLE_TIME

public static final int DEFAULT_IDLE_TIME

The default idle time for pooled services.

See Also:

Constant Field Values

Constructor Detail

AbstractServiceConfig

protected AbstractServiceConfig(int minEndpoints,
                                int maxEndpoints,
                                boolean pipelined,
                                int idleTime)

Creates a new service config.

Parameters:

minEndpoints - minimum number of endpoints to be used

maxEndpoints - maximum number of endpoints to be used

pipelined - if this is a pipelined service.

idleTime - the configured idle time

Method Detail

checkIdleTime

protected void checkIdleTime(int idleTime)

Helper method to check if the idle time is within proper range. This method is refactored out so it can be overridden in test cases.

Parameters:

idleTime - the idle time to check.

minEndpoints

public int minEndpoints()

The minimum endpoints per node which will always be established.

maxEndpoints

public int maxEndpoints()

The maximum endpoints per node which will be established.

isPipelined

public boolean isPipelined()

If this service is pipelined (more than one request at the same time on the same socket).

idleTime

public int idleTime()

The time in seconds (minimum, approx) after when idle the socket will be closed.

toString

public String toString()

Overrides:

toString in class Object