com.hazelcast.config

Class ReliableIdGeneratorConfig

java.lang.Object

com.hazelcast.config.ReliableIdGeneratorConfig

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable

Direct Known Subclasses:

ReliableIdGeneratorConfigReadOnly

public class ReliableIdGeneratorConfig
extends Object
implements IdentifiedDataSerializable

The ReliableIdGeneratorConfig contains the configuration for the member regarding Reliable ID Generator.

Settings here only apply when ID generator is used from member, not when clients connect to this member to generate IDs - each client has its own settings in ClientConfig.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PREFETCH_COUNT Default value for getPrefetchCount().
static long	DEFAULT_PREFETCH_VALIDITY_MILLIS Default value for getPrefetchValidityMillis().

Constructor Summary

Constructors

Constructor and Description
ReliableIdGeneratorConfig(ReliableIdGeneratorConfig other) Copy-constructor
ReliableIdGeneratorConfig(String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ReliableIdGeneratorConfigReadOnly	getAsReadOnly() Deprecated. this method will be removed in 4.0; it is meant for internal usage only
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
int	getId() Returns type identifier for this class.
String	getName() Returns the configuration name.
int	getPrefetchCount()
long	getPrefetchValidityMillis()
int	hashCode()
void	readData(ObjectDataInput in) Reads fields from the input stream
void	setName(String name) Sets the name or name pattern for this config.
ReliableIdGeneratorConfig	setPrefetchCount(int prefetchCount) How many IDs are pre-fetched on the background when one call to ReliableIdGenerator.newId() is made.
ReliableIdGeneratorConfig	setPrefetchValidityMillis(long prefetchValidityMs) For how long the pre-fetched IDs can be used.
String	toString()
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_PREFETCH_COUNT

public static final int DEFAULT_PREFETCH_COUNT

Default value for getPrefetchCount().

See Also:

Constant Field Values

DEFAULT_PREFETCH_VALIDITY_MILLIS

public static final long DEFAULT_PREFETCH_VALIDITY_MILLIS

Default value for getPrefetchValidityMillis().

See Also:

Constant Field Values

Constructor Detail

ReliableIdGeneratorConfig

public ReliableIdGeneratorConfig(String name)

ReliableIdGeneratorConfig

public ReliableIdGeneratorConfig(ReliableIdGeneratorConfig other)

Copy-constructor

Method Detail

getAsReadOnly

public ReliableIdGeneratorConfigReadOnly getAsReadOnly()

Deprecated. this method will be removed in 4.0; it is meant for internal usage only

Gets immutable version of this configuration.

Returns:

immutable version of this configuration

getName

public String getName()

Returns the configuration name. This can be actual object name or pattern.

setName

public void setName(String name)

Sets the name or name pattern for this config. Must not be modified after this instance is added to Config.

getPrefetchCount

public int getPrefetchCount()

See Also:

setPrefetchCount(int)

setPrefetchCount

public ReliableIdGeneratorConfig setPrefetchCount(int prefetchCount)

How many IDs are pre-fetched on the background when one call to ReliableIdGenerator.newId() is made.

Value must be >= 1, default is 100.

Returns:

this instance for fluent API

getPrefetchValidityMillis

public long getPrefetchValidityMillis()

See Also:

setPrefetchValidityMillis(long)

setPrefetchValidityMillis

public ReliableIdGeneratorConfig setPrefetchValidityMillis(long prefetchValidityMs)

For how long the pre-fetched IDs can be used. If this time elapses, new IDs will be fetched.

Time unit is milliseconds.

If value is <= 0, validity is unlimited. Default value is 600,000 (10 minutes).

The IDs contain timestamp component, which ensures rough global ordering of IDs. If an ID is assigned to an event that occurred much later, it will be much out of order. If you don't need ordering, set this value to 0.

Returns:

this instance for fluent API

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getId

public int getId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getId in interface IdentifiedDataSerializable

Returns:

type ID

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.