org.finra.herd.service

Interface StorageService

All Known Implementing Classes:

StorageServiceImpl

public interface StorageService

The storage service.

Method Summary

Modifier and Type	Method and Description
Storage	createStorage(StorageCreateRequest storageCreateRequest) Creates a new storage.
Storage	deleteStorage(StorageKey storageKey) Deletes an existing storage by storage key.
StorageKeys	getAllStorage() Gets a list of storage keys for all storage defined in the system.
Storage	getStorage(StorageKey storageKey) Gets an existing storage by storage key.
Storage	updateStorage(StorageKey storageKey, StorageUpdateRequest storageUpdateRequest) Updates an existing storage by storage key.
Storage	updateStorageAttributes(StorageKey storageKey, StorageAttributesUpdateRequest storageAttributesUpdateRequest) Updates an existing storage attributes by storage key.

Method Detail

createStorage

Storage createStorage(StorageCreateRequest storageCreateRequest)

Creates a new storage.

Parameters:

storageCreateRequest - the information needed to create storage

Returns:

the created storage information

deleteStorage

Storage deleteStorage(StorageKey storageKey)

Deletes an existing storage by storage key.

Parameters:

storageKey - the storage key (case-insensitive)

Returns:

the storage information of the storage that got deleted

getAllStorage

StorageKeys getAllStorage()

Gets a list of storage keys for all storage defined in the system.

Returns:

the list of storage keys

getStorage

Storage getStorage(StorageKey storageKey)

Gets an existing storage by storage key.

Parameters:

storageKey - the storage key (case-insensitive)

Returns:

the storage information

updateStorage

Storage updateStorage(StorageKey storageKey,
                      StorageUpdateRequest storageUpdateRequest)

Updates an existing storage by storage key.

Parameters:

storageKey - the storage key (case-insensitive)

storageUpdateRequest - the information needed to update the storage

Returns:

the updated storage information

updateStorageAttributes

Storage updateStorageAttributes(StorageKey storageKey,
                                StorageAttributesUpdateRequest storageAttributesUpdateRequest)

Updates an existing storage attributes by storage key.

Parameters:

storageKey - the storage key (case-insensitive)

storageAttributesUpdateRequest - the information needed to update storage attributes

Returns:

the updated storage information