com.hazelcast.client.impl

Interface ClientEngine

All Superinterfaces:

Consumer<ClientMessage>

All Known Implementing Classes:

ClientEngineImpl, NoOpClientEngine

public interface ClientEngine
extends Consumer<ClientMessage>

The client Engine. todo: what is the purpose of the client engine.

Method Summary

Modifier and Type	Method and Description
void	addBackupListener(UUID clientUUID, Consumer<Long> backupListener)
void	applySelector(ClientSelector selector) Only Clients that can pass through filter are allowed to connect to cluster.
boolean	bind(ClientEndpoint endpoint) Registers client endpoint to endpointManager.
Address	clientAddressOf(Address memberAddress) Locates the client address of the given member address.
boolean	deregisterBackupListener(UUID clientUUID)
void	dispatchBackupEvent(UUID clientUUID, long clientCorrelationId)
int	getClientEndpointCount()
ClientExceptions	getClientExceptions()
Collection<Client>	getClients()
Map<UUID,String>	getClientStatistics() The statistics is a String that is composed of key=value pairs separated by ',' .
ClusterService	getClusterService()
Map<ClientType,Integer>	getConnectedClientStats() Returns Map which contains number of connected clients to the cluster.
ClientEndpointManager	getEndpointManager()
EventService	getEventService()
ILogger	getLogger(Class clazz)
ClientPartitionListenerService	getPartitionListenerService()
IPartitionService	getPartitionService()
ProxyService	getProxyService()
SecurityContext	getSecurityContext()
Address	getThisAddress()
TransactionManagerService	getTransactionManagerService()
boolean	isClientAllowed(Client client)
Address	memberAddressOf(Address clientAddress) Locates the cluster member that has the provided client address and returns its member address, to be used for intra-cluster communication.
void	onClientAcquiredResource(UUID uuid) Notify client engine that a client with given uuid required a resource (lock) on this member

Methods inherited from interface java.util.function.Consumer

accept, andThen

Method Detail

bind

boolean bind(ClientEndpoint endpoint)

Registers client endpoint to endpointManager. Only authenticated endpoints should be registered here. bind can be called twice for same connection, as long as client is allowed to be registered all calls to this method returns true A selector could prevent endpoint to be registered see applySelector(com.hazelcast.client.impl.ClientSelector)

Parameters:

endpoint - to be registered to client engine

Returns:

false if client is not allowed to join because of a selector, true otherwise

getClients

Collection<Client> getClients()

getClientEndpointCount

int getClientEndpointCount()

getPartitionService

IPartitionService getPartitionService()

getClusterService

ClusterService getClusterService()

getEventService

EventService getEventService()

getProxyService

ProxyService getProxyService()

getLogger

ILogger getLogger(Class clazz)

getThisAddress

Address getThisAddress()

Returns:

the address of this member that listens for CLIENT protocol connections. When advanced network config is in use, it will be different from the MEMBER listening address reported eg by Node.getThisAddress()

getEndpointManager

ClientEndpointManager getEndpointManager()

getClientExceptions

ClientExceptions getClientExceptions()

getSecurityContext

SecurityContext getSecurityContext()

getTransactionManagerService

TransactionManagerService getTransactionManagerService()

getPartitionListenerService

ClientPartitionListenerService getPartitionListenerService()

getConnectedClientStats

Map<ClientType,Integer> getConnectedClientStats()

Returns Map which contains number of connected clients to the cluster. The returned map can be used to get information about connected clients to the cluster.

Returns:

Map<ClientType, Integer>.

getClientStatistics

Map<UUID,String> getClientStatistics()

The statistics is a String that is composed of key=value pairs separated by ',' . The following characters are escaped in IMap and ICache names by the escape character '\' : '=' '.' ',' '\' The statistics key identify the category and name of the statistics. It is formatted as: mainCategory.subCategory.statisticName An e.g. Operating system committedVirtualMemorySize path would be: os.committedVirtualMemorySize The statistics key names can be one of the following (Used IMap named <example.fastmap> and ICache Named <StatTestCacheName> and assuming that the Near Cache is configured):

 clientType
 clusterConnectionTimestamp
 credentials.principal
 clientAddress
 clientName
 enterprise
 lastStatisticsCollectionTime
 nearcache.<example\.fastmap>.creationTime
 nearcache.<example\.fastmap>.evictions
 nearcache.<example\.fastmap>.expirations
 nearcache.<example\.fastmap>.hits
 nearcache.<example\.fastmap>.lastPersistenceDuration
 nearcache.<example\.fastmap>.lastPersistenceFailure
 nearcache.<example\.fastmap>.lastPersistenceKeyCount
 nearcache.<example\.fastmap>.lastPersistenceTime
 nearcache.<example\.fastmap>.lastPersistenceWrittenBytes
 nearcache.<example\.fastmap>.misses
 nearcache.<example\.fastmap>.ownedEntryCount
 nearcache.<example\.fastmap>.ownedEntryMemoryCost
 nearcache.hz/<StatTestCacheName>.creationTime
 nearcache.hz/<StatTestCacheName>.evictions
 nearcache.hz/<StatTestCacheName>.expirations
 nearcache.hz/<StatTestCacheName>.hits
 nearcache.hz/<StatTestCacheName>.lastPersistenceDuration
 nearcache.hz/<StatTestCacheName>.lastPersistenceFailure
 nearcache.hz/<StatTestCacheName>.lastPersistenceKeyCount
 nearcache.hz/<StatTestCacheName>.lastPersistenceTime
 nearcache.hz/<StatTestCacheName>.lastPersistenceWrittenBytes
 nearcache.hz/<StatTestCacheName>.misses
 nearcache.hz/<StatTestCacheName>.ownedEntryCount
 nearcache.hz/<StatTestCacheName>.ownedEntryMemoryCost
 os.committedVirtualMemorySize
 os.freePhysicalMemorySize
 os.freeSwapSpaceSize
 os.maxFileDescriptorCount
 os.openFileDescriptorCount
 os.processCpuTime
 os.systemLoadAverage
 os.totalPhysicalMemorySize
 os.totalSwapSpaceSize
 runtime.availableProcessors
 runtime.freeMemory
 runtime.maxMemory
 runtime.totalMemory
 runtime.uptime
 runtime.usedMemory
 userExecutor.queueSize
 

Not: Please observe that the name for the ICache appears to be the hazelcast instance name "hz" followed by "/" and followed by the cache name provided which is StatTestCacheName.

Returns:

Map of [client UUID UUID, client statistics String]

isClientAllowed

boolean isClientAllowed(Client client)

Parameters:

client - to check if allowed through current ClientSelector

Returns:

true if allowed, false otherwise

applySelector

void applySelector(ClientSelector selector)

Only Clients that can pass through filter are allowed to connect to cluster. Only one selector can be active at a time. Applying new one will override old selector.

Parameters:

selector - to select a client or group of clients to act upon

memberAddressOf

Address memberAddressOf(Address clientAddress)

Locates the cluster member that has the provided client address and returns its member address, to be used for intra-cluster communication. This is required when clients deliver messages with designated target members, since clients may be unaware of the actual member address (when advanced network config is enabled). Throws a TargetNotMemberException when no member with the provided client address can be located.

Parameters:

clientAddress - the client address of the member

Returns:

the member address of the member

clientAddressOf

Address clientAddressOf(Address memberAddress)

Locates the client address of the given member address. Performs the reverse transformation of memberAddressOf(Address).

Parameters:

memberAddress - the member address of the member

Returns:

the client address of the member

onClientAcquiredResource

void onClientAcquiredResource(UUID uuid)

Notify client engine that a client with given uuid required a resource (lock) on this member

Parameters:

uuid - client uuid

addBackupListener

void addBackupListener(UUID clientUUID,
                       Consumer<Long> backupListener)

deregisterBackupListener

boolean deregisterBackupListener(UUID clientUUID)

dispatchBackupEvent

void dispatchBackupEvent(UUID clientUUID,
                         long clientCorrelationId)