com.tangosol.net

Interface Session

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

CoherenceSession

public interface Session
extends AutoCloseable

A thread-safe mechanism to request Coherence-based resources, like NamedCaches, from a deployed module.

Resources provided by a Session are scoped to the Session. When a Session is closed, all resources are closed. Once closed, references to resources are no longer valid. Any attempt to use a closed Session or closed resource may throw an IllegalStateException.

The effect of closing a resource is specific to the type of resource. For example, resources provided by a Session may represent shared (ie: clustered) data-structures and services. In such circumstances, closing these resources only closes the Session-based representation, not the underlying shared infrastructure, which may remain active for other Sessions. Future requests of a Session for previously closed resources of this kind will likely yield a new reference to logically the same underlying resource. To destroy such resources, instead of close, resource-specific methods should be used.

Applications making use of Sessions are expected to maintain their own references to Sessions. Coherence provides no mechanism to identify and obtain previously created Sessions. Furthermore, applications are expected to correctly close Sessions when they are no longer required.

Author:

bo 2015.07.27

See Also:

SessionProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Session.Option An immutable option for creating and configuring Sessions.

Method Summary

Modifier and Type	Method and Description
static Session	create(Session.Option... options) Create a Session based on the current calling context and provided Session.Options, using the default (auto-detected) SessionProvider,
<K,V> NamedCache<K,V>	getCache(String sName, NamedCache.Option... options) Acquire a NamedCache using the specified NamedCache.Options, for example a TypeAssertion.
<V> NamedTopic<V>	getTopic(String sName, NamedCollection.Option... options) Acquire a NamedTopic using the specified ValueTypeAssertion.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getCache

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

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

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 NamedCache.Options

Returns:

a NamedCache

getTopic

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

Acquire a NamedTopic using the specified ValueTypeAssertion.

Type Parameters:

V - the type of elements for the NamedTopic

Parameters:

sName - the name of the NamedTopic

Returns:

a NamedCache

Since:

Coherence 14.1.1

create

static Session create(Session.Option... options)
               throws IllegalArgumentException,
                      IllegalStateException

Create a Session based on the current calling context and provided Session.Options, using the default (auto-detected) SessionProvider,

Parameters:

options - the Session.Options for the Session

Returns:

a Session

Throws:

IllegalArgumentException - when a Session or SessionProvider can't be acquired using the specified Session.Options

IllegalStateException - when a SessionProvider can't be auto-detected

See Also:

SessionProvider#createSession(Option...)