com.hazelcast.client.impl

Class ClientEndpointImpl

java.lang.Object

com.hazelcast.client.impl.ClientEndpointImpl

All Implemented Interfaces:

ClientEndpoint, Client, Endpoint

public final class ClientEndpointImpl
extends Object
implements ClientEndpoint

The ClientEndpoint and Client implementation.

Constructor Summary

Constructors

Constructor and Description
ClientEndpointImpl(ClientEngine clientEngine, NodeEngineImpl nodeEngine, Connection connection)

Method Summary

Modifier and Type	Method and Description
void	addDestroyAction(String registrationId, Callable<Boolean> removeAction) Adds a remove callable to be called when endpoint is destroyed Note: removeDestroyAction should be called when there is no need to destroy action anymore.
void	addListenerDestroyAction(String service, String topic, String id) Adds a remove callable to be called when endpoint is destroyed to clean related listener Following line will be called when endpoint destroyed : eventService.deregisterListener(service, topic, ID); Note: removeDestroyAction should be called when there is no need to destroy action anymore.
void	authenticated(ClientPrincipal principal)
void	authenticated(ClientPrincipal principal, Credentials credentials, boolean firstConnection, String clientVersion, long authCorrelationId, String clientName, Set<String> labels)
void	clearAllListeners()
void	destroy()
long	getAuthenticationCorrelationId()
String	getClientStatistics()
ClientType	getClientType() Returns the type of this client.
int	getClientVersion()
Connection	getConnection()
Credentials	getCredentials()
Set<String>	getLabels()
String	getName() This method may return null depending on the client version and the client type Java client provides client name starting with 3.12
InetSocketAddress	getSocketAddress() Returns the socket address of this client.
Subject	getSubject()
TransactionContext	getTransactionContext(String txnId)
String	getUuid() Returns a unique UUID for this client.
boolean	isAlive() Checks if the endpoint is alive.
boolean	isAuthenticated()
boolean	isOwnerConnection() Indicates whether this endpoint is the owner connection for that client.
boolean	removeDestroyAction(String id)
void	removeTransactionContext(String txnId)
void	setClientStatistics(String stats) Updates to the latest client statistics.
void	setClientVersion(String version)
void	setLoginContext(LoginContext loginContext)
void	setTransactionContext(TransactionContext transactionContext)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientEndpointImpl

public ClientEndpointImpl(ClientEngine clientEngine,
                          NodeEngineImpl nodeEngine,
                          Connection connection)

Method Detail

getConnection

public Connection getConnection()

Specified by:

getConnection in interface ClientEndpoint

getUuid

public String getUuid()

Description copied from interface: Client

Returns a unique UUID for this client.

Specified by:

getUuid in interface Client

Specified by:

getUuid in interface Endpoint

Returns:

a unique UUID for this client

isAlive

public boolean isAlive()

Description copied from interface: ClientEndpoint

Checks if the endpoint is alive.

Specified by:

isAlive in interface ClientEndpoint

Returns:

true if alive, false otherwise.

setLoginContext

public void setLoginContext(LoginContext loginContext)

Specified by:

setLoginContext in interface ClientEndpoint

getSubject

public Subject getSubject()

Specified by:

getSubject in interface ClientEndpoint

isOwnerConnection

public boolean isOwnerConnection()

Description copied from interface: ClientEndpoint

Indicates whether this endpoint is the owner connection for that client.

Specified by:

isOwnerConnection in interface ClientEndpoint

Returns:

true when this endpoint is the owner connection for the client

authenticated

public void authenticated(ClientPrincipal principal,
                          Credentials credentials,
                          boolean firstConnection,
                          String clientVersion,
                          long authCorrelationId,
                          String clientName,
                          Set<String> labels)

Specified by:

authenticated in interface ClientEndpoint

authenticated

public void authenticated(ClientPrincipal principal)

Specified by:

authenticated in interface ClientEndpoint

isAuthenticated

public boolean isAuthenticated()

Specified by:

isAuthenticated in interface ClientEndpoint

Returns:

true if endpoint is authenticated with valid security credentials, returns false otherwise

getClientVersion

public int getClientVersion()

Specified by:

getClientVersion in interface ClientEndpoint

Returns:

the client version as calculated by BuildInfo

setClientVersion

public void setClientVersion(String version)

Specified by:

setClientVersion in interface ClientEndpoint

Parameters:

version - the version string as obtained from the environment

setClientStatistics

public void setClientStatistics(String stats)

Description copied from interface: ClientEndpoint

Updates to the latest client statistics.

Specified by:

setClientStatistics in interface ClientEndpoint

Parameters:

stats - the latest statistics retrieved from the client

getClientStatistics

public String getClientStatistics()

Specified by:

getClientStatistics in interface ClientEndpoint

Returns:

statistics string for the client

getSocketAddress

public InetSocketAddress getSocketAddress()

Description copied from interface: Client

Returns the socket address of this client.

Specified by:

getSocketAddress in interface Client

Specified by:

getSocketAddress in interface Endpoint

Returns:

the socket address of this client

getClientType

public ClientType getClientType()

Description copied from interface: Client

Returns the type of this client.

Specified by:

getClientType in interface Client

Returns:

the type of this client

getName

public String getName()

Description copied from interface: Client

This method may return null depending on the client version and the client type Java client provides client name starting with 3.12

Specified by:

getName in interface Client

Returns:

the name of this client if provided, null otherwise

getLabels

public Set<String> getLabels()

Specified by:

getLabels in interface Client

Returns:

read only set of all labels of this client.

getTransactionContext

public TransactionContext getTransactionContext(String txnId)

Specified by:

getTransactionContext in interface ClientEndpoint

getCredentials

public Credentials getCredentials()

Specified by:

getCredentials in interface ClientEndpoint

setTransactionContext

public void setTransactionContext(TransactionContext transactionContext)

Specified by:

setTransactionContext in interface ClientEndpoint

removeTransactionContext

public void removeTransactionContext(String txnId)

Specified by:

removeTransactionContext in interface ClientEndpoint

addListenerDestroyAction

public void addListenerDestroyAction(String service,
                                     String topic,
                                     String id)

Description copied from interface: ClientEndpoint

Adds a remove callable to be called when endpoint is destroyed to clean related listener Following line will be called when endpoint destroyed : eventService.deregisterListener(service, topic, ID); Note: removeDestroyAction should be called when there is no need to destroy action anymore.

Specified by:

addListenerDestroyAction in interface ClientEndpoint

Parameters:

service - name of the related service of listener

topic - topic name of listener(mostly distributed object name)

id - registration ID of remove action

addDestroyAction

public void addDestroyAction(String registrationId,
                             Callable<Boolean> removeAction)

Description copied from interface: ClientEndpoint

Adds a remove callable to be called when endpoint is destroyed Note: removeDestroyAction should be called when there is no need to destroy action anymore.

Specified by:

addDestroyAction in interface ClientEndpoint

Parameters:

registrationId - registration ID of destroy action

removeAction - callable that will be called when endpoint is destroyed

removeDestroyAction

public boolean removeDestroyAction(String id)

Specified by:

removeDestroyAction in interface ClientEndpoint

Parameters:

id - registration ID of destroy action

Returns:

true if remove is successful

clearAllListeners

public void clearAllListeners()

Specified by:

clearAllListeners in interface ClientEndpoint

destroy

public void destroy()
             throws LoginException

Throws:

LoginException

toString

public String toString()

Overrides:

toString in class Object

getAuthenticationCorrelationId

public long getAuthenticationCorrelationId()