org.jboss.seam.cache
Class EhCacheProvider

java.lang.Object
  extended by org.jboss.seam.cache.CacheProvider<net.sf.ehcache.CacheManager>
      extended by org.jboss.seam.cache.EhCacheProvider

@Name(value="org.jboss.seam.cache.cacheProvider")
@Scope(value=APPLICATION)
@BypassInterceptors
@Install(value=false,
         precedence=0,
         classDependencies="net.sf.ehcache.Cache")
@AutoCreate
public class EhCacheProvider
extends CacheProvider<net.sf.ehcache.CacheManager>

Implementation of CacheProvider backed by EhCache. The default cache region issues org.jboss.seam.cache.DefaultCache as the default cache region.

Author:
Sebastian Hennebrueder, Pete Muir

Field Summary
 
Fields inherited from class org.jboss.seam.cache.CacheProvider
DEFAULT_REGION
 
Constructor Summary
EhCacheProvider()
           
 
Method Summary
 void clear()
          Removes all objects from all cache regions
 void create()
           
 void destroy()
           
 Object get(String region, String key)
          Fetches an object for the given key from the cache and returns it if found.
 net.sf.ehcache.CacheManager getDelegate()
           
 void put(String region, String key, Object object)
          Puts an object into the cache.
 void remove(String region, String key)
          Removes an object from the cache.
 
Methods inherited from class org.jboss.seam.cache.CacheProvider
get, get, get, getConfiguration, getConfigurationAsStream, getDefaultRegion, instance, instance, put, remove, setConfiguration, setDefaultRegion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EhCacheProvider

public EhCacheProvider()
Method Detail

getDelegate

public net.sf.ehcache.CacheManager getDelegate()
Specified by:
getDelegate in class CacheProvider<net.sf.ehcache.CacheManager>
Returns:
- the cache the cache provider delegates to

put

public void put(String region,
                String key,
                Object object)
Description copied from class: CacheProvider
Puts an object into the cache. The object is placed in the specified cache region under the given key.

Specified by:
put in class CacheProvider<net.sf.ehcache.CacheManager>
Parameters:
region - - the name of a cache region
key - - a key to identify the object
object - - the object to be stored in the cache

clear

public void clear()
Description copied from class: CacheProvider
Removes all objects from all cache regions

Specified by:
clear in class CacheProvider<net.sf.ehcache.CacheManager>

get

public Object get(String region,
                  String key)
Description copied from class: CacheProvider
Fetches an object for the given key from the cache and returns it if found. Only the specified cache region will be searched.

Specified by:
get in class CacheProvider<net.sf.ehcache.CacheManager>
Parameters:
region - - the name of a cache region
key - - a key to identify the object.
Returns:
- the object if found or null if not

remove

public void remove(String region,
                   String key)
Description copied from class: CacheProvider
Removes an object from the cache. The object is removed from the specified cache region under the given key.

Specified by:
remove in class CacheProvider<net.sf.ehcache.CacheManager>
Parameters:
region - - the name of a cache region
key - - a key to identify the object

create

@Create
public void create()

destroy

@Destroy
public void destroy()


Copyright © 2011 Seam Framework. All Rights Reserved.