com.hazelcast.client.impl.protocol.template

Interface ClientMessageTemplate

public interface ClientMessageTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	addDistributedObjectListener(boolean localOnly)
Object	addMembershipListener(boolean localOnly)
Object	addPartitionLostListener(boolean localOnly)
Object	authentication(String username, String password, String uuid, String ownerUuid, boolean isOwnerConnection, String clientType, byte serializationVersion)
Object	authenticationCustom(Data credentials, String uuid, String ownerUuid, boolean isOwnerConnection, String clientType, byte serializationVersion)
void	createProxy(String name, String serviceName, Address target)
void	destroyProxy(String name, String serviceName)
Object	getDistributedObjects()
Object	getPartitions()
void	ping()
void	removeAllListeners()
Object	removeDistributedObjectListener(String registrationId)
Object	removePartitionLostListener(String registrationId)

Method Detail

authentication

Object authentication(String username,
                    String password,
                    @Nullable
                    String uuid,
                    @Nullable
                    String ownerUuid,
                    boolean isOwnerConnection,
                    String clientType,
                    byte serializationVersion)

Parameters:

username - Name of the user for authentication.

password - Password for the user.

uuid - Unique string identifying the connected client uniquely. This string is generated by the owner member server on initial connection. When the client connects to a non-owner member it sets this field on the request.

ownerUuid - Unique string identifying the server member uniquely.

isOwnerConnection - You must set this field to true while connecting to the owner member, otherwise set to false.

clientType - The type of the client. E.g. JAVA, CPP, CSHARP, etc.

serializationVersion - client side supported version to inform server side

Returns:

Returns the address, uuid and owner uuid.

authenticationCustom

Object authenticationCustom(Data credentials,
                          @Nullable
                          String uuid,
                          @Nullable
                          String ownerUuid,
                          boolean isOwnerConnection,
                          String clientType,
                          byte serializationVersion)

Parameters:

credentials - Secret byte array for authentication.

uuid - Unique string identifying the connected client uniquely. This string is generated by the owner member server on initial connection. When the client connects to a non-owner member it sets this field on the request.

ownerUuid - Unique string identifying the server member uniquely.

isOwnerConnection - You must set this field to true while connecting to the owner member, otherwise set to false.

clientType - The type of the client. E.g. JAVA, CPP, CSHARP, etc.

serializationVersion - client side supported version to inform server side

Returns:

Returns the address, uuid and owner uuid.

addMembershipListener

Object addMembershipListener(boolean localOnly)

Parameters:

localOnly - if true only master node sends events, otherwise all registered nodes send all membership changes.

Returns:

Returns the registration id for the listener.

createProxy

void createProxy(String name,
               String serviceName,
               Address target)

Parameters:

name - The distributed object name for which the proxy is being created for.

serviceName - The name of the service. Possible service names are: "hz:impl:listService" "hz:impl:queueService" "hz:impl:setService" "hz:impl:atomicLongService" "hz:impl:atomicReferenceService" "hz:impl:countDownLatchService" "hz:impl:idGeneratorService" "hz:impl:semaphoreService" "hz:impl:executorService" "hz:impl:mapService" "hz:impl:mapReduceService" "hz:impl:multiMapService" "hz:impl:quorumService" "hz:impl:replicatedMapService" "hz:impl:ringbufferService" "hz:core:proxyService" "hz:impl:reliableTopicService" "hz:impl:topicService" "hz:core:txManagerService" "hz:impl:xaService"

destroyProxy

void destroyProxy(String name,
                String serviceName)

Parameters:

name - The distributed object name for which the proxy is being destroyed for.

serviceName - The name of the service. Possible service names are: "hz:impl:listService" "hz:impl:queueService" "hz:impl:setService" "hz:impl:atomicLongService" "hz:impl:atomicReferenceService" "hz:impl:countDownLatchService" "hz:impl:idGeneratorService" "hz:impl:semaphoreService" "hz:impl:executorService" "hz:impl:mapService" "hz:impl:mapReduceService" "hz:impl:multiMapService" "hz:impl:quorumService" "hz:impl:replicatedMapService" "hz:impl:ringbufferService" "hz:core:proxyService" "hz:impl:reliableTopicService" "hz:impl:topicService" "hz:core:txManagerService" "hz:impl:xaService"

getPartitions

Object getPartitions()

Returns:

The partition list for each member address.

removeAllListeners

void removeAllListeners()

addPartitionLostListener

Object addPartitionLostListener(boolean localOnly)

Parameters:

localOnly - if true only node that has the partition sends the request, if false sends all partition lost events.

Returns:

The listener registration id.

removePartitionLostListener

Object removePartitionLostListener(String registrationId)

Parameters:

registrationId - The id assigned during the listener registration.

Returns:

true if the listener existed and removed, false otherwise.

getDistributedObjects

Object getDistributedObjects()

Returns:

An array of distributed object info in the cluster.

addDistributedObjectListener

Object addDistributedObjectListener(boolean localOnly)

Returns:

The registration id for the distributed object listener.

removeDistributedObjectListener

Object removeDistributedObjectListener(String registrationId)

Parameters:

registrationId - The id assigned during the registration.

Returns:

true if the listener existed and removed, false otherwise.

ping

void ping()