com.hazelcast.client

Interface ClientEndpoint

All Superinterfaces:

Client, Endpoint

All Known Implementing Classes:

ClientEndpointImpl

public interface ClientEndpoint
extends Client

Represents an endpoint to a client. So for each client connected to a member, a ClientEndpoint object is available.

Method Summary

Methods

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)
void	clearAllListeners()
Connection	getConnection()
Credentials	getCredentials()
ClientPrincipal	getPrincipal()
Subject	getSubject()
TransactionContext	getTransactionContext(String txnId)
boolean	isAlive() Checks if the endpoint is alive.
boolean	isAuthenticated()
boolean	isFirstConnection()
boolean	removeDestroyAction(String id)
void	removeTransactionContext(String txnId)
void	sendEvent(Object key, Object event, long callId)
void	sendResponse(Object response, long callId)
void	setLoginContext(LoginContext lc)
void	setTransactionContext(TransactionContext context)

Methods inherited from interface com.hazelcast.core.Client

getClientType, getSocketAddress, getUuid

Method Detail

isAlive

boolean isAlive()

Checks if the endpoint is alive.

Returns:

true if alive, false otherwise.

sendResponse

void sendResponse(Object response,
                long callId)

sendEvent

void sendEvent(Object key,
             Object event,
             long callId)

addListenerDestroyAction

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.

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

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.

Parameters:

registrationId - registration id of destroy action

removeAction - callable that will be called when endpoint is destroyed

removeDestroyAction

boolean removeDestroyAction(String id)

Parameters:

id - registration id of destroy action

Returns:

true if remove is successful

getCredentials

Credentials getCredentials()

setTransactionContext

void setTransactionContext(TransactionContext context)

getTransactionContext

TransactionContext getTransactionContext(String txnId)

removeTransactionContext

void removeTransactionContext(String txnId)

isFirstConnection

boolean isFirstConnection()

getSubject

Subject getSubject()

clearAllListeners

void clearAllListeners()

getConnection

Connection getConnection()

setLoginContext

void setLoginContext(LoginContext lc)

authenticated

void authenticated(ClientPrincipal principal,
                 Credentials credentials,
                 boolean firstConnection)

authenticated

void authenticated(ClientPrincipal principal)

getPrincipal

ClientPrincipal getPrincipal()

isAuthenticated

boolean isAuthenticated()

Returns:

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