org.opensaml.core.xml.persist

Class MapLoadSaveManager<T extends XMLObject>

java.lang.Object

org.opensaml.core.xml.persist.MapLoadSaveManager<T>

Type Parameters:

T - the specific base XML object type being managed

All Implemented Interfaces:

XMLObjectLoadSaveManager<T>

@NotThreadSafe
public class MapLoadSaveManager<T extends XMLObject>
extends Object
implements XMLObjectLoadSaveManager<T>

Simple implementation of XMLObjectLoadSaveManager which uses an in-memory map.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,T>	backingMap The backing map.

Constructor Summary

Constructors

Constructor and Description
MapLoadSaveManager() Constructor.
MapLoadSaveManager(Map<String,T> map) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	exists(String key) Evaluate whether an object already exists indexed by the supplied key.
Iterable<Pair<String,T>>	listAll() Return an iterable of all objects under management, along with their associated index key.
Set<String>	listKeys() Return a set of the index keys of all objects under management.
T	load(String key) Load a particular object based on the supplied key.
boolean	remove(String key) Remove the object indexed by the specified key.
void	save(String key, T xmlObject) Save a particular object, indexed by the supplied key.
void	save(String key, T xmlObject, boolean overwrite) Save a particular object, indexed by the supplied key.
boolean	updateKey(String currentKey, String newKey) Update the key under which a particular object is stored.

Methods inherited from class java.lang.Object

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

Field Detail

backingMap

private Map<String,T extends XMLObject> backingMap

The backing map.

Constructor Detail

MapLoadSaveManager

public MapLoadSaveManager()

Constructor.

MapLoadSaveManager

public MapLoadSaveManager(@Nonnull
                          Map<String,T> map)

Constructor.

Parameters:

map - the backing map

Method Detail

listKeys

public Set<String> listKeys()
                     throws IOException

Return a set of the index keys of all objects under management.

Specified by:

listKeys in interface XMLObjectLoadSaveManager<T extends XMLObject>

Returns:

a set of all indexed keys

Throws:

IOException - if there is a fatal error obtaining the keys

listAll

public Iterable<Pair<String,T>> listAll()
                                 throws IOException

Return an iterable of all objects under management, along with their associated index key.

Specified by:

listAll in interface XMLObjectLoadSaveManager<T extends XMLObject>

Returns:

an iterable of all managed objects

Throws:

IOException - if there is a fatal error loading the managed objects

exists

public boolean exists(String key)
               throws IOException

Evaluate whether an object already exists indexed by the supplied key.

Specified by:

exists in interface XMLObjectLoadSaveManager<T extends XMLObject>

Parameters:

key - the key of the desired object

Returns:

true if object exists, false otherwise

Throws:

IOException - if there is a fatal error evaluating object existence

load

public T load(String key)
       throws IOException

Load a particular object based on the supplied key.

Specified by:

load in interface XMLObjectLoadSaveManager<T extends XMLObject>

Parameters:

key - the key of the desired object

Returns:

the object saved under the specified key, or null if there is no such object

Throws:

IOException - if there is a fatal error loading the object

save

public void save(String key,
                 T xmlObject)
          throws IOException

Save a particular object, indexed by the supplied key.

An existing object indexed by the supplied key will not be overwritten. Instead an IOException will be thrown. For saving with the overwrite option, see XMLObjectLoadSaveManager.save(String, XMLObject, boolean).

Specified by:

save in interface XMLObjectLoadSaveManager<T extends XMLObject>

Parameters:

key - the key under which to index the object

xmlObject - the object to save

Throws:

IOException - if there is a fatal error saving the object, or if an object already exists indexed by the supplied key

save

public void save(String key,
                 T xmlObject,
                 boolean overwrite)
          throws IOException

Save a particular object, indexed by the supplied key.

Specified by:

save in interface XMLObjectLoadSaveManager<T extends XMLObject>

Parameters:

key - the key under which to index the object

xmlObject - the object to save

overwrite - whether or not to overwrite any existing object indexed by the supplied key

Throws:

IOException - if there is a fatal error saving the object, or if overwrite=false, if an object already exists indexed by the supplied key

remove

public boolean remove(String key)
               throws IOException

Remove the object indexed by the specified key.

Specified by:

remove in interface XMLObjectLoadSaveManager<T extends XMLObject>

Parameters:

key - the key of the object to remove

Returns:

true if the object was found and successfully removed, false if no such object was found

Throws:

IOException - if there was a fatal error removing the object

updateKey

public boolean updateKey(String currentKey,
                         String newKey)
                  throws IOException

Update the key under which a particular object is stored.

Specified by:

updateKey in interface XMLObjectLoadSaveManager<T extends XMLObject>

Parameters:

currentKey - the current key under which the object is stored

newKey - the new key under which the object should be stored

Returns:

true if the object was found under the current key and the key successfully updated, false if no such object was found

Throws:

IOException - if there was a fatal error updating the key