ClientEngine (Hazelcast Root 3.12-BETA-2 API)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`applySelector(ClientSelector selector)` Only Clients that can pass through filter are allowed to connect to cluster.
`void`	`bind(ClientEndpoint endpoint)`
`Address`	`clientAddressOf(Address memberAddress)` Locates the client address of the given member address.
`int`	`getClientEndpointCount()`
`ClientExceptions`	`getClientExceptions()`
`Collection<Client>`	`getClients()`
`Map<String,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)`
`String`	`getOwnerUuid(String clientUuid)`
`ClientPartitionListenerService`	`getPartitionListenerService()`
`IPartitionService`	`getPartitionService()`
`ProxyService`	`getProxyService()`
`SecurityContext`	`getSecurityContext()`
`Address`	`getThisAddress()`
`String`	`getThisUuid()`
`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.

Methods inherited from interface com.hazelcast.util.function.Consumer
accept

- Method Detail
  - bind
```
void bind(ClientEndpoint endpoint)
```
  - 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()
  - getThisUuid
```
String getThisUuid()
```
  - 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 .
  - getClientStatistics
```
Map<String,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 and ICache Named and assuming that the Near Cache is configured): clientType clusterConnectionTimestamp credentials.principal clientAddress clientName enterprise lastStatisticsCollectionTime nearcache..creationTime nearcache..evictions nearcache..expirations nearcache..hits nearcache..lastPersistenceDuration nearcache..lastPersistenceFailure nearcache..lastPersistenceKeyCount nearcache..lastPersistenceTime nearcache..lastPersistenceWrittenBytes nearcache..misses nearcache..ownedEntryCount nearcache..ownedEntryMemoryCost nearcache.hz/.creationTime nearcache.hz/.evictions nearcache.hz/.expirations nearcache.hz/.hits nearcache.hz/.lastPersistenceDuration nearcache.hz/.lastPersistenceFailure nearcache.hz/.lastPersistenceKeyCount nearcache.hz/.lastPersistenceTime nearcache.hz/.lastPersistenceWrittenBytes nearcache.hz/.misses nearcache.hz/.ownedEntryCount nearcache.hz/.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 String, client statistics String]
  - getOwnerUuid
```
String getOwnerUuid(String clientUuid)
```
  - 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

Interface ClientEngine

Method Summary

Methods inherited from interface com.hazelcast.util.function.Consumer

Method Detail

bind

getClients

getClientEndpointCount

getPartitionService

getClusterService

getEventService

getProxyService

getLogger

getThisAddress

getThisUuid

getEndpointManager

getClientExceptions

getSecurityContext

getTransactionManagerService

getPartitionListenerService

getConnectedClientStats

getClientStatistics

getOwnerUuid

isClientAllowed

applySelector

memberAddressOf

clientAddressOf