Interface UserFactory<CV,C,T,SV,D,S>

Type Parameters:

CV - the user context value type

C - the persistent context type

T - the transient context type

SV - the user sessions value type

D - the deployment type

S - the session type

All Superinterfaces:

BiCacheEntryCreator<String,CV,SV,C>, BiCacheEntryLocator<String,CV,SV>, CacheEntryCreator<String, Map.Entry<CV,SV>, C>, CacheEntryLocator<String, Map.Entry<CV,SV>>, CacheEntryRemover<String>

All Known Implementing Classes:

CompositeUserFactory

public interface UserFactory<CV,C,T,SV,D,S>
extends BiCacheEntryCreator<String,CV,SV,C>, BiCacheEntryLocator<String,CV,SV>, CacheEntryRemover<String>

Creates an User composed from a UserContextFactory and UserSessionsFactory.

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method	Description
default Map.Entry<CompletionStage<CV>, CompletionStage<SV>>	createEntry(String id, C context)	Creates a value in the cache, if it does not already exist.
User<C,T,D,S>	createUser(String id, Map.Entry<CV,SV> value)	Creates a user from its composing cache entries.
default Map.Entry<CompletionStage<CV>, CompletionStage<SV>>	findEntry(String id)	Locates the value in the cache with the specified identifier.
CacheProperties	getCacheProperties()	Returns the properties of the cache.
UserContextFactory<CV,C,T>	getUserContextFactory()	Returns the user context factory.
UserSessionsFactory<SV,D,S>	getUserSessionsFactory()	Returns the user sessions factory.
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.
default Map.Entry<CompletionStage<CV>, CompletionStage<SV>>	tryEntry(String id)	Locates the value in the cache with the specified identifier, if available.

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

Method Details

getUserContextFactory

UserContextFactory<CV,C,T> getUserContextFactory()

Returns the user context factory.

Returns:

the user context factory.

getUserSessionsFactory

UserSessionsFactory<SV,D,S> getUserSessionsFactory()

Returns the user sessions factory.

Returns:

the user sessions factory.

getCacheProperties

CacheProperties getCacheProperties()

Returns the properties of the cache.

Returns:

the properties of the cache.

createUser

User<C,T,D,S> createUser(String id,
 Map.Entry<CV,SV> value)

Creates a user from its composing cache entries.

Parameters:

id - the identifier of the user

value - a tuple of cache values.

Returns:

a user

createEntry

default Map.Entry<CompletionStage<CV>, CompletionStage<SV>> createEntry(String id,
 C context)

Description copied from interface: BiCacheEntryCreator

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

Specified by:

createEntry in interface BiCacheEntryCreator<CV,C,T,SV>

Parameters:

id - the cache entry identifier.

context - the creation context

Returns:

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

findEntry

default Map.Entry<CompletionStage<CV>, CompletionStage<SV>> findEntry(String id)

Description copied from interface: BiCacheEntryLocator

Locates the value in the cache with the specified identifier.

Specified by:

findEntry in interface BiCacheEntryLocator<CV,C,T>

Parameters:

id - the cache entry identifier

Returns:

the value of the cache entry, or null if not found.

tryEntry

default Map.Entry<CompletionStage<CV>, CompletionStage<SV>> tryEntry(String id)

Description copied from interface: BiCacheEntryLocator

Locates the value in the cache with the specified identifier, if available.

Specified by:

tryEntry in interface BiCacheEntryLocator<CV,C,T>

Parameters:

id - the cache entry identifier

Returns:

the value of the cache entry, or null if not found or is in use.

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<CV>

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<CV>

Parameters:

id - the cache entry identifier.

Returns:

true, if the entry was removed.