com.hazelcast.client.impl

Class NoOpClientEngine

java.lang.Object

com.hazelcast.client.impl.NoOpClientEngine

All Implemented Interfaces:

ClientEngine, Consumer<ClientMessage>

public class NoOpClientEngine
extends Object
implements ClientEngine

Constructor Summary

Constructors

Constructor and Description
NoOpClientEngine()

Method Summary

Modifier and Type	Method and Description
void	accept(ClientMessage clientMessage)
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 clientAddress) 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 class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Detail

NoOpClientEngine

public NoOpClientEngine()

Method Detail

bind

public boolean bind(ClientEndpoint endpoint)

Description copied from interface: ClientEngine

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 ClientEngine.applySelector(com.hazelcast.client.impl.ClientSelector)

Specified by:

bind in interface ClientEngine

Parameters:

endpoint - to be registered to client engine

Returns:

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

getClients

public Collection<Client> getClients()

Specified by:

getClients in interface ClientEngine

getClientEndpointCount

public int getClientEndpointCount()

Specified by:

getClientEndpointCount in interface ClientEngine

getPartitionService

public IPartitionService getPartitionService()

Specified by:

getPartitionService in interface ClientEngine

getClusterService

public ClusterService getClusterService()

Specified by:

getClusterService in interface ClientEngine

getEventService

public EventService getEventService()

Specified by:

getEventService in interface ClientEngine

getProxyService

public ProxyService getProxyService()

Specified by:

getProxyService in interface ClientEngine

getLogger

public ILogger getLogger(Class clazz)

Specified by:

getLogger in interface ClientEngine

getThisAddress

public Address getThisAddress()

Specified by:

getThisAddress in interface ClientEngine

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

public ClientEndpointManager getEndpointManager()

Specified by:

getEndpointManager in interface ClientEngine

getClientExceptions

public ClientExceptions getClientExceptions()

Specified by:

getClientExceptions in interface ClientEngine

getSecurityContext

public SecurityContext getSecurityContext()

Specified by:

getSecurityContext in interface ClientEngine

getTransactionManagerService

public TransactionManagerService getTransactionManagerService()

Specified by:

getTransactionManagerService in interface ClientEngine

getPartitionListenerService

public ClientPartitionListenerService getPartitionListenerService()

Specified by:

getPartitionListenerService in interface ClientEngine

getConnectedClientStats

public Map<ClientType,Integer> getConnectedClientStats()

Description copied from interface: ClientEngine

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.

Specified by:

getConnectedClientStats in interface ClientEngine

Returns:

Map<ClientType, Integer>.

getClientStatistics

public Map<UUID,String> getClientStatistics()

Description copied from interface: ClientEngine

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.

Specified by:

getClientStatistics in interface ClientEngine

Returns:

Map of [client UUID UUID, client statistics String]

isClientAllowed

public boolean isClientAllowed(Client client)

Specified by:

isClientAllowed in interface ClientEngine

Parameters:

client - to check if allowed through current ClientSelector

Returns:

true if allowed, false otherwise

applySelector

public void applySelector(ClientSelector selector)

Description copied from interface: ClientEngine

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.

Specified by:

applySelector in interface ClientEngine

Parameters:

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

accept

public void accept(ClientMessage clientMessage)

Specified by:

accept in interface Consumer<ClientMessage>

memberAddressOf

public Address memberAddressOf(Address clientAddress)

Description copied from interface: ClientEngine

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.

Specified by:

memberAddressOf in interface ClientEngine

Parameters:

clientAddress - the client address of the member

Returns:

the member address of the member

clientAddressOf

public Address clientAddressOf(Address clientAddress)

Description copied from interface: ClientEngine

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

Specified by:

clientAddressOf in interface ClientEngine

Parameters:

clientAddress - the member address of the member

Returns:

the client address of the member

onClientAcquiredResource

public void onClientAcquiredResource(UUID uuid)

Description copied from interface: ClientEngine

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

Specified by:

onClientAcquiredResource in interface ClientEngine

Parameters:

uuid - client uuid

addBackupListener

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

Specified by:

addBackupListener in interface ClientEngine

dispatchBackupEvent

public void dispatchBackupEvent(UUID clientUUID,
                                long clientCorrelationId)

Specified by:

dispatchBackupEvent in interface ClientEngine

deregisterBackupListener

public boolean deregisterBackupListener(UUID clientUUID)

Specified by:

deregisterBackupListener in interface ClientEngine