org.opensaml.util.storage

クラス MapBasedStorageService<KeyType,ValueType>

java.lang.Object

org.opensaml.util.storage.MapBasedStorageService<KeyType,ValueType>

型パラメータ:

KeyType - object type of the keys

ValueType - object type of the values

すべての実装されたインタフェース:

StorageService<KeyType,ValueType>

public class MapBasedStorageService<KeyType,ValueType>
extends Object
implements StorageService<KeyType,ValueType>

A simple Map based StorageService implementation.

コンストラクタの概要

コンストラクタ

修飾子	コンストラクタと説明
	MapBasedStorageService() Constructor.
protected	MapBasedStorageService(Map<String,Map<KeyType,ValueType>> serviceStore) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
boolean	contains(String partition, KeyType key) Checks if a given key exists.
ValueType	get(String partition, KeyType key) Gets the value stored under a particular key.
Iterator<KeyType>	getKeys(String partition) Gets the keys for entries in the storage service.
Iterator<String>	getPartitions() Gets the partitions within the service.
ValueType	put(String partition, KeyType key, ValueType value) Adds a value, indexed by a key, in to storage.
ValueType	remove(String partition, KeyType key) Removes an item from storage.

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

MapBasedStorageService

public MapBasedStorageService()

Constructor.

MapBasedStorageService

protected MapBasedStorageService(Map<String,Map<KeyType,ValueType>> serviceStore)

Constructor.

パラメータ:

serviceStore - the map to use as storage

メソッドの詳細

getPartitions

public Iterator<String> getPartitions()

Gets the partitions within the service. Removal of a partition identifier from the iterator removes the partition from the storage service.

定義:

getPartitions インタフェース内 StorageService<KeyType,ValueType>

戻り値:

partitions within the service

getKeys

public Iterator<KeyType> getKeys(String partition)

Gets the keys for entries in the storage service. Removal of a key from the iterator removes the the key and associated value from the store. Note: this operation may be very expensive

定義:

getKeys インタフェース内 StorageService<KeyType,ValueType>

パラメータ:

partition - partition on which to operate

戻り値:

list of keys currently within the store

contains

public boolean contains(String partition,
               KeyType key)

Checks if a given key exists.

定義:

contains インタフェース内 StorageService<KeyType,ValueType>

パラメータ:

partition - partition on which to operate

key - the key to check

戻り値:

true of the given key exists, false if not

get

public ValueType get(String partition,
            KeyType key)

Gets the value stored under a particular key.

定義:

get インタフェース内 StorageService<KeyType,ValueType>

パラメータ:

partition - partition on which to operate

key - the key

戻り値:

the value for that key, or null if there is no value for the given key

put

public ValueType put(String partition,
            KeyType key,
            ValueType value)

Adds a value, indexed by a key, in to storage. Note that implementations of this service may determine, on its own, when to evict items from storage, the expiration time given here is meant only as a system provided hint.

定義:

put インタフェース内 StorageService<KeyType,ValueType>

パラメータ:

partition - partition on which to operate

key - the key

value - the value

戻り値:

the value that was registered under that key previously, if there was a previous value

remove

public ValueType remove(String partition,
               KeyType key)

Removes an item from storage.

定義:

remove インタフェース内 StorageService<KeyType,ValueType>

パラメータ:

partition - partition on which to operate

key - the key to the value to remove

戻り値:

the value that was removed