Package com.tangosol.net

Class WrapperSessionConfiguration

java.lang.Object

com.tangosol.net.WrapperSessionConfiguration

All Implemented Interfaces:

SessionConfiguration, Comparable<SessionConfiguration>

public class WrapperSessionConfiguration
extends Object
implements SessionConfiguration

A SessionConfiguration that delegates to another SessionConfiguration.

Since:

22.06.2

Author:

Jonathan Knight 2022.08.25

Nested Class Summary

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

SessionConfiguration.Builder, SessionConfiguration.ConfigurableCacheFactorySessionConfig

Field Summary

Fields inherited from interface com.tangosol.net.SessionConfiguration

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor	Description
WrapperSessionConfiguration(SessionConfiguration delegate)	Create a WrapperSessionConfiguration.

Method Summary

Modifier and Type	Method	Description
int	compareTo(SessionConfiguration other)	Order SessionConfiguration by priority, the lowest priority comes first.
Optional<ClassLoader>	getClassLoader()	Return the optional ClassLoader to use for the session.
Optional<String>	getConfigUri()	Return the optional configuration file URI for a session that wraps a ConfigurableCacheFactory.
Iterable<EventInterceptor<?>>	getInterceptors()	Return the interceptors to add to the session.
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.
Optional<ParameterResolver>	getParameterResolver()	Returns an optional ParameterResolver to use to resolve configuration parameters when creating the session.
int	getPriority()	Returns the priority for this configuration.
String	getScopeName()	Return the scope name of the Session.
boolean	isEnabled()	Return true if this configuration is enabled and should be used to configure a session.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.net.SessionConfiguration

sessionProvider

Constructor Detail

WrapperSessionConfiguration

public WrapperSessionConfiguration(SessionConfiguration delegate)

Create a WrapperSessionConfiguration.

Parameters:

delegate - the SessionConfiguration to delegate to

Throws:

NullPointerException - if the delegate is null

Method Detail

getName

public String getName()

Description copied from interface: SessionConfiguration

Return the name of the Session.

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

A session name must be unique.

Specified by:

getName in interface SessionConfiguration

Returns:

the name of the Session

getScopeName

public String getScopeName()

Description copied from interface: SessionConfiguration

Return the scope name of the Session.

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

Specified by:

getScopeName in interface SessionConfiguration

Returns:

the scope name of the Session

getInterceptors

public Iterable<EventInterceptor<?>> getInterceptors()

Description copied from interface: SessionConfiguration

Return the interceptors to add to the session.

Specified by:

getInterceptors in interface SessionConfiguration

Returns:

the interceptors to add to the session

isEnabled

public boolean isEnabled()

Description copied from interface: SessionConfiguration

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

Specified by:

isEnabled in interface SessionConfiguration

Returns:

true if this configuration is enabled

getConfigUri

public Optional<String> getConfigUri()

Description copied from interface: SessionConfiguration

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

Specified by:

getConfigUri in interface SessionConfiguration

Returns:

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

getClassLoader

public Optional<ClassLoader> getClassLoader()

Description copied from interface: SessionConfiguration

Return the optional ClassLoader to use for the session.

Specified by:

getClassLoader in interface SessionConfiguration

Returns:

the optional ClassLoader to use for the session

getPriority

public int getPriority()

Description copied from interface: SessionConfiguration

Returns the priority for this configuration.

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

The default priority is zero (see SessionConfiguration.DEFAULT_PRIORITY).

Specified by:

getPriority in interface SessionConfiguration

Returns:

the priority for this configuration

compareTo

public int compareTo(SessionConfiguration other)

Description copied from interface: SessionConfiguration

Order SessionConfiguration by priority, the lowest priority comes first.

Specified by:

compareTo in interface Comparable<SessionConfiguration>

Specified by:

compareTo in interface SessionConfiguration

Parameters:

other - the configuration to compare to

Returns:

compare this configuration with the specified configuration ordering by priority

getParameterResolver

public Optional<ParameterResolver> getParameterResolver()

Description copied from interface: SessionConfiguration

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

Specified by:

getParameterResolver in interface SessionConfiguration

Returns:

an optional ParameterResolver to use to resolve configuration parameters

getMode

public Optional<Coherence.Mode> getMode()

Description copied from interface: SessionConfiguration

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

Specified by:

getMode in interface SessionConfiguration

Returns:

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

toString

public String toString()

Overrides:

toString in class Object