com.hazelcast.cp.internal

Class CPSubsystemImpl

java.lang.Object

com.hazelcast.cp.internal.CPSubsystemImpl

All Implemented Interfaces:

CPSubsystem

public class CPSubsystemImpl
extends Object
implements CPSubsystem

Provides access to CP subsystem utilities

Constructor Summary

Constructors

Constructor and Description
CPSubsystemImpl(HazelcastInstanceImpl instance)

Method Summary

Modifier and Type	Method and Description
IAtomicLong	getAtomicLong(String name) Returns a proxy for an IAtomicLong instance created on the CP subsystem.
<E> IAtomicReference<E>	getAtomicReference(String name) Returns a proxy for an IAtomicReference instance created on the CP subsystem.
ICountDownLatch	getCountDownLatch(String name) Returns a proxy for an ICountDownLatch instance created on the CP subsystem.
CPSessionManagementService	getCPSessionManagementService() Returns the CPSessionManagementService of this Hazelcast instance.
CPSubsystemManagementService	getCPSubsystemManagementService() Returns the CPSubsystemManagementService of this Hazelcast instance.
CPMember	getLocalCPMember() Returns the local CP member if this Hazelcast member is part of the CP subsystem, returns null otherwise.
FencedLock	getLock(String name) Returns a proxy for an FencedLock instance created on the CP subsystem.
ISemaphore	getSemaphore(String name) Returns a proxy for an ISemaphore instance created on the CP subsystem.

Methods inherited from class java.lang.Object

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

Constructor Detail

CPSubsystemImpl

public CPSubsystemImpl(HazelcastInstanceImpl instance)

Method Detail

getAtomicLong

public IAtomicLong getAtomicLong(String name)

Description copied from interface: CPSubsystem

Returns a proxy for an IAtomicLong instance created on the CP subsystem. Hazelcast's IAtomicLong is a distributed version of java.util.concurrent.atomic.AtomicLong. If no group name is given within the "name" parameter, then the IAtomicLong instance will be created on the DEFAULT CP group. If a group name is given, like .getAtomicLong("myLong@group1"), the given group will be initialized first, if not initialized already, and then the IAtomicLong instance will be created on this group. Returned IAtomicLong instance offers linearizability and behaves as a CP register. When a network partition occurs, proxies that exist on the minority side of its CP group lose availability.

Each call of this method performs a commit to the Metadata CP group. Hence, callers should cache the returned proxy.

Specified by:

getAtomicLong in interface CPSubsystem

Parameters:

name - name of the IAtomicLong proxy

Returns:

IAtomicLong proxy for the given name

getAtomicReference

public <E> IAtomicReference<E> getAtomicReference(String name)

Description copied from interface: CPSubsystem

Returns a proxy for an IAtomicReference instance created on the CP subsystem. Hazelcast's IAtomicReference is a distributed version of java.util.concurrent.atomic.AtomicLong. If no group name is given within the "name" parameter, then the IAtomicReference instance will be created on the DEFAULT CP group. If a group name is given, like .getAtomicReference("myRef@group1"), the given group will be initialized first, if not initialized already, and then the IAtomicReference instance will be created on this group. Returned IAtomicReference instance offers linearizability and behaves as a CP register. When a network partition occurs, proxies that exist on the minority side of its CP group lose availability.

Each call of this method performs a commit to the Metadata CP group. Hence, callers should cache the returned proxy.

Specified by:

getAtomicReference in interface CPSubsystem

Parameters:

name - name of the IAtomicReference proxy

Returns:

IAtomicReference proxy for the given name

getCountDownLatch

public ICountDownLatch getCountDownLatch(String name)

Description copied from interface: CPSubsystem

Returns a proxy for an ICountDownLatch instance created on the CP subsystem. Hazelcast's ICountDownLatch is a distributed version of java.util.concurrent.CountDownLatch. If no group name is given within the "name" parameter, then the ICountDownLatch instance will be created on the DEFAULT CP group. If a group name is given, like .getCountDownLatch("myLatch@group1"), the given group will be initialized first, if not initialized already, and then the ICountDownLatch instance will be created on this group. Returned ICountDownLatch instance offers linearizability. When a network partition occurs, proxies that exist on the minority side of its CP group lose availability.

Each call of this method performs a commit to the Metadata CP group. Hence, callers should cache the returned proxy.

Specified by:

getCountDownLatch in interface CPSubsystem

Parameters:

name - name of the ICountDownLatch proxy

Returns:

ICountDownLatch proxy for the given name

getLock

public FencedLock getLock(String name)

Description copied from interface: CPSubsystem

Returns a proxy for an FencedLock instance created on the CP subsystem. Hazelcast's FencedLock is a distributed version of java.util.concurrent.locks.Lock. If no group name is given within the "name" parameter, then the FencedLock instance will be created on the DEFAULT CP group. If a group name is given, like .getLock("myLock@group1"), the given group will be initialized first, if not initialized already, and then the FencedLock instance will be created on this group. Returned FencedLock instance offers linearizability. When a network partition occurs, proxies that exist on the minority side of its CP group lose availability.

Each call of this method performs a commit to the Metadata CP group. Hence, callers should cache the returned proxy.

Specified by:

getLock in interface CPSubsystem

Parameters:

name - name of the FencedLock proxy

Returns:

FencedLock proxy for the given name

See Also:

FencedLockConfig

getSemaphore

public ISemaphore getSemaphore(String name)

Description copied from interface: CPSubsystem

Returns a proxy for an ISemaphore instance created on the CP subsystem. Hazelcast's ISemaphore is a distributed version of java.util.concurrent.Semaphore. If no group name is given within the "name" parameter, then the ISemaphore instance will be created on the DEFAULT CP group. If a group name is given, like .getSemaphore("mySemaphore@group1"), the given group will be initialized first, if not initialized already, and then the ISemaphore instance will be created on this group. Returned ISemaphore instance offers linearizability. When a network partition occurs, proxies that exist on the minority side of its CP group lose availability.

Each call of this method performs a commit to the Metadata CP group. Hence, callers should cache the returned proxy.

Specified by:

getSemaphore in interface CPSubsystem

Parameters:

name - name of the ISemaphore proxy

Returns:

ISemaphore proxy for the given name

See Also:

CPSemaphoreConfig

getLocalCPMember

public CPMember getLocalCPMember()

Description copied from interface: CPSubsystem

Returns the local CP member if this Hazelcast member is part of the CP subsystem, returns null otherwise.

This method is a shortcut for CPSubsystemManagementService.getLocalCPMember() method. Calling this method is equivalent to calling getCPSubsystemManagementService().getLocalCPMember().

Specified by:

getLocalCPMember in interface CPSubsystem

Returns:

local CP member if available, null otherwise

See Also:

CPSubsystemManagementService.getLocalCPMember()

getCPSubsystemManagementService

public CPSubsystemManagementService getCPSubsystemManagementService()

Description copied from interface: CPSubsystem

Returns the CPSubsystemManagementService of this Hazelcast instance. CPSubsystemManagementService offers APIs for managing CP members and CP groups.

Specified by:

getCPSubsystemManagementService in interface CPSubsystem

Returns:

the CPSubsystemManagementService of this Hazelcast instance

getCPSessionManagementService

public CPSessionManagementService getCPSessionManagementService()

Description copied from interface: CPSubsystem

Returns the CPSessionManagementService of this Hazelcast instance. CPSessionManagementService offers APIs for managing CP sessions.

Specified by:

getCPSessionManagementService in interface CPSubsystem

Returns:

the CPSessionManagementService of this Hazelcast instance