org.glassfish.grizzly.memcached

Class GrizzlyMemcachedCache.Builder<K,V>

java.lang.Object

org.glassfish.grizzly.memcached.GrizzlyMemcachedCache.Builder<K,V>

All Implemented Interfaces:

CacheBuilder<K,V>

Enclosing class:

GrizzlyMemcachedCache<K,V>

public static class GrizzlyMemcachedCache.Builder<K,V>
extends Object
implements CacheBuilder<K,V>

Constructor Summary

Constructors

Constructor and Description
GrizzlyMemcachedCache.Builder(String cacheName, GrizzlyMemcachedCacheManager manager, org.glassfish.grizzly.nio.transport.TCPNIOTransport transport)

Method Summary

Methods

Modifier and Type	Method and Description
GrizzlyMemcachedCache.Builder<K,V>	allowDisposableConnection(boolean allowDisposableConnection) Allow or disallow disposable connections Default is false.
GrizzlyMemcachedCache.Builder<K,V>	borrowValidation(boolean borrowValidation) Enable or disable the connection validation when the connection is borrowed from the connection pool Default is false.
GrizzlyMemcachedCache<K,V>	build() Create an instance of the named Cache.
GrizzlyMemcachedCache.Builder<K,V>	connectTimeoutInMillis(long connectTimeoutInMillis) Set global connect-timeout If the given param is negative, the timeout is infite.
GrizzlyMemcachedCache.Builder<K,V>	failover(boolean failover) Enable or disable failover/failback Default is true.
GrizzlyMemcachedCache.Builder<K,V>	healthMonitorIntervalInSecs(long healthMonitorIntervalInSecs) Set health monitor's interval This cache will schedule HealthMonitorTask with this interval.
GrizzlyMemcachedCache.Builder<K,V>	keepAliveTimeoutInSecs(long keepAliveTimeoutInSecs) Set connection pool's KeepAliveTimeout Default is 1800.
GrizzlyMemcachedCache.Builder<K,V>	maxConnectionPerServer(int maxConnectionPerServer) Set connection pool's max Default is Integer.MAX_VALUE
GrizzlyMemcachedCache.Builder<K,V>	minConnectionPerServer(int minConnectionPerServer) Set connection pool's min Default is 5.
GrizzlyMemcachedCache.Builder<K,V>	preferRemoteConfig(boolean preferRemoteConfig)
GrizzlyMemcachedCache.Builder<K,V>	responseTimeoutInMillis(long responseTimeoutInMillis) Set global response-timeout If the given param is negative, the timeout is infite.
GrizzlyMemcachedCache.Builder<K,V>	retryCount(int retryCount) Deprecated. not supported anymore
GrizzlyMemcachedCache.Builder<K,V>	returnValidation(boolean returnValidation) Enable or disable the connection validation when the connection is returned to the connection pool Default is false.
GrizzlyMemcachedCache.Builder<K,V>	servers(Set<SocketAddress> servers) Set initial servers
GrizzlyMemcachedCache.Builder<K,V>	writeTimeoutInMillis(long writeTimeoutInMillis) Set global write-timeout If the given param is negative, the timeout is infite.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrizzlyMemcachedCache.Builder

public GrizzlyMemcachedCache.Builder(String cacheName,
                             GrizzlyMemcachedCacheManager manager,
                             org.glassfish.grizzly.nio.transport.TCPNIOTransport transport)

Method Detail

build

public GrizzlyMemcachedCache<K,V> build()

Create an instance of the named Cache.

Specified by:

build in interface CacheBuilder<K,V>

Returns:

a new instance of the named cache

See Also:

CacheManager.createCacheBuilder(String)

connectTimeoutInMillis

public GrizzlyMemcachedCache.Builder<K,V> connectTimeoutInMillis(long connectTimeoutInMillis)

Set global connect-timeout

If the given param is negative, the timeout is infite. Default is 5000.

Parameters:

connectTimeoutInMillis - connect-timeout in milli-seconds

Returns:

this builder

writeTimeoutInMillis

public GrizzlyMemcachedCache.Builder<K,V> writeTimeoutInMillis(long writeTimeoutInMillis)

Set global write-timeout

If the given param is negative, the timeout is infite. Default is 5000.

Parameters:

writeTimeoutInMillis - write-timeout in milli-seconds

Returns:

this builder

responseTimeoutInMillis

public GrizzlyMemcachedCache.Builder<K,V> responseTimeoutInMillis(long responseTimeoutInMillis)

Set global response-timeout

If the given param is negative, the timeout is infite. Default is 10000.

Parameters:

responseTimeoutInMillis - response-timeout in milli-seconds

Returns:

this builder

minConnectionPerServer

public GrizzlyMemcachedCache.Builder<K,V> minConnectionPerServer(int minConnectionPerServer)

Set connection pool's min

Default is 5.

Parameters:

minConnectionPerServer - connection pool's min

Returns:

this builder

See Also:

BaseObjectPool.Builder#min(int)

maxConnectionPerServer

public GrizzlyMemcachedCache.Builder<K,V> maxConnectionPerServer(int maxConnectionPerServer)

Set connection pool's max

Default is Integer.MAX_VALUE

Parameters:

maxConnectionPerServer - connection pool's max

Returns:

this builder

See Also:

BaseObjectPool.Builder#max(int)

keepAliveTimeoutInSecs

public GrizzlyMemcachedCache.Builder<K,V> keepAliveTimeoutInSecs(long keepAliveTimeoutInSecs)

Set connection pool's KeepAliveTimeout

Default is 1800.

Parameters:

keepAliveTimeoutInSecs - connection pool's KeepAliveTimeout in seconds

Returns:

this builder

See Also:

BaseObjectPool.Builder#keepAliveTimeoutInSecs(long)

healthMonitorIntervalInSecs

public GrizzlyMemcachedCache.Builder<K,V> healthMonitorIntervalInSecs(long healthMonitorIntervalInSecs)

Set health monitor's interval

This cache will schedule HealthMonitorTask with this interval. HealthMonitorTask will check the failure servers periodically and detect the revived server. If the given parameter is negative, this cache never schedules HealthMonitorTask so this behavior is similar to seting failover to be false. Default is 60.

Parameters:

healthMonitorIntervalInSecs - interval in seconds

Returns:

this builder

allowDisposableConnection

public GrizzlyMemcachedCache.Builder<K,V> allowDisposableConnection(boolean allowDisposableConnection)

Allow or disallow disposable connections

Default is false.

Parameters:

allowDisposableConnection - true if this cache allows disposable connections

Returns:

this builder

borrowValidation

public GrizzlyMemcachedCache.Builder<K,V> borrowValidation(boolean borrowValidation)

Enable or disable the connection validation when the connection is borrowed from the connection pool

Default is false.

Parameters:

borrowValidation - true if this cache should make sure the borrowed connection is valid

Returns:

this builder

returnValidation

public GrizzlyMemcachedCache.Builder<K,V> returnValidation(boolean returnValidation)

Enable or disable the connection validation when the connection is returned to the connection pool

Default is false.

Parameters:

returnValidation - true if this cache should make sure the returned connection is valid

Returns:

this builder

servers

public GrizzlyMemcachedCache.Builder<K,V> servers(Set<SocketAddress> servers)

Set initial servers

Parameters:

servers - server set

Returns:

this builder

failover

public GrizzlyMemcachedCache.Builder<K,V> failover(boolean failover)

Enable or disable failover/failback

Default is true.

Parameters:

failover - true if this cache should support failover/failback when the server is failed or revived

Returns:

this builder

retryCount

public GrizzlyMemcachedCache.Builder<K,V> retryCount(int retryCount)

Deprecated. not supported anymore

preferRemoteConfig

public GrizzlyMemcachedCache.Builder<K,V> preferRemoteConfig(boolean preferRemoteConfig)