com.gemstone.gemfire.cache
Interface ClientSession

public interface ClientSession

Class ClientSession represents a client session on the server. The methods in this class should only be invoked by server entities.

Since:

6.0

Method Summary

boolean	isPrimary() Returns whether this server is the primary for this client
void	registerInterest(String regionName, Object keyOfInterest, InterestResultPolicy policy, boolean isDurable) Registers interest in a particular region and key
void	registerInterest(String regionName, Object keyOfInterest, InterestResultPolicy policy, boolean isDurable, boolean receiveValues) Registers interest in a particular region and key
void	unregisterInterest(String regionName, Object keyOfInterest, boolean isDurable) Unregisters interest in a particular region and key
void	unregisterInterest(String regionName, Object keyOfInterest, boolean isDurable, boolean receiveValues) Unregisters interest in a particular region and key

Method Detail

registerInterest

void registerInterest(String regionName,
                      Object keyOfInterest,
                      InterestResultPolicy policy,
                      boolean isDurable)

Registers interest in a particular region and key

Parameters:

regionName - The name of the region in which to unregister interest

keyOfInterest - The key to unregister interest

policy - The InterestResultPolicy

isDurable - Whether the interest is durable

Throws:

IllegalStateException - if this is not the primary server for the given client

registerInterest

void registerInterest(String regionName,
                      Object keyOfInterest,
                      InterestResultPolicy policy,
                      boolean isDurable,
                      boolean receiveValues)

Registers interest in a particular region and key

Parameters:

regionName - The name of the region in which to unregister interest

keyOfInterest - The key to unregister interest

policy - The InterestResultPolicy

isDurable - Whether the interest is durable

receiveValues - defaults to true. set to false to receive create or update events as invalidates similar to notify-by-subscription false.

Throws:

IllegalStateException - if this is not the primary server for the given client

Since:

6.5

unregisterInterest

void unregisterInterest(String regionName,
                        Object keyOfInterest,
                        boolean isDurable)

Unregisters interest in a particular region and key

Parameters:

regionName - The name of the region in which to unregister interest

keyOfInterest - The key to unregister interest

isDurable - Whether the interest is durable

Throws:

IllegalStateException - if this is not the primary server for the given client

unregisterInterest

void unregisterInterest(String regionName,
                        Object keyOfInterest,
                        boolean isDurable,
                        boolean receiveValues)

Unregisters interest in a particular region and key

Parameters:

regionName - The name of the region in which to unregister interest

keyOfInterest - The key to unregister interest

isDurable - Whether the interest is durable

receiveValues - defaults to true. set to false to receive create or update events as invalidates similar to notify-by-subscription false.

Throws:

IllegalStateException - if this is not the primary server for the given client

Since:

6.5

isPrimary

boolean isPrimary()

Returns whether this server is the primary for this client

Returns:

whether this server is the primary for this client