com.trendmicro.grid.acl.l0
Interface CacheControlService

All Superinterfaces:

Service

@ProtectedRequestContext
@WebServlet(value="/ws/level-0/internal/cache-control")
public interface CacheControlService
extends Service

Implements rudimentary cache control and information gathering.

Version:

1.0

Author:

juergen_kellerer, 2011-01-26

Method Summary

List<String>	getCacheClusterNodeAddressList() Returns a list of addresses of the machines that are part of the cache cluster.
List<String>	getCacheIdentifiers() Returns a list of all cache identifiers using the format cacheName@cacheContext.
List<CacheInformation>	getCacheInformationList() Returns a list of cache information instances for all caches that are used by the ACL node.
CacheInformation	getCombinedCacheInformation() Returns a single cache information instance that contains the combined information on all caches.
List<String>	getLocalClusterNodeAddressList() Returns the addresses of the local machine that is part of the cache cluster.
void	invalidate(String cacheContext, String cacheName) Invalidates (clears) the named cache and does NOT wait for the operation to succeed.
void	invalidateAll() Invalidates (clears) the all caches and does NOT wait for the operation to succeed.
void	invalidateAllAndWait() Invalidates (clears) the all caches and waits for the operation to succeed.
void	invalidateAndWait(String cacheContext, String cacheName) Invalidates (clears) the named cache and waits for the operation to succeed.

Method Detail

getCacheIdentifiers

@RequiredRoles(value="access.protected.services")
List<String> getCacheIdentifiers()
                                 throws AuthenticationException

Returns a list of all cache identifiers using the format cacheName@cacheContext.

Returns:

a list of all cache identifiers using the format cacheName@cacheContext.

Throws:

AuthenticationException - In case of the current user is not authenticated or doesn't have the right to access the service.

getCacheClusterNodeAddressList

@RequiredRoles(value="access.protected.services")
List<String> getCacheClusterNodeAddressList()
                                            throws AuthenticationException

Returns a list of addresses of the machines that are part of the cache cluster.

Returns:

a list of machines that are part of the cache cluster.

Throws:

AuthenticationException - In case of the current user is not authenticated or doesn't have the right to access the service.

getLocalClusterNodeAddressList

@RequiredRoles(value="access.protected.services")
List<String> getLocalClusterNodeAddressList()
                                            throws AuthenticationException

Returns the addresses of the local machine that is part of the cache cluster.

Returns:

all addresses of the local machine that are used to connect to the cache cluster.

Throws:

AuthenticationException - In case of the current user is not authenticated or doesn't have the right to access the service.

getCombinedCacheInformation

@RequiredRoles(value="access.protected.services")
CacheInformation getCombinedCacheInformation()
                                             throws AuthenticationException

Returns a single cache information instance that contains the combined information on all caches.

Returns:

a single cache information instance that contains the combined information on all caches.

Throws:

AuthenticationException - In case of the current user is not authenticated or doesn't have the right to access the service.

getCacheInformationList

@RequiredRoles(value="access.protected.services")
List<CacheInformation> getCacheInformationList()
                                               throws AuthenticationException

Returns a list of cache information instances for all caches that are used by the ACL node.

Returns:

a list of cache information instances for all caches that are used by the ACL node.

Throws:

AuthenticationException - In case of the current user is not authenticated or doesn't have the right to access the service.

invalidate

@RequiredRoles(value={"access.protected.services","manage"})
void invalidate(String cacheContext,
                                   String cacheName)
                throws AuthenticationException

Invalidates (clears) the named cache and does NOT wait for the operation to succeed.

Parameters:

cacheContext - The name of the context holding the cache.

cacheName - The name of the cache.

Throws:

AuthenticationException - In case of the current user is not authenticated or doesn't have the right to access the service.

invalidateAndWait

@RequiredRoles(value={"access.protected.services","manage"})
void invalidateAndWait(String cacheContext,
                                          String cacheName)
                       throws AuthenticationException

Invalidates (clears) the named cache and waits for the operation to succeed.

Parameters:

cacheContext - The name of the context holding the cache.

cacheName - The name of the cache.

Throws:

AuthenticationException - In case of the current user is not authenticated or doesn't have the right to access the service.

invalidateAll

@RequiredRoles(value={"access.protected.services","manage"})
void invalidateAll()
                   throws AuthenticationException

Invalidates (clears) the all caches and does NOT wait for the operation to succeed.

Throws:

AuthenticationException - In case of the current user is not authenticated or doesn't have the right to access the service.

invalidateAllAndWait

@RequiredRoles(value={"access.protected.services","manage"})
void invalidateAllAndWait()
                          throws AuthenticationException

Invalidates (clears) the all caches and waits for the operation to succeed.

Throws:

AuthenticationException - In case of the current user is not authenticated or doesn't have the right to access the service.