Package org.opensaml.storage.impl.client

Class ClientStorageService.ClientStorageServiceStore

java.lang.Object

org.opensaml.storage.impl.client.ClientStorageService.ClientStorageServiceStore

Enclosing class:

ClientStorageService

public class ClientStorageService.ClientStorageServiceStore
extends Object

Implements a session-bound backing store and locking mechanism for the ClientStorageService.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,Map<String,MutableStorageRecord<?>>>	contextMap	The underlying map of data records.
private boolean	dirty	Dirty bit.
private ClientStorageService.ClientStorageSource	source	Data source.

Constructor Summary

Constructors

Constructor	Description
ClientStorageServiceStore(String raw, ClientStorageService.ClientStorageSource src)	Reconstitute stored data.

Method Summary

Modifier and Type	Method	Description
(package private) Map<String,Map<String,MutableStorageRecord<?>>>	getContextMap()	Get the map of contexts to manipulate during operations.
ClientStorageService.ClientStorageSource	getSource()	Get the data source.
(package private) boolean	isDirty()	Get the dirty bit for the current data.
(package private) ClientStorageServiceOperation	save()	Serialize current state of stored data into a storage operation.
(package private) void	setDirty(boolean flag)	Set the dirty bit for the current data.

Methods inherited from class java.lang.Object

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

Field Detail

contextMap

@Nonnull
@NonnullElements
private final Map<String,Map<String,MutableStorageRecord<?>>> contextMap

The underlying map of data records.

source

@Nonnull
private final ClientStorageService.ClientStorageSource source

Data source.

dirty

private boolean dirty

Dirty bit.

Constructor Detail

ClientStorageServiceStore

ClientStorageServiceStore(@Nullable @NotEmpty
                          String raw,
                          @Nonnull
                          ClientStorageService.ClientStorageSource src)

Reconstitute stored data.

The dirty bit is set based on the result. If successful, the bit is cleared, but if an error occurs, it will be set.

Parameters:

raw - serialized data to load

src - data source

Method Detail

getContextMap

@Nonnull
@NonnullElements
@Live
Map<String,Map<String,MutableStorageRecord<?>>> getContextMap()

Get the map of contexts to manipulate during operations.

Returns:

map of contexts to manipulate

getSource

@Nonnull
public ClientStorageService.ClientStorageSource getSource()

Get the data source.

Returns:

data source

isDirty

boolean isDirty()

Get the dirty bit for the current data.

Returns:

status of dirty bit

setDirty

void setDirty(boolean flag)

Set the dirty bit for the current data.

Parameters:

flag - dirty bit to set

save

@Nullable
ClientStorageServiceOperation save()
                            throws IOException

Serialize current state of stored data into a storage operation.

Returns:

the operation, or a null if the data has not been modified since loading or saving

Throws:

IOException - if an error occurs