Package com.tangosol.net

Interface SessionProvider

All Superinterfaces:

Comparable<SessionProvider>

All Known Subinterfaces:

CacheFactoryBuilder

All Known Implementing Classes:

ContainerAdapter.ContainerCacheFactoryBuilder, DefaultCacheFactoryBuilder, com.tangosol.internal.net.DefaultSessionProvider, ScopedCacheFactoryBuilder, SessionProvider.Providers, SingletonCacheFactoryBuilder

public interface SessionProvider
extends Comparable<SessionProvider>

Creates Sessions for use by applications requiring Coherence-based resources, including NamedCaches, often for specific ClassLoaders, for deployed modules.

Author:

bo 2015.07.27

See Also:

• Session

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SessionProvider.Context	A context used by providers.
static class	SessionProvider.DefaultContext
static interface	SessionProvider.Option	Deprecated. since 20.12 use SessionConfiguration and createSession(SessionConfiguration, Coherence.Mode, Iterable)
static interface	SessionProvider.Provider	Implemented by suppliers of a SessionProvider.
static class	SessionProvider.Providers	Deprecated. since 20.12 there is no replacement for this class

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PRIORITY	The default priority for providers.

Method Summary

Modifier and Type	Method	Description
default void	close()	Optionally close all of the Session instances provided by this SessionProvider.
default int	compareTo(SessionProvider other)
default Session	createSession(Session.Option... options)	Deprecated. since 20.12 - use createSession(SessionConfiguration, Coherence.Mode, Iterable)
default Optional<Session>	createSession(SessionConfiguration configuration, Coherence.Mode mode)	Create a Session from the specified configuration.
default Optional<Session>	createSession(SessionConfiguration configuration, Coherence.Mode defaultMode, Iterable<? extends EventInterceptor<?>> interceptors)	Create a Session from the specified configuration.
default Optional<Session>	createSession(SessionConfiguration configuration, Coherence.Mode defaultMode, String sScopePrefix, Iterable<? extends EventInterceptor<?>> interceptors)	Create a Session from the specified configuration.
SessionProvider.Context	createSession(SessionConfiguration configuration, SessionProvider.Context context)	Create a Session from the specified configuration.
static SessionProvider	get()	Acquire the SessionProvider to use to create sessions.
static SessionProvider	get(SessionProvider.Option... options)	Deprecated. since 20.12 SessionProvider.Option is deprecated use get()
default int	getPriority()	Obtain the priority that this SessionProvider should have over other SessionProviders when multiple providers may be able to provide a Session.
default void	releaseSession(Session session)	Release the Session.

Field Details

PRIORITY

static final int PRIORITY

The default priority for providers.

See Also:

• Constant Field Values

Method Details

createSession

default Optional<Session> createSession(SessionConfiguration configuration,
 Coherence.Mode mode)

Create a Session from the specified configuration.

Parameters:

configuration - the configuration to use to create the session

mode - the current Coherence.Mode

Returns:

an Optional containing a Session or an empty Optional if this provider cannot supply a Session from the specified configuration

createSession

default Optional<Session> createSession(SessionConfiguration configuration,
 Coherence.Mode defaultMode,
 Iterable<? extends EventInterceptor<?>> interceptors)

Create a Session from the specified configuration.

Parameters:

configuration - the configuration to use to create the session

defaultMode - the Coherence.Mode the session should use if not specified in the SessionConfiguration

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

Returns:

an Optional containing a Session or an empty Optional if this provider cannot supply a Session from the specified configuration

createSession

default Optional<Session> createSession(SessionConfiguration configuration,
 Coherence.Mode defaultMode,
 String sScopePrefix,
 Iterable<? extends EventInterceptor<?>> interceptors)

Create a Session from the specified configuration.

Parameters:

configuration - the configuration to use to create the session

defaultMode - the Coherence.Mode the session should use if not specified in the SessionConfiguration

sScopePrefix - the prefix to prepend to the session scope

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

Returns:

an Optional containing a Session or an empty Optional if this provider cannot supply a Session from the specified configuration

createSession

SessionProvider.Context createSession(SessionConfiguration configuration,
 SessionProvider.Context context)

Create a Session from the specified configuration.

The return value is a SessionProvider.Context that may be the same context passed in. If the provider could create a Session the context will be completed and contain a session. If the provider cannot create a session the context will not be completed. If the provider could not create a session and no other providers should be tried then the result context will be completed without a session.

Parameters:

configuration - the configuration to use to create the session

context - the SessionProvider.Context to use when creating the session

Returns:

the resulting SessionProvider.Context either not completed, completed with a Session or completed empty.

createSession

@Deprecated
default Session createSession(Session.Option... options)

Deprecated.

since 20.12 - use createSession(SessionConfiguration, Coherence.Mode, Iterable)

Create a Session using the specified SessionProvider.Options.

Parameters:

options - the Session.Options for creating the Session

Returns:

a new Session or null if this provider cannot supply a Session from the specified options

Throws:

IllegalArgumentException - when a Session can't be creating using the specified SessionProvider.Option.

getPriority

default int getPriority()

Obtain the priority that this SessionProvider should have over other SessionProviders when multiple providers may be able to provide a Session.

Higher values are higher precedence.

Returns:

this SessionProvider's priority.

close

default void close()

Optionally close all of the Session instances provided by this SessionProvider.

This allows providers where sessions consume external resources, such as remote connections, to clean up.

compareTo

default int compareTo(SessionProvider other)

Specified by:

compareTo in interface Comparable<SessionProvider>

releaseSession

default void releaseSession(Session session)

Release the Session.

Parameters:

session - the Session to release

get

@Deprecated
static SessionProvider get(SessionProvider.Option... options)

Deprecated.

since 20.12 SessionProvider.Option is deprecated use get()

Acquire the SessionProvider based on the current calling context and the provided SessionProvider.Options.

Parameters:

options - the SessionProvider.Options for acquiring the SessionProvider

Returns:

a SessionProvider

Throws:

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

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

get

static SessionProvider get()

Acquire the SessionProvider to use to create sessions.

Returns:

a SessionProvider