Package com.tangosol.net

Class CoherenceSession

java.lang.Object

com.tangosol.net.CoherenceSession

All Implemented Interfaces:

Session, AutoCloseable

public class CoherenceSession
extends Object
implements Session

An implementation of a Session allowing applications to use the new operator to create a Session via the default SessionProvider.

Author:

bo 2015.09.27

See Also:

• Session
• SessionProvider

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.net.Session

Session.Option

Field Summary

Fields

Modifier and Type	Field	Description
protected Session	m_session	The underlying Session to which this implementation will delegate requests.

Constructor Summary

Constructors

Constructor	Description
CoherenceSession()	Constructs a CoherenceSession using the default session configuration.
CoherenceSession(Session.Option... options)	Deprecated. since 20.12 use CoherenceSession(SessionConfiguration, Coherence.Mode, Iterable)
CoherenceSession(SessionConfiguration configuration, Coherence.Mode mode, Iterable<? extends EventInterceptor<?>> interceptors)	Constructs a CoherenceSession based on the specified SessionConfiguration.

Method Summary

Modifier and Type	Method	Description
void	activate()	Activate this Session.
void	close()
void	close(NamedCollection col)	Close and release the a NamedCollection.
void	destroy(NamedCollection col)	Destroy a NamedCollection.
<K, V> NamedCache<K,V>	getCache(String sName, NamedMap.Option... options)	Acquire a NamedCache using the specified NamedMap.Options, for example a TypeAssertion.
<E> NamedDeque<E>	getDeque(String sName)	Acquire a NamedDeque.
<E> NamedDeque<E>	getDeque(String sName, NamedCollection.Option... options)	Acquire a NamedDeque.
InterceptorRegistry	getInterceptorRegistry()	Return the InterceptorRegistry for this session.
<K, V> NamedMap<K,V>	getMap(String sName, NamedMap.Option... options)	Acquire a NamedMap using the specified NamedMap.Options, for example a TypeAssertion.
String	getName()	Return the name of this session, if available.
<E> NamedQueue<E>	getQueue(String sName)	Acquire a NamedQueue.
<E> NamedQueue<E>	getQueue(String sName, NamedCollection.Option... options)	Acquire a NamedQueue.
ResourceRegistry	getResourceRegistry()	Return the ResourceRegistry for this session.
String	getScopeName()	Return the scope name of this cache factory, if available.
Service	getService(String sServiceName)	Returns a service for the given name or null if no service exists in this session with the specified name.
<V> NamedTopic<V>	getTopic(String sName, NamedCollection.Option... options)	Acquire a NamedTopic using the specified ValueTypeAssertion.
boolean	isActive()	Return true if this Session is active and has not been closed.
boolean	isCacheActive(String sCacheName, ClassLoader loader)	Validate whether a cache with the given name is active in the context of the given ClassLoader.
boolean	isMapActive(String sMapName, ClassLoader loader)	Validate whether a map with the given name is active in the context of the given ClassLoader.
boolean	isTopicActive(String sTopicName, ClassLoader loader)	Validate whether a topic with the given name is active in the context of the given ClassLoader.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.net.Session

createPublisher, createPublisher, createSubscriber, createSubscriber, getTopic

Field Details

m_session

protected Session m_session

The underlying Session to which this implementation will delegate requests.

Constructor Details

CoherenceSession

public CoherenceSession()

Constructs a CoherenceSession using the default session configuration.

Throws:

IllegalStateException - if a session could not be created

See Also:

• SessionConfiguration.defaultSession()

CoherenceSession

public CoherenceSession(SessionConfiguration configuration,
 Coherence.Mode mode,
 Iterable<? extends EventInterceptor<?>> interceptors)

Constructs a CoherenceSession based on the specified SessionConfiguration.

Parameters:

configuration - the SessionConfigurations for the CoherenceSession

mode - the mode Coherence is running in

interceptors - optional interceptors to add to the session in addition to any in the configuration

Throws:

IllegalStateException - if a session could not be created

CoherenceSession

@Deprecated
public CoherenceSession(Session.Option... options)

Deprecated.

since 20.12 use CoherenceSession(SessionConfiguration, Coherence.Mode, Iterable)

Constructs a CoherenceSession based on the specified Session.Options using the default SessionProvider.

Parameters:

options - the Session.Options for the CoherenceSession

Throws:

IllegalStateException - if a session could not be created

Method Details

getMap

public <K,
V> NamedMap<K,V> getMap(String sName,
 NamedMap.Option... options)

Description copied from interface: Session

Acquire a NamedMap using the specified NamedMap.Options, for example a TypeAssertion.

Specified by:

getMap in interface Session

Type Parameters:

K - the type of keys for the NamedMap

V - the type of values for the NamedMap

Parameters:

sName - the name of the NamedMap

options - the NamedMap.Options

Returns:

a NamedMap

getCache

public <K,
V> NamedCache<K,V> getCache(String sName,
 NamedMap.Option... options)

Description copied from interface: Session

Acquire a NamedCache using the specified NamedMap.Options, for example a TypeAssertion.

Specified by:

getCache in interface Session

Type Parameters:

K - the type of keys for the NamedCache

V - the type of values for the NamedCache

Parameters:

sName - the name of the NamedCache

options - the NamedMap.Options

Returns:

a NamedCache

getTopic

public <V> NamedTopic<V> getTopic(String sName,
 NamedCollection.Option... options)

Description copied from interface: Session

Acquire a NamedTopic using the specified ValueTypeAssertion.

Specified by:

getTopic in interface Session

Type Parameters:

V - the type of elements for the NamedTopic

Parameters:

sName - the name of the NamedTopic

Returns:

a NamedCache

getQueue

public <E> NamedQueue<E> getQueue(String sName)

Description copied from interface: Session

Acquire a NamedQueue.

Specified by:

getQueue in interface Session

Type Parameters:

E - the type of elements in the NamedQueue

Parameters:

sName - the name of the NamedQueue

Returns:

a NamedQueue

getQueue

public <E> NamedQueue<E> getQueue(String sName,
 NamedCollection.Option... options)

Description copied from interface: Session

Acquire a NamedQueue.

Specified by:

getQueue in interface Session

Type Parameters:

E - the type of elements in the NamedQueue

Parameters:

sName - the name of the NamedQueue

Returns:

a NamedQueue

getDeque

public <E> NamedDeque<E> getDeque(String sName)

Description copied from interface: Session

Acquire a NamedDeque.

Specified by:

getDeque in interface Session

Type Parameters:

E - the type of elements in the NamedDeque

Parameters:

sName - the name of the NamedDeque

Returns:

a NamedQueue

getDeque

public <E> NamedDeque<E> getDeque(String sName,
 NamedCollection.Option... options)

Description copied from interface: Session

Acquire a NamedDeque.

Specified by:

getDeque in interface Session

Type Parameters:

E - the type of elements in the NamedDeque

Parameters:

sName - the name of the NamedDeque

Returns:

a NamedQueue

close

public void close(NamedCollection col)

Description copied from interface: Session

Close and release the a NamedCollection.

Specified by:

close in interface Session

Parameters:

col - the NamedCollection to close

destroy

public void destroy(NamedCollection col)

Description copied from interface: Session

Destroy a NamedCollection.

Warning: This method is used to completely destroy the specified collection across the cluster. All references in the entire cluster to this collection will be invalidated, the collection data will be cleared, and all internal resources will be released.

Specified by:

destroy in interface Session

Parameters:

col - the NamedCollection to destroy

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

getResourceRegistry

public ResourceRegistry getResourceRegistry()

Description copied from interface: Session

Return the ResourceRegistry for this session.

Specified by:

getResourceRegistry in interface Session

Returns:

the ResourceRegistry for this session

getInterceptorRegistry

public InterceptorRegistry getInterceptorRegistry()

Description copied from interface: Session

Return the InterceptorRegistry for this session. EventInterceptors registered with this session will be scoped to services and caches created by this session.

Specified by:

getInterceptorRegistry in interface Session

Returns:

the InterceptorRegistry for this session

getName

public String getName()

Description copied from interface: Session

Return the name of this session, if available.

Specified by:

getName in interface Session

Returns:

the name of this session, if available; null otherwise

getScopeName

public String getScopeName()

Description copied from interface: Session

Return the scope name of this cache factory, if available.

Specified by:

getScopeName in interface Session

Returns:

the scope name of this cache factory, if available; null otherwise

isCacheActive

public boolean isCacheActive(String sCacheName,
 ClassLoader loader)

Description copied from interface: Session

Validate whether a cache with the given name is active in the context of the given ClassLoader. The ClassLoader should be the same as provided to a previous call to Session.getCache(String, NamedCache.Option...).

Specified by:

isCacheActive in interface Session

Parameters:

sCacheName - the cache name

loader - the ClassLoader used to originally obtain the cache

Returns:

true if cache is active in context of the provided ClassLoader

isMapActive

public boolean isMapActive(String sMapName,
 ClassLoader loader)

Description copied from interface: Session

Validate whether a map with the given name is active in the context of the given ClassLoader. The ClassLoader should be the same as provided to a previous call to Session.getMap(String, NamedMap.Option...).

Specified by:

isMapActive in interface Session

Parameters:

sMapName - the map name

loader - the ClassLoader used to originally obtain the map

Returns:

true if map is active in context of the provided ClassLoader

isTopicActive

public boolean isTopicActive(String sTopicName,
 ClassLoader loader)

Description copied from interface: Session

Validate whether a topic with the given name is active in the context of the given ClassLoader. The ClassLoader should be the same as provided to a previous call to Session.getTopic(String, NamedTopic.Option...).

Specified by:

isTopicActive in interface Session

Parameters:

sTopicName - the cache name

loader - the ClassLoader used to originally obtain the topic

Returns:

true if topic is active in context of the provided ClassLoader

activate

public void activate()

Description copied from interface: Session

Activate this Session.

Calling this method on an already active Session is a no-op.

Specified by:

activate in interface Session

isActive

public boolean isActive()

Description copied from interface: Session

Return true if this Session is active and has not been closed.

Specified by:

isActive in interface Session

Returns:

true if this Session is active

getService

public Service getService(String sServiceName)

Description copied from interface: Session

Returns a service for the given name or null if no service exists in this session with the specified name.

Specified by:

getService in interface Session

Parameters:

sServiceName - the service name

Returns:

the requested Service or null if no service exists in this session with the specified name