org.osivia.portal.api.cache.services

Class CacheInfo

java.lang.Object

org.osivia.portal.api.cache.services.CacheInfo

public class CacheInfo
extends Object

The Class CacheInfo. Structure the way the cache will be handled (timeout, scope, reloading policy)

Field Summary

Fields

Modifier and Type	Field and Description
static int	CACHE_SCOPE_GLOBAL The cache scope global.
static int	CACHE_SCOPE_NONE The cache scope none.
static int	CACHE_SCOPE_PORTLET_CONTEXT The cache scope portlet context.
static int	CACHE_SCOPE_PORTLET_SESSION The cache scope portlet session.

Constructor Summary

Constructors

Constructor and Description
CacheInfo(String itemKey, int scope, IServiceInvoker invoker, Object request, javax.portlet.PortletContext context, boolean isAsyncCacheRefreshing) Instantiates a new cache info.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getContext() Gets the context.
long	getExpirationDelay() Gets the expiration delay.
IServiceInvoker	getInvoker() Gets the invoker.
String	getItemKey() Gets the item key.
Object	getRequest() Gets the request.
int	getScope() Gets the scope.
boolean	isAsyncCacheRefreshing() Checks if is async cache refreshing.
boolean	isForceNOTReload() Checks if is force not reload.
boolean	isForceReload() Checks if is force reload.
void	setAsyncCacheRefreshing(boolean isAsyncCacheRefreshing) Sets the async cache refreshing.
void	setContext(javax.portlet.PortletContext context) Sets the context.
void	setExpirationDelay(long expirationDelay) Sets the expiration delay.
void	setForceNOTReload(boolean forceNOTReload) Sets the force not reload.
void	setForceReload(boolean forceReload) Sets the force reload.
void	setInvoker(IServiceInvoker invoker) Sets the invoker.
void	setItemKey(String itemKey) Sets the item key.
void	setRequest(Object request) Sets the request.
void	setScope(int scope) Sets the scope.

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_SCOPE_NONE

public static int CACHE_SCOPE_NONE

The cache scope none.

CACHE_SCOPE_PORTLET_SESSION

public static int CACHE_SCOPE_PORTLET_SESSION

The cache scope portlet session.

CACHE_SCOPE_PORTLET_CONTEXT

public static int CACHE_SCOPE_PORTLET_CONTEXT

The cache scope portlet context.

CACHE_SCOPE_GLOBAL

public static int CACHE_SCOPE_GLOBAL

The cache scope global.

Constructor Detail

CacheInfo

public CacheInfo(String itemKey,
         int scope,
         IServiceInvoker invoker,
         Object request,
         javax.portlet.PortletContext context,
         boolean isAsyncCacheRefreshing)

Instantiates a new cache info.

Parameters:

itemKey - the item Key of the cache element

scope - the scope

invoker - the applicative invoker that will compute the cache content

request - the request

context - the context

isAsyncCacheRefreshing - the is async cache refreshing

Method Detail

isForceNOTReload

public boolean isForceNOTReload()

Checks if is force not reload.

Returns:

true, if is force not reload

setForceNOTReload

public void setForceNOTReload(boolean forceNOTReload)

Sets the force not reload.

Parameters:

forceNOTReload - the new force not reload

isForceReload

public boolean isForceReload()

Checks if is force reload.

Returns:

true, if is force reload

setForceReload

public void setForceReload(boolean forceReload)

Sets the force reload.

Parameters:

forceReload - the new force reload

isAsyncCacheRefreshing

public boolean isAsyncCacheRefreshing()

Checks if is async cache refreshing.

Returns:

true, if is async cache refreshing

setAsyncCacheRefreshing

public void setAsyncCacheRefreshing(boolean isAsyncCacheRefreshing)

Sets the async cache refreshing.

Parameters:

isAsyncCacheRefreshing - the new async cache refreshing

getContext

public Object getContext()

Gets the context.

Returns:

the context

setContext

public void setContext(javax.portlet.PortletContext context)

Sets the context.

Parameters:

context - the new context

getExpirationDelay

public long getExpirationDelay()

Gets the expiration delay.

Returns:

the expiration delay

setExpirationDelay

public void setExpirationDelay(long expirationDelay)

Sets the expiration delay.

Parameters:

expirationDelay - the new expiration delay

getScope

public int getScope()

Gets the scope.

Returns:

the scope

setScope

public void setScope(int scope)

Sets the scope.

Parameters:

scope - the new scope

getRequest

public Object getRequest()

Gets the request.

Returns:

the request

setRequest

public void setRequest(Object request)

Sets the request.

Parameters:

request - the new request

getItemKey

public String getItemKey()

Gets the item key.

Returns:

the item key

setItemKey

public void setItemKey(String itemKey)

Sets the item key.

Parameters:

itemKey - the new item key

getInvoker

public IServiceInvoker getInvoker()

Gets the invoker.

Returns:

the invoker

setInvoker

public void setInvoker(IServiceInvoker invoker)

Sets the invoker.

Parameters:

invoker - the new invoker