blazingcache.client

Class CacheClientBuilder

java.lang.Object

blazingcache.client.CacheClientBuilder

public class CacheClientBuilder
extends Object

Utility for booting CacheClients

Author:

enrico.olivelli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CacheClientBuilder.Mode

Method Summary

Modifier and Type	Method and Description
CacheClient	build() Builds up the client. in LOCAL mode eventually a local embedded CacheServer will be started too.
CacheClientBuilder	clientId(String clientId) The the ID of the client, it MUST be unique, it represent the peer on the network
CacheClientBuilder	clientSecret(String clientSecret) Secret for autentication to the CacheServer
CacheClientBuilder	connectTimeout(int connectTimeout) Connection timeout for sockets
CacheClientBuilder	host(String host) Host of the server for the SINGLESERVER mode
CacheClientBuilder	localCacheServer(Object cacheServer) Pass a custom local CacheServer for LOCAL mode
CacheClientBuilder	maxMemory(long maxMemory) Limit on the memory retained by the cache, the value is expressed in bytes
CacheClientBuilder	mode(CacheClientBuilder.Mode mode) Discovery mode
static CacheClientBuilder	newBuilder()
CacheClientBuilder	port(int port) Port of the server for the SINGLESERVER mode
CacheClientBuilder	socketTimeout(int socketTimeout) Socket timeout for sockets
CacheClientBuilder	ssl(boolean ssl) SSL mode for the SINGLESERVER mode
CacheClientBuilder	zkConnectString(String zkConnectString) Zookeeper connection string
CacheClientBuilder	zkPath(String zkPath) Zookeeper Path for discovery
CacheClientBuilder	zkSessionTimeout(int zkSessionTimeout) Timeout for the Zookeeper client

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static CacheClientBuilder newBuilder()

clientId

public CacheClientBuilder clientId(String clientId)

The the ID of the client, it MUST be unique, it represent the peer on the network

Parameters:

clientId -

Returns:

zkPath

public CacheClientBuilder zkPath(String zkPath)

Zookeeper Path for discovery

Parameters:

zkPath -

Returns:

zkConnectString

public CacheClientBuilder zkConnectString(String zkConnectString)

Zookeeper connection string

Parameters:

zkConnectString -

Returns:

localCacheServer

public CacheClientBuilder localCacheServer(Object cacheServer)

Pass a custom local CacheServer for LOCAL mode

Parameters:

cacheServer -

Returns:

zkSessionTimeout

public CacheClientBuilder zkSessionTimeout(int zkSessionTimeout)

Timeout for the Zookeeper client

maxMemory

public CacheClientBuilder maxMemory(long maxMemory)

Limit on the memory retained by the cache, the value is expressed in bytes

Parameters:

maxMemory -

Returns:

port

public CacheClientBuilder port(int port)

Port of the server for the SINGLESERVER mode

Parameters:

port -

Returns:

host

public CacheClientBuilder host(String host)

Host of the server for the SINGLESERVER mode

Parameters:

host -

Returns:

ssl

public CacheClientBuilder ssl(boolean ssl)

SSL mode for the SINGLESERVER mode

Parameters:

ssl -

Returns:

connectTimeout

public CacheClientBuilder connectTimeout(int connectTimeout)

Connection timeout for sockets

Parameters:

connectTimeout -

Returns:

socketTimeout

public CacheClientBuilder socketTimeout(int socketTimeout)

Socket timeout for sockets

Parameters:

socketTimeout -

Returns:

mode

public CacheClientBuilder mode(CacheClientBuilder.Mode mode)

Discovery mode

Parameters:

mode -

Returns:

See Also:

CacheClientBuilder.Mode

clientSecret

public CacheClientBuilder clientSecret(String clientSecret)

Secret for autentication to the CacheServer

Parameters:

clientSecret -

Returns:

build

public CacheClient build()

Builds up the client. in LOCAL mode eventually a local embedded CacheServer will be started too. The returned Client MUST be started in order to work

Returns:

See Also:

CacheClient.start(), CacheClient.waitForConnection(int)