Package com.tangosol.net

Interface SessionConfiguration

All Superinterfaces:

Comparable<SessionConfiguration>

All Known Subinterfaces:

SessionInitializer

All Known Implementing Classes:

SessionConfiguration.ConfigurableCacheFactorySessionConfig, WrapperSessionConfiguration

public interface SessionConfiguration
extends Comparable<SessionConfiguration>

A class that can provide the configuration options for a Session.

Since:

20.12

Author:

Jonathan Knight 2020.11.03

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SessionConfiguration.Builder	A builder to build a SessionConfiguration.ConfigurableCacheFactorySessionConfig.
static class	SessionConfiguration.ConfigurableCacheFactorySessionConfig	An immutable SessionConfiguration to configure a Session that wraps an underlying ConfigurableCacheFactory.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PRIORITY	The default priority for a configuration.

Method Summary

Modifier and Type	Method	Description
static SessionConfiguration.Builder	builder()	Create a SessionConfiguration builder.
default int	compareTo(SessionConfiguration other)	Order SessionConfiguration by priority, the lowest priority comes first.
static SessionConfiguration	create(String sConfigURI)	Create a SessionConfiguration for the default Session with the specified configuration file.
static SessionConfiguration	create(String sName, String sConfigURI)	Create a SessionConfiguration for a Session with a specific name and configuration file.
static SessionConfiguration	create(String sName, String sConfigURI, String sScopeName)	Create a SessionConfiguration for a Session with a specific name and configuration file.
static SessionConfiguration	defaultSession()	Create a SessionConfiguration for the default Session.
default Optional<ClassLoader>	getClassLoader()	Return the optional ClassLoader to use for the session.
default Optional<String>	getConfigUri()	Return the optional configuration file URI for a session that wraps a ConfigurableCacheFactory.
default Iterable<EventInterceptor<?>>	getInterceptors()	Return the interceptors to add to the session.
default Optional<Coherence.Mode>	getMode()	Return an optional Coherence.Mode that the session should use to set the coherence.client property.
String	getName()	Return the name of the Session.
default Optional<ParameterResolver>	getParameterResolver()	Returns an optional ParameterResolver to use to resolve configuration parameters when creating the session.
default int	getPriority()	Returns the priority for this configuration.
String	getScopeName()	Return the scope name of the Session.
default boolean	isEnabled()	Return true if this configuration is enabled and should be used to configure a session.
default Optional<SessionProvider>	sessionProvider()	Return the SessionProvider to use to create a session.

Field Details

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

The default priority for a configuration.

See Also:

• getPriority()
• Constant Field Values

Method Details

getName

String getName()

Return the name of the Session.

If not specifically set the Coherence.DEFAULT_NAME will be used.

A session name must be unique.

Returns:

the name of the Session

getScopeName

String getScopeName()

Return the scope name of the Session.

If not specifically set, the name will default to the getName() value. If the getName() is Coherence.DEFAULT_NAME no scope will be used.

Returns:

the scope name of the Session

getInterceptors

default Iterable<EventInterceptor<?>> getInterceptors()

Return the interceptors to add to the session.

Returns:

the interceptors to add to the session

isEnabled

default boolean isEnabled()

Return true if this configuration is enabled and should be used to configure a session.

Returns:

true if this configuration is enabled

getConfigUri

default Optional<String> getConfigUri()

Return the optional configuration file URI for a session that wraps a ConfigurableCacheFactory.

Returns:

the optional configuration file URI for a session that wraps a ConfigurableCacheFactory

getClassLoader

default Optional<ClassLoader> getClassLoader()

Return the optional ClassLoader to use for the session.

Returns:

the optional ClassLoader to use for the session

getPriority

default int getPriority()

Returns the priority for this configuration.

Sessions will be created in priority order, the highest priority first.

The default priority is zero (see DEFAULT_PRIORITY).

Returns:

the priority for this configuration

compareTo

default int compareTo(SessionConfiguration other)

Order SessionConfiguration by priority, the lowest priority comes first.

Specified by:

compareTo in interface Comparable<SessionConfiguration>

Parameters:

other - the configuration to compare to

Returns:

compare this configuration with the specified configuration ordering by priority

getParameterResolver

default Optional<ParameterResolver> getParameterResolver()

Returns an optional ParameterResolver to use to resolve configuration parameters when creating the session.

Returns:

an optional ParameterResolver to use to resolve configuration parameters

getMode

default Optional<Coherence.Mode> getMode()

Return an optional Coherence.Mode that the session should use to set the coherence.client property.

Returns:

an optional Coherence.Mode that the session should use to set the coherence.client property

sessionProvider

default Optional<SessionProvider> sessionProvider()

Return the SessionProvider to use to create a session.

Returns:

the SessionProvider to use to create a session

builder

static SessionConfiguration.Builder builder()

Create a SessionConfiguration builder.

Returns:

a SessionConfiguration builder

defaultSession

static SessionConfiguration defaultSession()

Create a SessionConfiguration for the default Session.

The default session will wrap a ConfigurableCacheFactory that is configured from the default cache configuration file.

The default session will have a name Coherence.DEFAULT_NAME and the default scope name Coherence.DEFAULT_SCOPE.

Returns:

a SessionConfiguration for the default Session

create

static SessionConfiguration create(String sConfigURI)

Create a SessionConfiguration for the default Session with the specified configuration file.

The default session will wrap a ConfigurableCacheFactory that is configured from the default cache configuration file.

The default session will have a name Coherence.DEFAULT_NAME and the default scope name Coherence.DEFAULT_SCOPE.

Parameters:

sConfigURI - the location of the configuration file to use

Returns:

a SessionConfiguration for the default Session

create

static SessionConfiguration create(String sName,
 String sConfigURI)

Create a SessionConfiguration for a Session with a specific name and configuration file.

The session will have a scope name Coherence.DEFAULT_SCOPE.

Parameters:

sName - the name of the session

sConfigURI - the location of the configuration file to use

Returns:

a SessionConfiguration

create

static SessionConfiguration create(String sName,
 String sConfigURI,
 String sScopeName)

Create a SessionConfiguration for a Session with a specific name and configuration file.

Parameters:

sName - the name of the session

sConfigURI - the location of the configuration file to use

sScopeName - the scope name to use for the session

Returns:

a SessionConfiguration