edu.uiuc.ncsa.security.core

Interface Store<V extends Identifiable>

All Superinterfaces:

Map<Identifier,V>

All Known Subinterfaces:

AdminClientStore<V>, AssetStore, BaseClientStore<V>, ClientApprovalStore<V>, ClientStore<V>, JSONStore<V>, PermissionsStore<V>, RefreshTokenStore<V>, TransactionStore<V>, UsernameFindable<V>

All Known Implementing Classes:

AdminClientFS, AdminClientMemoryStore, AdminClientSQLStore, AggregateCAStore, AggregateClientStore, edu.uiuc.ncsa.security.storage.AggregateStore, AggregateTransactionStore, CachedMapFacade, ClientApprovalMemoryStore, ClientMemoryStore, DSFSClientApprovalStore, DSFSClientStore, DSFSTransactionStore, DSSQLTransactionStore, edu.uiuc.ncsa.security.storage.FileStore, FSAssetStore, FSClientApprovalStore, FSClientStore, FSTransactionStore, edu.uiuc.ncsa.security.storage.IndexedStreamStore, JSONFileStore, JSONSQLStore, JSONStoreProviders.JSONMemoryStore, MemoryAssetStore, MemoryPermissionStore, edu.uiuc.ncsa.security.storage.MemoryStore, OA2ClientMemoryStore, OA2FSTStore, OA2MTStore, OA2SQLTStore, PermissionFileStore, Procedure.JM, SQLAssetStore, SQLBaseTransactionStore, SQLClientApprovalStore, SQLClientStore, SQLPermissionStore, SQLServiceTransactionStore, edu.uiuc.ncsa.security.storage.sql.SQLStore, TestMemStore, TransactionCache, TransactionMemoryStore

public interface Store<V extends Identifiable>
extends Map<Identifier,V>

Interface for stores. This models a specific case, where there is a primary key, so that this is logically also a map. Each row corresponds to (usually) one java object. What the map interface lacks is concepts for CRUD (create, retrieve, update, delete) and this interface adds those.

Usage

A very large number of practical database programming issues fall into this case and the interfaces and basic classes in this package make setting up and managing them extremely simple.

Created by Jeff Gaynor
on Mar 12, 2010 at 10:21:39 AM

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
V	create() Create a new object of the given type.
List<V>	getAll() Method to get every element in the store.
XMLConverter<V>	getXMLConverter()
void	register(V value) Almost Identical to put(K,V) but since the object should have an identifier, passing along the key is redundant.
void	save(V value) Saves an object.
List<V>	search(String key, String condition, boolean isRegEx) Allows for searching via a reg ex.
void	update(V value) Update an existing object.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

create

V create()

Create a new object of the given type. This is not in the store until it is registered. Attempts to update the object should throw an exception. Note that this allows for a separation of creation semantics. Some objects require specific initialization before saving

Returns:

update

void update(V value)

Update an existing object.

Parameters:

value -

register

void register(V value)

Almost Identical to put(K,V) but since the object should have an identifier, passing along the key is redundant. This persists the object in the store. Note that this returns void since the contract assumes that this is not registered. If the object is registered an exception should be thrown. Generally use save(V).

Parameters:

value -

save

void save(V value)

Saves an object. This bridges the gap between SQL stores update and insert commands. Implementations should check if the object already exists in the store and issue an appropriate call.

Parameters:

value -

getAll

List<V> getAll()

Method to get every element in the store. This is useful for command line interfaces. Note that this might be very expensive.

Returns:

getXMLConverter

XMLConverter<V> getXMLConverter()

search

List<V> search(String key,
               String condition,
               boolean isRegEx)

Allows for searching via a reg ex. Note that this may be very expensive for certain stores!

Parameters:

key -

condition -

isRegEx -

Returns: