lumis.portal.cache

Interface ICacheManager

All Known Implementing Classes:

CacheManager

public interface ICacheManager

Provides operations on the portal cache framework.

Since:

4.0.11

Version:

$Revision: 7370 $ $Date: 2007-06-12 16:50:49 +0000 (Tue, 12 Jun 2007) $

Method Summary

Modifier and Type	Method and Description
void	addCacheConfig(SessionConfig sessionConfig, ICacheConfig cacheConfig, ITransaction transaction) Adds a cacheConfig to persistence.
ICacheConfig	createCacheConfig(String id) Creates an ICacheConfig transient instance.
void	deleteCacheConfig(SessionConfig sessionConfig, ICacheConfig cacheConfig, ITransaction transaction) Deletes a cacheConfig from persistence.
int	getCacheCapacity(String cacheId) Returns the capacity to be used for the specified cache.
ICacheConfig	getCacheConfig(SessionConfig sessionConfig, String cacheConfigId, ITransaction transaction) Returns a persistent cacheConfig instance.

Method Detail

getCacheCapacity

int getCacheCapacity(String cacheId)

Returns the capacity to be used for the specified cache.

Parameters:

cacheId - the cache's identifier.

Returns:

the capacity.

Since:

4.0.11

createCacheConfig

ICacheConfig createCacheConfig(String id)
                        throws PortalException

Creates an ICacheConfig transient instance.

Parameters:

id - the id for the instance to be created.

Returns:

the created instance.

Throws:

PortalException

Since:

4.0.11

See Also:

addCacheConfig(SessionConfig, ICacheConfig, ITransaction)

addCacheConfig

void addCacheConfig(SessionConfig sessionConfig,
                    ICacheConfig cacheConfig,
                    ITransaction transaction)
             throws PortalException

Adds a cacheConfig to persistence.

Parameters:

sessionConfig - the user session information.

cacheConfig - the transient cacheConfig instance to be persisted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.0.11

getCacheConfig

ICacheConfig getCacheConfig(SessionConfig sessionConfig,
                            String cacheConfigId,
                            ITransaction transaction)
                     throws PortalException

Returns a persistent cacheConfig instance.

Parameters:

sessionConfig - the user session information.

cacheConfigId - the cacheConfig's identifier.

transaction - the transaction for persistence access.

Returns:

a persistent cacheConfig instance.

Throws:

PortalObjectNotFoundException - if no cacheConfig with such id was found.

PortalException

Since:

4.0.11

deleteCacheConfig

void deleteCacheConfig(SessionConfig sessionConfig,
                       ICacheConfig cacheConfig,
                       ITransaction transaction)
                throws PortalException

Deletes a cacheConfig from persistence.

Parameters:

sessionConfig - the user session information.

cacheConfig - the persistent cacheConfig instance to be deleted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.0.11