com.hazelcast.client.impl

Class ClientEngineImpl

java.lang.Object

com.hazelcast.client.impl.ClientEngineImpl

All Implemented Interfaces:

ClientEngine, CoreService, EventPublishingService<ClientEvent,ClientListener>, ManagedService, MembershipAwareService, PreJoinAwareService, Consumer<ClientMessage>

public class ClientEngineImpl
extends Object
implements ClientEngine, CoreService, PreJoinAwareService, ManagedService, MembershipAwareService, EventPublishingService<ClientEvent,ClientListener>

Class that requests, listeners from client handled in node side.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME Service name to be used in requests.

Constructor Summary

Constructors

Constructor and Description
ClientEngineImpl(Node node)

Method Summary

Modifier and Type	Method and Description
void	accept(ClientMessage clientMessage) Performs this operation on the given argument.
String	addOwnershipMapping(String clientUuid, String ownerUuid)
void	applySelector(ClientSelector newSelector) 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.
void	dispatchEvent(ClientEvent event, ClientListener listener) Notifies the service of a published event.
int	getClientEndpointCount()
ClientExceptions	getClientExceptions()
ExecutorService	getClientManagementExecutor()
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()
Operation	getPreJoinOperation() An operation to be executed on the joining member before it is set as joined.
ProxyService	getProxyService()
SecurityContext	getSecurityContext()
Address	getThisAddress()
String	getThisUuid()
TransactionManagerService	getTransactionManagerService()
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
boolean	isClientAllowed(Client client)
void	memberAdded(MembershipServiceEvent event) Invoked when a new member is added to the cluster.
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	memberAttributeChanged(MemberAttributeServiceEvent event) Invoked when a member attribute is changed.
void	memberRemoved(MembershipServiceEvent event) Invoked when an existing member leaves the cluster.
boolean	removeOwnershipMapping(String clientUuid, String memberUuid)
void	reset() Resets this service back to its initial state.
void	shutdown(boolean terminate) Shuts down this service.
boolean	trySetLastAuthenticationCorrelationId(String clientUuid, long newCorrelationId)

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

Service name to be used in requests.

See Also:

Constant Field Values

Constructor Detail

ClientEngineImpl

public ClientEngineImpl(Node node)

Method Detail

getClientManagementExecutor

public ExecutorService getClientManagementExecutor()

getClientEndpointCount

public int getClientEndpointCount()

Specified by:

getClientEndpointCount in interface ClientEngine

accept

public void accept(ClientMessage clientMessage)

Description copied from interface: Consumer

Performs this operation on the given argument.

Specified by:

accept in interface Consumer<ClientMessage>

Parameters:

clientMessage - the input argument

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

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()

getThisUuid

public String getThisUuid()

Specified by:

getThisUuid in interface ClientEngine

getLogger

public ILogger getLogger(Class clazz)

Specified by:

getLogger in interface ClientEngine

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

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

applySelector

public void applySelector(ClientSelector newSelector)

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:

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

dispatchEvent

public void dispatchEvent(ClientEvent event,
                          ClientListener listener)

Description copied from interface: EventPublishingService

Notifies the service of a published event.

Specified by:

dispatchEvent in interface EventPublishingService<ClientEvent,ClientListener>

Parameters:

event - the published event

listener - the listener registered for this event

memberAdded

public void memberAdded(MembershipServiceEvent event)

Description copied from interface: MembershipAwareService

Invoked when a new member is added to the cluster. Should be non-blocking.

Specified by:

memberAdded in interface MembershipAwareService

Parameters:

event - the event for a new member added to the cluster

memberRemoved

public void memberRemoved(MembershipServiceEvent event)

Description copied from interface: MembershipAwareService

Invoked when an existing member leaves the cluster. Should be non-blocking.

Specified by:

memberRemoved in interface MembershipAwareService

Parameters:

event - the event for an existing member leaving the cluster

memberAttributeChanged

public void memberAttributeChanged(MemberAttributeServiceEvent event)

Description copied from interface: MembershipAwareService

Invoked when a member attribute is changed.

Specified by:

memberAttributeChanged in interface MembershipAwareService

Parameters:

event - the event for a member attribute being changed

getClients

public Collection<Client> getClients()

Specified by:

getClients in interface ClientEngine

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

trySetLastAuthenticationCorrelationId

public boolean trySetLastAuthenticationCorrelationId(String clientUuid,
                                                     long newCorrelationId)

addOwnershipMapping

public String addOwnershipMapping(String clientUuid,
                                  String ownerUuid)

removeOwnershipMapping

public boolean removeOwnershipMapping(String clientUuid,
                                      String memberUuid)

getOwnerUuid

public String getOwnerUuid(String clientUuid)

Specified by:

getOwnerUuid in interface ClientEngine

getTransactionManagerService

public TransactionManagerService getTransactionManagerService()

Specified by:

getTransactionManagerService in interface ClientEngine

getPartitionListenerService

public ClientPartitionListenerService getPartitionListenerService()

Specified by:

getPartitionListenerService in interface ClientEngine

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

getPreJoinOperation

public Operation getPreJoinOperation()

Description copied from interface: PreJoinAwareService

An operation to be executed on the joining member before it is set as joined. As is the case with PostJoinAwareService.getPostJoinOperation()s, no partition locks, no key-based locks, no service level locks, no database interaction are allowed. Additionally, a pre-join operation is executed while the cluster lock is being held on the joining member, so it is important that the operation finishes quickly and does not interact with other locks. The Operation.getPartitionId() method should return a negative value. This means that the operations should not implement PartitionAwareOperation.

Pre join operations should return response, which may also be a null response.

Specified by:

getPreJoinOperation in interface PreJoinAwareService

Returns:

an operation to be executed on joining member before it is set as joined. Can be null.

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 .

getClientStatistics

public Map<String,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 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.

Specified by:

getClientStatistics in interface ClientEngine

Returns:

Map of [client UUID String, client statistics String]

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 memberAddress)

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:

memberAddress - the member address of the member

Returns:

the client address of the member