com.hazelcast.flakeidgen.impl

Class FlakeIdGeneratorService

java.lang.Object

com.hazelcast.flakeidgen.impl.FlakeIdGeneratorService

All Implemented Interfaces:

ManagedService, RemoteService, StatisticsAwareService<LocalFlakeIdGeneratorStats>

public class FlakeIdGeneratorService
extends Object
implements ManagedService, RemoteService, StatisticsAwareService<LocalFlakeIdGeneratorStats>

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
FlakeIdGeneratorService(NodeEngine nodeEngine)

Method Summary

Modifier and Type	Method and Description
DistributedObject	createDistributedObject(String name, boolean local) Creates a distributed object on the local member only (when local is true), else cluster-wide.
void	destroyDistributedObject(String name, boolean local) Destroys a distributed object.
Map<String,LocalFlakeIdGeneratorStats>	getStats() Return the service statistics for the local instance.
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
void	reset() Resets this service back to its initial state.
void	shutdown(boolean terminate) Shuts down this service.
void	updateStatsForBatch(String name, int batchSize) Updated the statistics for the FlakeIdGenerator with the given name for a newly generated batch of the given size.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.internal.services.RemoteService

createDistributedObject, destroyDistributedObject

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

FlakeIdGeneratorService

public FlakeIdGeneratorService(NodeEngine nodeEngine)

Method Detail

init

public void init(NodeEngine nodeEngine,
                 Properties properties)

Description copied from interface: ManagedService

Initializes this service.

Specified by:

init in interface ManagedService

Parameters:

nodeEngine - the NodeEngine that this service belongs to

properties - the Properties (can be used to pass settings to the service)

reset

public void reset()

Description copied from interface: ManagedService

Resets this service back to its initial state.

TODO: what is the purpose of reset

Specified by:

reset in interface ManagedService

shutdown

public void shutdown(boolean terminate)

Description copied from interface: ManagedService

Shuts down this service.

TODO: what is the purpose of the terminate variable

Specified by:

shutdown in interface ManagedService

Parameters:

terminate - true to shut down this service

createDistributedObject

public DistributedObject createDistributedObject(String name,
                                                 boolean local)

Description copied from interface: RemoteService

Creates a distributed object on the local member only (when local is true), else cluster-wide.

Specified by:

createDistributedObject in interface RemoteService

Parameters:

name - the name for the created distributed object

local - when true then only perform required proxy creation actions on the local member, otherwise perform cluster-wide proxy creation.

Returns:

the created distributed object

destroyDistributedObject

public void destroyDistributedObject(String name,
                                     boolean local)

Description copied from interface: RemoteService

Destroys a distributed object.

Specified by:

destroyDistributedObject in interface RemoteService

Parameters:

name - the name of the distributed object to destroy

getStats

public Map<String,LocalFlakeIdGeneratorStats> getStats()

Description copied from interface: StatisticsAwareService

Return the service statistics for the local instance.

Specified by:

getStats in interface StatisticsAwareService<LocalFlakeIdGeneratorStats>

Returns:

the statistics, grouped by distributed object name

updateStatsForBatch

public void updateStatsForBatch(String name,
                                int batchSize)

Updated the statistics for the FlakeIdGenerator with the given name for a newly generated batch of the given size.

Parameters:

name - name of the generator, not null

batchSize - size of the batch created