Author: nbelaevski
Date: 2009-07-09 14:04:10 -0400 (Thu, 09 Jul 2009)
New Revision: 14868
Removed:
framework/trunk/api/src/main/java/org/ajax4jsf/cache/Cache.java
framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheConfigurationLoader.java
framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheEntry.java
framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheException.java
framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheFactory.java
framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheListener.java
framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheLoader.java
Log:
Old cache API removed
Deleted: framework/trunk/api/src/main/java/org/ajax4jsf/cache/Cache.java
===================================================================
--- framework/trunk/api/src/main/java/org/ajax4jsf/cache/Cache.java 2009-07-09 16:24:53
UTC (rev 14867)
+++ framework/trunk/api/src/main/java/org/ajax4jsf/cache/Cache.java 2009-07-09 18:04:10
UTC (rev 14868)
@@ -1,197 +0,0 @@
-/*
- * Copyright [yyyy] [name of copyright owner].
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *
http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.ajax4jsf.cache;
-
-import java.util.Collection;
-import java.util.Map;
-import java.util.Set;
-import java.util.Map.Entry;
-
-/**
- * <p>
- * A cache, being a mechanism for efficient temporary storage of objects
- * for the purpose of improving the overall performance of an application
- * system, should not be necessary for the application to function correctly,
- * it only improves the performance.
- * <p>
- * A cache could be scoped, for examples to a JVM, all JVMs on a node, all
- * nodes in a cluster, etc. Operations that are scoped to a cache such as put
- * or load would affect all JVMs in the cache. So the object loaded in 1 JVM
- * would be equally available to all other JVMs in the cache.
- * <p>
- * Objects are identified in the cache by a key. A key can be any Java
- * object that implements the equals and hashcode methods. If the object is
- * to be distributed or persisted (if supported) it must implement
- * serializable.
- * <p/>
- * Each object in the cache will have a <code>CacheEntry<code> object
associated with
- * it. This object will encapsulate the metadata associated with the cached
- * object. Mainly it represents the object statistics.
- * <p/>
- * "CacheStatistics" represents the read-only statistics of the cache,
- * while "CacheAttributes" represents the user settable attributes of the
- * cache.
- */
-public interface Cache
-{
- /**
- * Returns true if the cache contains the specified key. The search is
- * scoped to the cache. Other caches in the system will not be searched
- * and a CacheLoader will not be called.
- * @return true, if the cache contains the specified key.
- */
- public boolean containsKey(Object key);
-
- /**
- * @return true if the cache contains one or more keys to the specified value.
- */
- public boolean containsValue(Object value);
-
- /**
- * Returns a set view of the objects currently contained in the cache.
- * A CacheLoader will not be called. The behavior is unspecified for the
- * case when an object is remove from the cache while the return set is
- * being traversed.
- */
- public Set<Entry<Object, Object>> entrySet();
-
- /**
- * Equality is based on the Set returned by entrySet. Equal will return
- * true if the two objects are referencing the same object or
- * entrySet.equals(((Map)o).entrySet()) returns true.
- */
- public boolean equals(Object o);
-
- /**
- * @param ht a hashtable which holds a pointer pointing to the
- * declarative cache description.
- * @throws CacheException if any error occurs.
- */
-
- /**
- * @return the hash code value for this the cache.
- */
- public int hashCode();
-
- /**
- * @return true if entrySet().isEmpty() returns true.
- */
- public boolean isEmpty();
-
- /**
- * Returns a set view of the keys currently contained in the cache. A
- * CacheLoader will not be called. The behavior is unspecified for the
- * case when an object is remove from the cache while the return set is
- * being traversed.
- */
- public Set<Object> keySet();
-
- /**
- * Copies all of the mappings from the specified map to the cache. This
- * would be equivalent to t.entrySet() then iterating through the Set and
- * calling put with each key value pair.
- */
- public void putAll(Map<? extends Object, ? extends Object> t);
-
- /**
- * @return the number of objects in the cache. This should be the same
- * value as entrySet().size();
- */
- public int size();
-
- /**
- * @return a collection view of the values contained in the cache.
- */
- public Collection<Object> values();
-
- /**
- * The get method will return, from the cache, the object associated with
- * the argument "key". If the object is not in the cache, the associated
- * cache loader will be called. If no loader is associated with the object,
- * a null is returned. If a problem is encountered during the retrieving
- * or loading of the object, an exception (to be defined) will be thrown.
- * If the "arg" argument is set, the arg object will be passed to the
- * CacheLoader.load method. The cache will not dereference the object.
- * If no "arg" value is provided a null will be passed to the load method.
- * The storing of null values in the cache is permitted, however, the get
- * method will not distinguish returning a null stored in the cache and
- * not finding the object in the cache. In both cases a null is returned.
- * @throws CacheException
- */
- public Object get(Object key, Object context) throws CacheException;
-
- /**
- * The load method provides a means to "pre load" the cache. This method
- * will, asynchronously, load the specified object into the cache using
- * the associated cacheloader. If the object already exists in the cache,
- * no action is taken. If no loader is associated with the object, no object
- * will be loaded into the cache. If a problem is encountered during the
- * retrieving or loading of the object, an exception should
- * be logged.
- * If the "arg" argument is set, the arg object will be passed to the
- * CacheLoader.load method. The cache will not dereference the object. If
- * no "arg" value is provided a null will be passed to the load method.
- * The storing of null values in the cache is permitted, however, the get
- * method will not distinguish returning a null stored in the cache and not
- * finding the object in the cache. In both cases a null is returned.
- */
- public void load(Object key, Object context) throws CacheException;
-
- /**
- * The peek method will return the object associated with "key" if it
- * currently exists (and is valid) in the cache. If not, a null is
- * returned. With "peek" the CacheLoader will not be invoked and other
- * caches in the system will not be searched.
- */
- public Object peek(Object key);
-
- /**
- * The put method adds the object "value" to the cache identified by the
- * object "key".
- */
- public Object put(Object key, Object value);
-
- /**
- * Returns the CacheEntry object associated with the object identified by
- * "key". If the object is not in the cache a null is returned.
- */
- public CacheEntry getCacheEntry(Object key);
-
- /**
- * The remove method will delete the object from the cache including the
- * key, the associated value and the associated CacheStatistics object.
- */
- public Object remove(Object key);
-
- /**
- * The clear method will remove all objects from the cache including the
- * key, the associated value and the associated CacheStatistics object.
- */
- public void clear();
-
- /**
- * The evict method will remove objects from the cache that are no longer
- * valid. Objects where the specified expiration time has been reached.
- */
- public void evict();
-
- /** Add a listener to the list of cache listeners */
- public void addListener(CacheListener listener);
-
- /** Remove a listener from the list of cache listeners */
- public void removeListener(CacheListener listener);
-}
Deleted:
framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheConfigurationLoader.java
===================================================================
---
framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheConfigurationLoader.java 2009-07-09
16:24:53 UTC (rev 14867)
+++
framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheConfigurationLoader.java 2009-07-09
18:04:10 UTC (rev 14868)
@@ -1,33 +0,0 @@
-/**
- * License Agreement.
- *
- * Rich Faces - Natural Ajax for Java Server Faces (JSF)
- *
- * Copyright (C) 2007 Exadel, Inc.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License version 2.1 as published by the Free Software Foundation.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- */
-
-package org.ajax4jsf.cache;
-
-import java.util.Properties;
-
-/**
- * @author Nick Belaevski - nbelaevski(a)exadel.com
- * created 02.05.2007
- *
- */
-public interface CacheConfigurationLoader {
- public Properties loadProperties(String name);
-}
Deleted: framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheEntry.java
===================================================================
--- framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheEntry.java 2009-07-09
16:24:53 UTC (rev 14867)
+++ framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheEntry.java 2009-07-09
18:04:10 UTC (rev 14868)
@@ -1,45 +0,0 @@
-/*
- * Copyright [yyyy] [name of copyright owner].
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *
http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.ajax4jsf.cache;
-
-import java.util.Map;
-
-/**
- * CacheEntry
- *
- * @author Brian Goetz
- */
-public interface CacheEntry extends Map.Entry {
-
- int getHits();
-
- long getLastAccessTime();
- long getLastUpdateTime();
- long getCreationTime();
- long getExpirationTime();
-
- /**
- * Returns a version counter.
- * An implementation may use timestamps for this or an incrementing
- * number. Timestamps usually have issues with granularity and are harder
- * to use across clusteres or threads, so an incrementing counter is often safer.
- */
- long getVersion();
-
- boolean isValid();
- long getCost();
-}
Deleted: framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheException.java
===================================================================
--- framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheException.java 2009-07-09
16:24:53 UTC (rev 14867)
+++ framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheException.java 2009-07-09
18:04:10 UTC (rev 14868)
@@ -1,59 +0,0 @@
-/*
- * Copyright [yyyy] [name of copyright owner].
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *
http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.ajax4jsf.cache;
-
-
-/**
- * CacheException is a generic exception, which indicates
- * a cache error has occurred. All the other cache exceptions are the
- * subclass of this class. All the methods in the cache package only
- * throw CacheException or the sub class of it.
- * <P>
- *
- */
-public class CacheException extends Exception
-{
- /**
- *
- */
- private static final long serialVersionUID = 6712594794189413065L;
-
- /**
- * Constructs a new CacheException.
- */
- public CacheException()
- {
- super();
- }
-
- /**
- * Constructs a new CacheException with a message string.
- */
- public CacheException(String s)
- {
- super(s);
- }
-
- /**
- * Constructs a CacheException with a message string, and
- * a base exception
- */
- public CacheException(String s, Throwable ex)
- {
- super(s, ex);
- }
-}
Deleted: framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheFactory.java
===================================================================
--- framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheFactory.java 2009-07-09
16:24:53 UTC (rev 14867)
+++ framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheFactory.java 2009-07-09
18:04:10 UTC (rev 14868)
@@ -1,38 +0,0 @@
-/*
- * Copyright [yyyy] [name of copyright owner].
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *
http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.ajax4jsf.cache;
-
-import java.util.Map;
-
-/**
- * CacheFactory is a service provider specific interface.
- * Service provider should implement CacheFactory to provide
- * the functionality to create a new implementation specific Cache object.
- */
-public interface CacheFactory
-{
- /**
- * creates a new implementation specific Cache object using the env parameters.
- * @param env implementation specific environment parameters passed to the
- * CacheFactory.
- * @param cacheLoader implementation of the {@link CacheLoader} to use
- * @param cacheConfigurationloader TODO
- * @return an implementation specific Cache object.
- * @throws CacheException if any error occurs.
- */
- public Cache createCache(Map env, CacheLoader cacheLoader, CacheConfigurationLoader
cacheConfigurationloader) throws CacheException;
-}
Deleted: framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheListener.java
===================================================================
--- framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheListener.java 2009-07-09
16:24:53 UTC (rev 14867)
+++ framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheListener.java 2009-07-09
18:04:10 UTC (rev 14868)
@@ -1,36 +0,0 @@
-/*
- * Copyright [yyyy] [name of copyright owner].
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *
http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.ajax4jsf.cache;
-
-/** Interface describing various events that can happen as elements are added to
- * or removed from a cache
- */
-public interface CacheListener {
- /** Triggered when a cache mapping is created due to the cache loader being consulted
*/
- public void onLoad(Object key);
-
- /** Triggered when a cache mapping is created due to calling Cache.put() */
- public void onPut(Object key);
-
- /** Triggered when a cache mapping is removed due to eviction */
- public void onEvict(Object key);
-
- /** Triggered when a cache mapping is removed due to calling Cache.remove() */
- public void onRemove(Object key);
-
- public void onClear();
-}
Deleted: framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheLoader.java
===================================================================
--- framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheLoader.java 2009-07-09
16:24:53 UTC (rev 14867)
+++ framework/trunk/api/src/main/java/org/ajax4jsf/cache/CacheLoader.java 2009-07-09
18:04:10 UTC (rev 14868)
@@ -1,40 +0,0 @@
-/*
- * Copyright [yyyy] [name of copyright owner].
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *
http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.ajax4jsf.cache;
-
-
-/**
- * User should implement this CacheLoader interface to
- * provide a loader object to load the objects into cache.
- */
-public interface CacheLoader
-{
- /**
- * loads an object. Application writers should implement this
- * method to customize the loading of cache object. This method is called
- * by the caching service when the requested object is not in the cache.
- * <P>
- *
- * @param key the key identifying the object being loaded
- *
- * @return The object that is to be stored in the cache.
- * @throws CacheException
- *
- */
- public Object load(Object key, Object context) throws CacheException;
-
-}