Package com.oracle.coherence.cdi

Interface SessionInitializer

All Superinterfaces:

Comparable<SessionConfiguration>, SessionConfiguration

public interface SessionInitializer
extends SessionConfiguration

An interface that should be implemented by custom Coherence scoped session configurations in order to enable their discovery and automatic initialization at startup.

Each class implementing this interface must be annotated with @Named annotation representing the name of the scope being initialized, and can optionally be annotated with @ConfigUri annotation if a non-default configuration resource should be used.

If annotated with the @Scope annotation the scope value will be used for the session scope, otherwise the session name will also be used as the scope.

Since:

20.06

Author:

Aleks Seovic 2020.06.15

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

Method Summary

Modifier and Type	Method	Description
default Optional<String>	getConfigUri()	Return the optional configuration file URI for a session that wraps a ConfigurableCacheFactory.
default String	getName()	Return the name of the Session.
default int	getPriority()	Returns the priority for this configuration.
default String	getScopeName()	Return the scope name of the Session.

Methods inherited from interface com.tangosol.net.SessionConfiguration

compareTo, getClassLoader, getInterceptors, getMode, getParameterResolver, isEnabled, sessionProvider

Method Details

getName

default 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

default 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

getPriority

default 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

getConfigUri

default 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