com.hazelcast.client.config

Enum ClientProperty

java.lang.Object

java.lang.Enum<ClientProperty>

com.hazelcast.client.config.ClientProperty

All Implemented Interfaces:

HazelcastProperty, Serializable, Comparable<ClientProperty>

@PrivateApi
public enum ClientProperty
extends Enum<ClientProperty>
implements HazelcastProperty

Defines the name and default value for Hazelcast Client properties.

Property Summary

Properties

Type	Property and Description
String	clearSystem Clears the environmental value of the property.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVENT_QUEUE_CAPACITY Capacity of the executor that handles the incoming event packets.
EVENT_THREAD_COUNT Number of the threads to handle the incoming event packets.
HEARTBEAT_INTERVAL Time interval between the heartbeats sent by the client to the nodes.
HEARTBEAT_TIMEOUT Client sends heartbeat messages to the members and this is the timeout for this sending operations.
INVOCATION_TIMEOUT_SECONDS Time to give up on invocation when a member in the member list is not reachable.
MAX_CONCURRENT_INVOCATIONS The maximum number of concurrent invocations allowed.
SHUFFLE_MEMBER_LIST Client shuffles the given member list to prevent all clients to connect to the same node when this property is set to false.

Method Summary

Methods

Modifier and Type	Method and Description
String	clearSystemProperty() Clears the environmental value of the property.
String	getDefaultValue() Returns the default value of the property.
int	getIndex() Gets the index of the property.
String	getName() Returns the property name.
GroupProperty	getParent() Returns the parent GroupProperty of the property.
String	getSystemProperty() Gets the environmental value of the property.
TimeUnit	getTimeUnit() Returns the TimeUnit of the property.
void	setSystemProperty(String value) Sets the environmental value of the property.
String	toString()
static ClientProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SHUFFLE_MEMBER_LIST

public static final ClientProperty SHUFFLE_MEMBER_LIST

Client shuffles the given member list to prevent all clients to connect to the same node when this property is set to false. When it is set to true, the client tries to connect to the nodes in the given order.

HEARTBEAT_TIMEOUT

public static final ClientProperty HEARTBEAT_TIMEOUT

Client sends heartbeat messages to the members and this is the timeout for this sending operations. If there is not any message passing between the client and member within the given time via this property in milliseconds, the connection will be closed.

HEARTBEAT_INTERVAL

public static final ClientProperty HEARTBEAT_INTERVAL

Time interval between the heartbeats sent by the client to the nodes.

EVENT_THREAD_COUNT

public static final ClientProperty EVENT_THREAD_COUNT

Number of the threads to handle the incoming event packets.

EVENT_QUEUE_CAPACITY

public static final ClientProperty EVENT_QUEUE_CAPACITY

Capacity of the executor that handles the incoming event packets.

INVOCATION_TIMEOUT_SECONDS

public static final ClientProperty INVOCATION_TIMEOUT_SECONDS

Time to give up on invocation when a member in the member list is not reachable.

MAX_CONCURRENT_INVOCATIONS

public static final ClientProperty MAX_CONCURRENT_INVOCATIONS

The maximum number of concurrent invocations allowed.

To prevent the system from overloading, user can apply a constraint on the number of concurrent invocations. If the maximum number of concurrent invocations has been exceeded and a new invocation comes in, then hazelcast will throw HazelcastOverloadException

By default it is configured as Integer.MaxValue.

Property Detail

clearSystem

Specified by:

clearSystemProperty in interface HazelcastProperty

Method Detail

values

public static ClientProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientProperty c : ClientProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientProperty valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getIndex

public int getIndex()

Description copied from interface: HazelcastProperty

Gets the index of the property.

Specified by:

getIndex in interface HazelcastProperty

Returns:

index of the property

getName

public String getName()

Description copied from interface: HazelcastProperty

Returns the property name.

Specified by:

getName in interface HazelcastProperty

Returns:

the property name

getDefaultValue

public String getDefaultValue()

Description copied from interface: HazelcastProperty

Returns the default value of the property.

Specified by:

getDefaultValue in interface HazelcastProperty

Returns:

the default value or null if none is defined

getTimeUnit

public TimeUnit getTimeUnit()

Description copied from interface: HazelcastProperty

Returns the TimeUnit of the property.

Specified by:

getTimeUnit in interface HazelcastProperty

Returns:

the TimeUnit

getParent

public GroupProperty getParent()

Description copied from interface: HazelcastProperty

Returns the parent GroupProperty of the property.

Specified by:

getParent in interface HazelcastProperty

Returns:

the parent GroupProperty or null if none is defined

setSystemProperty

public void setSystemProperty(String value)

Description copied from interface: HazelcastProperty

Sets the environmental value of the property.

Specified by:

setSystemProperty in interface HazelcastProperty

Parameters:

value - the value to set

getSystemProperty

public String getSystemProperty()

Description copied from interface: HazelcastProperty

Gets the environmental value of the property.

Specified by:

getSystemProperty in interface HazelcastProperty

Returns:

the value of the property

clearSystemProperty

public String clearSystemProperty()

Description copied from interface: HazelcastProperty

Clears the environmental value of the property.

Specified by:

clearSystemProperty in interface HazelcastProperty

toString

public String toString()

Overrides:

toString in class Enum<ClientProperty>