Package org.gcube.informationsystem.resourceregistry.api.contexts

Class ContextCache

java.lang.Object

org.gcube.informationsystem.resourceregistry.api.contexts.ContextCache

public class ContextCache
extends Object

The Class ContextCache.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
protected ContextCacheRenewal	contextCacheRenewal	The context cache renewal.
protected Map<String,UUID>	contextFullNameToUUID	The context full name to UUID.
protected List<org.gcube.informationsystem.contexts.reference.entities.Context>	contexts	The contexts.
protected org.gcube.informationsystem.tree.Tree<org.gcube.informationsystem.contexts.reference.entities.Context>	contextsTree	The contexts tree.
protected Calendar	creationTime	The creation time.
static long	DEFAULT_EXPIRING_TIMEOUT	The Constant DEFAULT_EXPIRING_TIMEOUT.
protected Calendar	expiringTime	The expiring time.
static int	expiringTimeout	The expiring timeout.
protected boolean	initialized	The initialized.
protected static ContextCache	singleton	The singleton.
protected Map<UUID,org.gcube.informationsystem.contexts.reference.entities.Context>	uuidToContext	The uuid to context.
protected Map<UUID,String>	uuidToContextFullName	The uuid to context full name.

Constructor Summary

Constructors

Constructor	Description
ContextCache()	Instantiates a new context cache.

Method Summary

Modifier and Type	Method	Description
void	cleanCache()	Clean cache.
protected void	cleanCache(Calendar calendar)	Clean cache.
org.gcube.informationsystem.contexts.reference.entities.Context	getContextByFullName(String contextFullName)	Gets the context by full name.
org.gcube.informationsystem.contexts.reference.entities.Context	getContextByUUID(String uuid)	Gets the context by UUID.
org.gcube.informationsystem.contexts.reference.entities.Context	getContextByUUID(UUID uuid)	Gets the context by UUID.
ContextCacheRenewal	getContextCacheRenewal()	Gets the context cache renewal.
protected String	getContextFullName(org.gcube.informationsystem.contexts.reference.entities.Context context)	Gets the context full name.
String	getContextFullNameByUUID(String uuid)	Gets the context full name by UUID.
String	getContextFullNameByUUID(UUID uuid)	Gets the context full name by UUID.
Map<String,UUID>	getContextFullNameToUUIDAssociation()	Gets the context full name to UUID association.
List<org.gcube.informationsystem.contexts.reference.entities.Context>	getContexts()	Gets the contexts.
org.gcube.informationsystem.tree.Tree<org.gcube.informationsystem.contexts.reference.entities.Context>	getContextsTree()	Gets the contexts tree.
static ContextCache	getInstance()	Gets the single instance of ContextCache.
UUID	getUUIDByFullName(String contextFullName)	Gets the uuid by full name.
Map<UUID,String>	getUUIDToContextFullNameAssociation()	Gets the UUID to context full name association.
void	refreshContextsIfNeeded()	Refresh contexts if needed.
void	renew()	Renew.
void	setContextCacheRenewal(ContextCacheRenewal contextCacheRenewal)	Sets the context cache renewal.
protected void	setContexts(Calendar calendar, List<org.gcube.informationsystem.contexts.reference.entities.Context> contexts)	Sets the contexts.
void	setContexts(List<org.gcube.informationsystem.contexts.reference.entities.Context> contexts)	Sets the contexts.
static void	setExpiringTimeout(int expiringTimeout)	Sets the expiring timeout.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPIRING_TIMEOUT

public static final long DEFAULT_EXPIRING_TIMEOUT

The Constant DEFAULT_EXPIRING_TIMEOUT.

expiringTimeout

public static int expiringTimeout

The expiring timeout.

singleton

protected static ContextCache singleton

The singleton.

contextCacheRenewal

protected ContextCacheRenewal contextCacheRenewal

The context cache renewal.

creationTime

protected Calendar creationTime

The creation time.

expiringTime

protected Calendar expiringTime

The expiring time.

contexts

protected List<org.gcube.informationsystem.contexts.reference.entities.Context> contexts

The contexts.

uuidToContext

protected Map<UUID,org.gcube.informationsystem.contexts.reference.entities.Context> uuidToContext

The uuid to context.

uuidToContextFullName

protected Map<UUID,String> uuidToContextFullName

The uuid to context full name.

contextFullNameToUUID

protected Map<String,UUID> contextFullNameToUUID

The context full name to UUID.

contextsTree

protected org.gcube.informationsystem.tree.Tree<org.gcube.informationsystem.contexts.reference.entities.Context> contextsTree

The contexts tree.

initialized

protected boolean initialized

The initialized.

Constructor Detail

ContextCache

public ContextCache()

Instantiates a new context cache.

Method Detail

setExpiringTimeout

public static void setExpiringTimeout(int expiringTimeout)

Sets the expiring timeout.

Parameters:

expiringTimeout - the new expiring timeout

getInstance

public static ContextCache getInstance()

Gets the single instance of ContextCache.

Returns:

single instance of ContextCache

cleanCache

public void cleanCache()

Clean cache.

cleanCache

protected void cleanCache(Calendar calendar)

Clean cache.

Parameters:

calendar - the calendar

renew

public void renew()
           throws ResourceRegistryException

Renew.

Throws:

ResourceRegistryException - the resource registry exception

getContextCacheRenewal

public ContextCacheRenewal getContextCacheRenewal()

Gets the context cache renewal.

Returns:

the context cache renewal

setContextCacheRenewal

public void setContextCacheRenewal(ContextCacheRenewal contextCacheRenewal)

Sets the context cache renewal.

Parameters:

contextCacheRenewal - the new context cache renewal

refreshContextsIfNeeded

public void refreshContextsIfNeeded()
                             throws ResourceRegistryException

Refresh contexts if needed.

Throws:

ResourceRegistryException - the resource registry exception

getContexts

public List<org.gcube.informationsystem.contexts.reference.entities.Context> getContexts()
                                                                                  throws ResourceRegistryException

Gets the contexts.

Returns:

the contexts

Throws:

ResourceRegistryException - the resource registry exception

setContexts

public void setContexts(List<org.gcube.informationsystem.contexts.reference.entities.Context> contexts)

Sets the contexts.

Parameters:

contexts - the new contexts

setContexts

protected void setContexts(Calendar calendar,
                           List<org.gcube.informationsystem.contexts.reference.entities.Context> contexts)

Sets the contexts.

Parameters:

calendar - the calendar

contexts - the contexts

getContextFullName

protected String getContextFullName(org.gcube.informationsystem.contexts.reference.entities.Context context)

Gets the context full name.

Parameters:

context - the context

Returns:

the context full name

getContextFullNameByUUID

public String getContextFullNameByUUID(UUID uuid)
                                throws ResourceRegistryException

Gets the context full name by UUID.

Parameters:

uuid - the uuid

Returns:

the context full name by UUID

Throws:

ResourceRegistryException - the resource registry exception

getContextFullNameByUUID

public String getContextFullNameByUUID(String uuid)
                                throws ResourceRegistryException

Gets the context full name by UUID.

Parameters:

uuid - the uuid

Returns:

the context full name by UUID

Throws:

ResourceRegistryException - the resource registry exception

getUUIDByFullName

public UUID getUUIDByFullName(String contextFullName)
                       throws ResourceRegistryException

Gets the uuid by full name.

Parameters:

contextFullName - the context full name

Returns:

the uuid by full name

Throws:

ResourceRegistryException - the resource registry exception

getContextByUUID

public org.gcube.informationsystem.contexts.reference.entities.Context getContextByUUID(UUID uuid)
                                                                                 throws ResourceRegistryException

Gets the context by UUID.

Parameters:

uuid - the uuid

Returns:

the context by UUID

Throws:

ResourceRegistryException - the resource registry exception

getContextByUUID

public org.gcube.informationsystem.contexts.reference.entities.Context getContextByUUID(String uuid)
                                                                                 throws ResourceRegistryException

Gets the context by UUID.

Parameters:

uuid - the uuid

Returns:

the context by UUID

Throws:

ResourceRegistryException - the resource registry exception

getContextByFullName

public org.gcube.informationsystem.contexts.reference.entities.Context getContextByFullName(String contextFullName)
                                                                                     throws ResourceRegistryException

Gets the context by full name.

Parameters:

contextFullName - the context full name

Returns:

the context by full name

Throws:

ResourceRegistryException - the resource registry exception

getUUIDToContextFullNameAssociation

public Map<UUID,String> getUUIDToContextFullNameAssociation()
                                                           throws ResourceRegistryException

Gets the UUID to context full name association.

Returns:

an Map containing UUID to Context FullName association

Throws:

ResourceRegistryException - the resource registry exception

getContextFullNameToUUIDAssociation

public Map<String,UUID> getContextFullNameToUUIDAssociation()
                                                           throws ResourceRegistryException

Gets the context full name to UUID association.

Returns:

an Map containing Context FullName to UUID association

Throws:

ResourceRegistryException - the resource registry exception

getContextsTree

public org.gcube.informationsystem.tree.Tree<org.gcube.informationsystem.contexts.reference.entities.Context> getContextsTree()
                                                                                                                       throws ResourceRegistryException

Gets the contexts tree.

Returns:

the contexts tree

Throws:

ResourceRegistryException - the resource registry exception