org.dataone.client.v2.formats

Class ObjectFormatCache

java.lang.Object

org.dataone.client.v2.formats.ObjectFormatCache

public class ObjectFormatCache
extends Object

The ObjectFormatCache is a wrapper class for the DataONE ObjectFormatList type. It loads the most current object format list from a Coordinating Node, and falls back to a default, albeit out of date, ObjectFormatList shipped with the d1_libclient_java package. The class provides accessor methods to query and manipulate the object format list. To load an object format list other than the one configured for your environment, set the property "ObjectFormatCache.overriding.CN_URL" in your application's configuration. This is mainly used for integration and pre-registration testing.

Author:

cjones, rnahf

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	lastRefreshDate
protected static int	throttleIntervalSec
static boolean	usingFallbackFormatList

Method Summary

Methods

Modifier and Type	Method and Description
ObjectFormat	getFormat(ObjectFormatIdentifier formatId) Lookup and return the format specified by the Identifier.
ObjectFormat	getFormat(String fmtidStr) Deprecated.
static ObjectFormatCache	getInstance() Create the object format cache instance if it hasn't already been created.
Date	getLastRefreshDate() Returns the date of the last refresh from the CN.
int	getMinimalRefreshInterval() Returns the minimal refresh interval (seconds)
protected ConcurrentHashMap<ObjectFormatIdentifier,ObjectFormat>	getObjectFormatMap()
boolean	isUsingFallbackFormatList() Returns true if the cache has not been able to successfully refresh from the CN
ObjectFormatList	listFormats() List the object formats registered with the object format service.
protected void	refreshCache() refreshes the cache from the CN or if a CN copy cannot be obtains, temporarily uses a static ObjectFormatList included in the libclient_java jar, accessed via org.dataone.service.types.v2.util.ObjectFormatServiceImpl.

Methods inherited from class java.lang.Object

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

Field Detail

usingFallbackFormatList

public static boolean usingFallbackFormatList

throttleIntervalSec

protected static int throttleIntervalSec

lastRefreshDate

protected Date lastRefreshDate

Method Detail

getInstance

public static ObjectFormatCache getInstance()

Create the object format cache instance if it hasn't already been created.

listFormats

public ObjectFormatList listFormats()

List the object formats registered with the object format service.

Returns:

objectFormatList - the list of object formats

getMinimalRefreshInterval

public int getMinimalRefreshInterval()

Returns the minimal refresh interval (seconds)

getLastRefreshDate

public Date getLastRefreshDate()

Returns the date of the last refresh from the CN. Returns "Date zero" (Jan 1, 1970) if never refreshed from the CN

isUsingFallbackFormatList

public boolean isUsingFallbackFormatList()

Returns true if the cache has not been able to successfully refresh from the CN

refreshCache

protected void refreshCache()
                     throws ServiceFailure

refreshes the cache from the CN or if a CN copy cannot be obtains, temporarily uses a static ObjectFormatList included in the libclient_java jar, accessed via org.dataone.service.types.v2.util.ObjectFormatServiceImpl. Once there has been a successful load from the CN, the cache expires after a configurable number of seconds. The refresh clears and replaces the previous cached ObjectFormatList.

Throws:

ServiceFailure

getFormat

@Deprecated
public ObjectFormat getFormat(String fmtidStr)
                       throws NotFound

Deprecated.

Get the object format based on the given identifier string.

This method is deprecated in favor of the type-safe getFormat(ObjectFormatIdentifier) method

Parameters:

format - - the object format identifier string

Returns:

objectFormat - the ObjectFormat represented by the format identifier

Throws:

NotFound

getFormat

public ObjectFormat getFormat(ObjectFormatIdentifier formatId)
                       throws NotFound

Lookup and return the format specified by the Identifier. If cache is stale or ID not in the cache, will refresh and try (again). returns the formatId or exception

Parameters:

formatId - - the object format identifier

Returns:

objectFormat - the ObjectFormat represented by the format identifier

Throws:

ServiceFailure

NotFound

NotImplemented

getObjectFormatMap

protected ConcurrentHashMap<ObjectFormatIdentifier,ObjectFormat> getObjectFormatMap()