org.duracloud.client

Class ContentStoreManagerImpl

java.lang.Object

org.duracloud.client.ContentStoreManagerImpl

All Implemented Interfaces:

ContentStoreManager, Securable

Direct Known Subclasses:

CachingContentStoreManagerImpl

public class ContentStoreManagerImpl
extends Object
implements ContentStoreManager, Securable

Provides facilities for connecting to a set of content stores

Author:

Bill Branan

Constructor Summary

Constructors

Constructor and Description
ContentStoreManagerImpl(String host, String port) Constructor for ContentStoreManagerImpl.
ContentStoreManagerImpl(String host, String port, String context) Constructor for ContentStoreManagerImpl.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getBaseURL()
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().
protected RestHttpHelper	getRestHelper()
void	login(Credential appCred) This method supplies user credentials to the application.
void	logout() This method clears any previously logged-in credentials.
protected ContentStore	newContentStoreImpl(StorageAccount acct)
protected ContentStore	newContentStoreImpl(StorageAccount acct, int maxRetries)
void	reinitialize(String host, String port, String context) reconfigure
protected void	setRestHelper(RestHttpHelper restHelper)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentStoreManagerImpl

public ContentStoreManagerImpl(String host,
                       String port)

Constructor for ContentStoreManagerImpl.

Parameters:

host - a String object.

port - a String object.

ContentStoreManagerImpl

public ContentStoreManagerImpl(String host,
                       String port,
                       String context)

Constructor for ContentStoreManagerImpl.

Parameters:

host - the host name on which DuraStore can be accessed

port - the port on which DuraStore can be accessed

context - the application context by which DuraStore can be accessed

Method Detail

reinitialize

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

Description copied from interface: ContentStoreManager

reconfigure

Specified by:

reinitialize in interface ContentStoreManager

Parameters:

host - of durastore

port - of durastore

context - of durastore

Throws:

ContentStoreException

getContentStores

public Map<String,ContentStore> getContentStores()
                                          throws ContentStoreException

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

Specified by:

getContentStores in interface ContentStoreManager

Returns:

a map of content stores to content store IDs

Throws:

ContentStoreException - if the content store list cannot be retrieved

getContentStores

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

Gets all available content stores.

Specified by:

getContentStores in interface ContentStoreManager

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

public 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.

Specified by:

getContentStore in interface ContentStoreManager

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

public ContentStore getContentStore(String storeID,
                           int maxRetries)
                             throws ContentStoreException

Gets a specific content store based on ID.

Specified by:

getContentStore in interface ContentStoreManager

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

public ContentStore getPrimaryContentStore()
                                    throws ContentStoreException

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

Specified by:

getPrimaryContentStore in interface ContentStoreManager

Returns:

the primary ContentStore

Throws:

ContentStoreException

getPrimaryContentStore

public ContentStore getPrimaryContentStore(int maxRetries)
                                    throws ContentStoreException

Gets the primary content store.

Specified by:

getPrimaryContentStore in interface ContentStoreManager

Parameters:

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

Returns:

the primary ContentStore

Throws:

ContentStoreException

getPrimaryContentStoreAsAnonymous

public 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.

Specified by:

getPrimaryContentStoreAsAnonymous in interface ContentStoreManager

Returns:

the primary ContentStore

Throws:

ContentStoreException

getPrimaryContentStoreAsAnonymous

public 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.

Specified by:

getPrimaryContentStoreAsAnonymous in interface ContentStoreManager

Parameters:

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

Returns:

the primary ContentStore

Throws:

ContentStoreException

login

public void login(Credential appCred)

Description copied from interface: Securable

This method supplies user credentials to the application.

Specified by:

login in interface Securable

Parameters:

appCred - of user

logout

public void logout()

Description copied from interface: Securable

This method clears any previously logged-in credentials.

Specified by:

logout in interface Securable

newContentStoreImpl

protected ContentStore newContentStoreImpl(StorageAccount acct)

newContentStoreImpl

protected ContentStore newContentStoreImpl(StorageAccount acct,
                               int maxRetries)

getBaseURL

protected String getBaseURL()

getRestHelper

protected RestHttpHelper getRestHelper()

setRestHelper

protected void setRestHelper(RestHttpHelper restHelper)