Interface SessionFactory<DC,MV,AV,SC>

Type Parameters:

DC - the deployment context type

MV - the meta-data value type

AV - the attributes value type

SC - the session context type

All Superinterfaces:

AutoCloseable, BiCacheEntryCreator<String, MV, AV, Map.Entry<Instant, Optional<Duration>>>, BiCacheEntryLocator<String,MV,AV>, CacheEntryCreator<String, Map.Entry<MV,AV>, Map.Entry<Instant, Optional<Duration>>>, CacheEntryLocator<String, Map.Entry<MV,AV>>, CacheEntryRemover<String>, ImmutableSessionFactory<MV,AV>, ImmutableSessionFactoryConfiguration<MV,AV>, SessionFactoryConfiguration<DC,MV,AV,SC>

All Known Implementing Classes:

CompositeSessionFactory, HotRodSessionFactory

public interface SessionFactory<DC,MV,AV,SC>
extends ImmutableSessionFactory<MV,AV>, SessionFactoryConfiguration<DC,MV,AV,SC>, BiCacheEntryCreator<String, MV, AV, Map.Entry<Instant, Optional<Duration>>>, CacheEntryRemover<String>, AutoCloseable

Factory for creating sessions. Encapsulates the cache mapping strategy for sessions.

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method	Description
default void	close()
default Map.Entry<CompletionStage<MV>, CompletionStage<AV>>	createEntry(String id, Map.Entry<Instant, Optional<Duration>> context)	Creates a value in the cache, if it does not already exist.
Session<SC>	createSession(String id, Map.Entry<MV,AV> entry, DC context)	Creates a session from the specified identifier, metadata, attributes, and context.
default CompletionStage<Void>	purgeAsync(String id)	Removes the specified entry from the cache.
default CompletionStage<Void>	removeAsync(String id)	Removes the specified entry from the cache.

Methods inherited from interface BiCacheEntryCreator

createValueAsync

Methods inherited from interface BiCacheEntryLocator

findValueAsync, tryValueAsync

Methods inherited from interface CacheEntryCreator

createValue

Methods inherited from interface CacheEntryLocator

findValue, tryValue

Methods inherited from interface CacheEntryRemover

purge, remove

Methods inherited from interface ImmutableSessionFactory

createImmutableSession, createImmutableSession, findEntry, tryEntry

Methods inherited from interface ImmutableSessionFactoryConfiguration

getCacheProperties

Methods inherited from interface SessionFactoryConfiguration

getSessionAttributesFactory, getSessionContextFactory, getSessionMetaDataFactory

Method Details

createEntry

default Map.Entry<CompletionStage<MV>, CompletionStage<AV>> createEntry(String id,
 Map.Entry<Instant, Optional<Duration>> context)

Description copied from interface: BiCacheEntryCreator

Creates a value in the cache, if it does not already exist.

Specified by:

createEntry in interface BiCacheEntryCreator<DC,MV,AV,SC>

Parameters:

id - the cache entry identifier.

context - the creation context

Returns:

the new value, or the existing value the cache entry already exists.

removeAsync

default CompletionStage<Void> removeAsync(String id)

Description copied from interface: CacheEntryRemover

Removes the specified entry from the cache.

Specified by:

removeAsync in interface CacheEntryRemover<DC>

Parameters:

id - the cache entry identifier.

Returns:

true, if the entry was removed.

purgeAsync

default CompletionStage<Void> purgeAsync(String id)

Description copied from interface: CacheEntryRemover

Removes the specified entry from the cache.

Specified by:

purgeAsync in interface CacheEntryRemover<DC>

Parameters:

id - the cache entry identifier.

Returns:

true, if the entry was removed.

createSession

Session<SC> createSession(String id,
 Map.Entry<MV,AV> entry,
 DC context)

Creates a session from the specified identifier, metadata, attributes, and context.

Parameters:

id - a session identifier

entry - a map entry containing the metadata and attributes of the session

context - the session context

Returns:

a session from the specified identifier, metadata, attributes, and context.

close

default void close()

Specified by:

close in interface AutoCloseable