org.duracloud.client

Interface ContentStoreManager

All Superinterfaces:

org.duracloud.common.model.Securable

All Known Implementing Classes:

CachingContentStoreManagerImpl, ContentStoreManagerImpl

public interface ContentStoreManager
extends org.duracloud.common.model.Securable

Provides facilities for connecting to a set of content stores

Author:

Bill Branan

Method Summary

Methods

Modifier and Type	Method and Description
ContentStore	getContentStore(String storeID) Gets a specific content store based on ID.
ContentStore	getContentStore(String storeID, int maxRetries) Gets a specific content store based on ID.
Map<String,ContentStore>	getContentStores() Gets all available content stores.
Map<String,ContentStore>	getContentStores(int maxRetries) Gets all available content stores.
ContentStore	getPrimaryContentStore() Gets the primary content store.
ContentStore	getPrimaryContentStore(int maxRetries) Gets the primary content store.
ContentStore	getPrimaryContentStoreAsAnonymous() Provides access to the primary content store without requiring login().
ContentStore	getPrimaryContentStoreAsAnonymous(int maxRetries) Provides access to the primary content store without requiring login().
void	reinitialize(String host, String port, String context) reconfigure

Methods inherited from interface org.duracloud.common.model.Securable

login, logout

Method Detail

getContentStores

Map<String,ContentStore> getContentStores()
                                          throws ContentStoreException

Gets all available content stores. Each content store uses the default number of retries (3) on call failure.

Returns:

a map of content stores to content store IDs

Throws:

ContentStoreException - if the content store list cannot be retrieved

getContentStores

Map<String,ContentStore> getContentStores(int maxRetries)
                                          throws ContentStoreException

Gets all available content stores.

Parameters:

maxRetries - number of retries to perform if a content store call fails

Returns:

a map of content stores to content store IDs

Throws:

ContentStoreException - if the content store list cannot be retrieved

getContentStore

ContentStore getContentStore(String storeID)
                             throws ContentStoreException

Gets a specific content store based on ID. Content store uses the default number of retries (3) on call failure.

Parameters:

storeID - the ID of a particular content store

Returns:

the ContentStore mapped to storeID

Throws:

ContentStoreException - if the content store cannot be retrieved

getContentStore

ContentStore getContentStore(String storeID,
                           int maxRetries)
                             throws ContentStoreException

Gets a specific content store based on ID.

Parameters:

storeID - the ID of a particular content store

maxRetries - number of retries to perform if a content store call fails

Returns:

the ContentStore mapped to storeID

Throws:

ContentStoreException - if the content store cannot be retrieved

getPrimaryContentStore

ContentStore getPrimaryContentStore()
                                    throws ContentStoreException

Gets the primary content store. Content store uses the default number of retries (3) on call failure.

Returns:

the primary ContentStore

Throws:

if - the content store cannot be retrieved

ContentStoreException

getPrimaryContentStore

ContentStore getPrimaryContentStore(int maxRetries)
                                    throws ContentStoreException

Gets the primary content store.

Parameters:

maxRetries - number of retries to perform if a content store call fails

Returns:

the primary ContentStore

Throws:

if - the content store cannot be retrieved

ContentStoreException

getPrimaryContentStoreAsAnonymous

ContentStore getPrimaryContentStoreAsAnonymous()
                                               throws ContentStoreException

Provides access to the primary content store without requiring login(). Only certain ContentStore activities are permitted to anonymous users, primarily getting content from open spaces. Content store uses the default number of retries (3) on call failure.

Returns:

the primary ContentStore

Throws:

if - the content store cannot be retrieved

ContentStoreException

getPrimaryContentStoreAsAnonymous

ContentStore getPrimaryContentStoreAsAnonymous(int maxRetries)
                                               throws ContentStoreException

Provides access to the primary content store without requiring login(). Only certain ContentStore activities are permitted to anonymous users, primarily getting content from open spaces.

Parameters:

maxRetries - number of retries to perform if a content store call fails

Returns:

the primary ContentStore

Throws:

if - the content store cannot be retrieved

ContentStoreException

reinitialize

void reinitialize(String host,
                String port,
                String context)
                  throws ContentStoreException

reconfigure

Parameters:

host - of durastore

port - of durastore

context - of durastore

Throws:

ContentStoreException