org.opensaml.util.storage

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

型パラメータ:

KeyType - object type of the keys

ValueType - object type of the values

既知の実装クラスのリスト:

EventingMapBasedStorageService, MapBasedStorageService

public interface StorageService<KeyType,ValueType>

Generic data storage facility for use by services that require some degree of persistence. The storage service is partitioned. This is to allow different objects to use the service, each with its own partition, without the worry of conflicting keys.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
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.

メソッドの詳細

contains

boolean contains(String partition,
               KeyType key)

Checks if a given key exists.

パラメータ:

partition - partition on which to operate

key - the key to check

戻り値:

true of the given key exists, false if not

getPartitions

Iterator<String> getPartitions()

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

戻り値:

partitions within the service

getKeys

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

パラメータ:

partition - partition on which to operate

戻り値:

list of keys currently within the store

get

ValueType get(String partition,
            KeyType key)

Gets the value stored under a particular key.

パラメータ:

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

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.

パラメータ:

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

ValueType remove(String partition,
               KeyType key)

Removes an item from storage.

パラメータ:

partition - partition on which to operate

key - the key to the value to remove

戻り値:

the value that was removed