Anonymous avatar Anonymous committed c9b749e

Final tweaks for the 2.0 final release
- Tidied up the properties files
- Split the distribution into a binary release and a full release (includes source and libraries required to build)
- Moved commons-collections.jar into the core directory

Comments (0)

Files changed (10)

     <!-- project properties -->
     <property name="name" value="oscache"/>
     <property name="Name" value="OSCache"/>
-    <property name="version" value="2.0.0b2"/>
-    <property name="zip_version" value="2_0_0b2"/>
+    <property name="version" value="2.0"/>
+    <property name="zip_version" value="2_0"/>
 
     <!-- directory properties -->
     <property name="build.dir" value="build"/>
   </target>
 
 
-  <!-- Create the distribution zip -->
+  <!-- Create the distribution zip files -->
   <target name="dist" depends="clean, jar, doc">
     <mkdir dir="${tmp.dir}/doc"/>
     <mkdir dir="${tmp.dir}/src"/>
     <copy file="readme.txt" tofile="${tmp.dir}/readme.txt" failonerror="false"/>
     <copy file="changes.txt" tofile="${tmp.dir}/changes.txt" failonerror="false"/>
 
-    <zip zipfile="${dist.dir}/${name}_${zip_version}.zip" basedir="${tmp.dir}" includes="**"/>
+    <zip zipfile="${dist.dir}/${name}_${zip_version}_full.zip" basedir="${tmp.dir}" includes="**"/>
+
+    <delete dir="${tmp.dir}/src"/>
+    <delete dir="${tmp.dir}/lib/build"/>
+    <delete dir="${tmp.dir}/lib/plugins"/>
+    <zip zipfile="${dist.dir}/${name}_${zip_version}_binary.zip" basedir="${tmp.dir}" includes="**"/>
 
     <delete dir="${tmp.dir}"/>
   </target>
 -------------
 Bug fixes:
 - [CACHE-52] Fixed a problem that caused no output on Tomcat for small JSP files.
+- [CACHE-53] Updated documentation to explain that a PersistenceListener must
+  be specified to enable caching to disk.
 - [CACHE-55] JMS was throwing an exception on Weblogic.
 - Altering the cache capacity on the fly using the administrator classes wasn't
   working correctly.
 - Minor FastCronParser speedup.
 - Made ClusterNotification constants public.
 - Dropped some of the logging levels from INFO down to DEBUG.
+- Release has been split into two - a binary release and a full release (includes source).
 
 
 OSCACHE 2.0 (beta 2)
Add a comment to this file

lib/build/commons-collections.jar

Binary file removed.

Add a comment to this file

lib/core/commons-collections.jar

Binary file added.

src/core/etc/oscache.properties

-# CACHE DIRECTORY
-#
-# This is the directory on disk where caches will be stored.
-# it will be created if it doesn't already exist, but OSache
-# must be able to write to here.
-#
-# If you want to disable file caching, just comment out or remove this line.
-# Note: for Windows machines, this needs \ to be escaped
-# ie Windows:
-# cache.path=c:\\myapp\\cache
-# or *ix:
-# cache.path=/opt/myapp/cache
-
-
 # CACHE IN MEMORY
 #
-# If you want to disable memory caching, just comment out or remove this line.
-# Note: disabling memory AND disk caching is possible but fairly stupid ;)
+# If you want to disable memory caching, just uncomment this line.
 #
 # cache.memory=false
 
 
 # CACHE LISTENERS
 #
+# These hook OSCache events and perform various actions such as logging
+# cache hits and misses, or broadcasting to other cache instances across a cluster.
+# See the documentation for further information.
+#
 # cache.event.listeners=com.opensymphony.oscache.plugins.clustersupport.JMSBroadcastingListener,  \
 #                       com.opensymphony.oscache.extra.CacheEntryEventListenerImpl,               \
 #                       com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl,           \
 
 # CACHE PERSISTENCE CLASS
 #
-# Specify the class to use for persistence.
+# Specify the class to use for persistence. If you use the supplied DiskPersistenceListener,
+# don't forget to supply the cache.path property to specify the location of the cache
+# directory.
+# 
+# If a persistence class is not specified, OSCache will use memory caching only.
 #
 # cache.persistence.class=com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener
 
 
+# CACHE DIRECTORY
+#
+# This is the directory on disk where caches will be stored by the DiskPersistenceListener.
+# it will be created if it doesn't already exist. Remember that OSCache must have
+# write permission to this directory.
+#
+# Note: for Windows machines, this needs \ to be escaped
+# ie Windows:
+# cache.path=c:\\myapp\\cache
+# or *ix:
+# cache.path=/opt/myapp/cache
+#
+# cache.path=c:\\app\\cache
+
+
 # CACHE ALGORITHM
 #
 # Default cache algorithm to use. Note that in order to use an algorithm
 # the cache size must also be specified. If the cache size is not specified,
 # the cache algorithm will be Unlimited cache.
 #
+# cache.algorithm=com.opensymphony.oscache.base.algorithm.LRUCache
 # cache.algorithm=com.opensymphony.oscache.base.algorithm.FIFOCache
+# cache.algorithm=com.opensymphony.oscache.base.algorithm.UnlimitedCache
 
 
 # CACHE SIZE
 #
-# Default cache size in number of item. If a size is specified but not
+# Default cache size in number of items. If a size is specified but not
 # an algorithm, the cache algorithm used will be LRUCache.
 #
 cache.capacity=1000
 
 
 # CACHE UNLIMITED DISK
-# Use unlimited disk cache or not
+# Use unlimited disk cache or not. The default value is false, which means
+# the disk cache will be limited in size to the value specified by cache.capacity.
+#
 # cache.unlimited.disk=false
 
 
 #cache.cluster.jms.topic.name=java:comp/env/jms/OSCacheTopic
 #cache.cluster.jms.node.name=node1
 
+
 # JAVAGROUPS CLUSTER PROPERTIES
 #
 # Configuration properites for the JavaGroups clustering. Only one of these
 # (www.javagroups.com) for more information on these settings.
 #
 #cache.cluster.properties=UDP(mcast_addr=231.12.21.132;mcast_port=45566;ip_ttl=32;mcast_send_buf_size=150000;mcast_recv_buf_size=80000):PING(timeout=2000;num_initial_members=3):MERGE2(min_interval=5000;max_interval=10000):FD_SOCK:VERIFY_SUSPECT(timeout=1500):pbcast.NAKACK(gc_lag=50;retransmit_timeout=300,600,1200,2400,4800):pbcast.STABLE(desired_avg_gossip=20000):UNICAST(timeout=5000):FRAG(frag_size=8096;down_thread=false;up_thread=false):pbcast.GMS(join_timeout=5000;join_retry_timeout=2000;shun=false;print_local_addr=true)
-#cache.cluster.multicast.ip=231.12.21.132
+#cache.cluster.multicast.ip=231.12.21.132

src/core/test/oscacheMemoryOnly.properties

-# CACHE DIRECTORY
-# cache.path=c:\\cachetagscache
-
 # CACHE IN MEMORY
 cache.memory=true
 

src/plugins/clustersupport/test/oscacheCluster.properties

-# CACHE DIRECTORY
-cache.path=/tmp/cachetagscache
-
 # LISTENERS
 cache.event.listeners=com.opensymphony.oscache.plugins.clustersupport.JavaGroupsBroadcastingListener
 

src/plugins/diskpersistence/test/oscacheDiskAndMemory.properties

-# CACHE DIRECTORY
-cache.path=/tmp/cachetagscache
-
 # CACHE IN MEMORY
 cache.memory=true
 
 cache.capacity=100
 
 # CACHE PERSISTENCE CLASS
-cache.persistence.class=com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener
+cache.persistence.class=com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener
+
+# CACHE DIRECTORY
+cache.path=/tmp/cachetagscache

src/plugins/diskpersistence/test/oscacheDiskOnly.properties

-# CACHE DIRECTORY
-cache.path=/tmp/cachetagscache
-
 # CACHE IN MEMORY
 cache.memory=false
 
 # CACHE PERSISTENCE CLASS
-cache.persistence.class=com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener
+cache.persistence.class=com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener
+
+# CACHE DIRECTORY
+cache.path=/tmp/cachetagscache

src/webapp/WEB-INF/classes/oscache.properties

-# CACHE DIRECTORY
-#
-# This is the directory on disk where caches will be stored.
-# it will be created if it doesn't already exist, but OSache
-# must be able to write to here.
-#
-# If you want to disable file caching, just comment out or remove this line.
-# Note: for Windows machines, this needs \ to be escaped
-# ie Windows:
-# cache.path=c:\\myapp\\cache
-# or *ix:
-# cache.path=/opt/myapp/cache
-#
-# cache.path=c:\\cachetagscache
-
 # CACHE IN MEMORY
 #
-# If you want to disable memory caching, just comment out or remove this line.
-# Note: disabling memory AND disk caching is possible but fairly stupid ;)
+# If you want to disable memory caching, just uncomment this line.
 #
 # cache.memory=false
 
+
 # CACHE KEY
 #
 # This is the key that will be used to store the cache in the application
 #
 # cache.key=__oscache_cache
 
+
 # USE HOST DOMAIN NAME IN KEY
 #
 # Servers for multiple host domains may wish to add host name info to
 #
 # cache.use.host.domain.in.key=true
 
+
 # CACHE LISTENERS
 #
+# These hook OSCache events and perform various actions such as logging
+# cache hits and misses, or broadcasting to other cache instances across a cluster.
+# See the documentation for further information.
+#
 # cache.event.listeners=com.opensymphony.oscache.plugins.clustersupport.JMSBroadcastingListener,  \
 #                       com.opensymphony.oscache.extra.CacheEntryEventListenerImpl,               \
 #                       com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl,           \
 #                       com.opensymphony.oscache.extra.ScopeEventListenerImpl
 
+
 # CACHE PERSISTENCE CLASS
 #
-# Specify the class to use for persistence.
+# Specify the class to use for persistence. If you use the supplied DiskPersistenceListener,
+# don't forget to supply the cache.path property to specify the location of the cache
+# directory.
+# 
+# If a persistence class is not specified, OSCache will use memory caching only.
 #
 # cache.persistence.class=com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener
 
+
+# CACHE DIRECTORY
+#
+# This is the directory on disk where caches will be stored by the DiskPersistenceListener.
+# it will be created if it doesn't already exist. Remember that OSCache must have
+# write permission to this directory.
+#
+# Note: for Windows machines, this needs \ to be escaped
+# ie Windows:
+# cache.path=c:\\myapp\\cache
+# or *ix:
+# cache.path=/opt/myapp/cache
+#
+# cache.path=c:\\app\\cache
+
+
 # CACHE ALGORITHM
 #
 # Default cache algorithm to use. Note that in order to use an algorithm
 # the cache size must also be specified. If the cache size is not specified,
 # the cache algorithm will be Unlimited cache.
 #
+# cache.algorithm=com.opensymphony.oscache.base.algorithm.LRUCache
 # cache.algorithm=com.opensymphony.oscache.base.algorithm.FIFOCache
+# cache.algorithm=com.opensymphony.oscache.base.algorithm.UnlimitedCache
+
 
 # CACHE SIZE
 #
-# Default cache size in number of item. If a size is specified but not
+# Default cache size in number of items. If a size is specified but not
 # an algorithm, the cache algorithm used will be LRUCache.
 #
 cache.capacity=1000
 
+
 # CACHE UNLIMITED DISK
-# Use unlimited disk cache or not
-# cache.unlimited.disk=false
+# Use unlimited disk cache or not. The default value is false, which means
+# the disk cache will be limited in size to the value specified by cache.capacity.
+#
+# cache.unlimited.disk=false
+
+
+# JMS CLUSTER PROPERTIES
+#
+# Configuration properties for JMS clustering. See the clustering documentation
+# for more information on these settings.
+#
+#cache.cluster.jms.topic.factory=java:comp/env/jms/TopicConnectionFactory
+#cache.cluster.jms.topic.name=java:comp/env/jms/OSCacheTopic
+#cache.cluster.jms.node.name=node1
+
+
+# JAVAGROUPS CLUSTER PROPERTIES
+#
+# Configuration properites for the JavaGroups clustering. Only one of these
+# should be specified. Default values (as shown below) will be used if niether
+# property is set. See the clustering documentation and the JavaGroups project
+# (www.javagroups.com) for more information on these settings.
+#
+#cache.cluster.properties=UDP(mcast_addr=231.12.21.132;mcast_port=45566;ip_ttl=32;mcast_send_buf_size=150000;mcast_recv_buf_size=80000):PING(timeout=2000;num_initial_members=3):MERGE2(min_interval=5000;max_interval=10000):FD_SOCK:VERIFY_SUSPECT(timeout=1500):pbcast.NAKACK(gc_lag=50;retransmit_timeout=300,600,1200,2400,4800):pbcast.STABLE(desired_avg_gossip=20000):UNICAST(timeout=5000):FRAG(frag_size=8096;down_thread=false;up_thread=false):pbcast.GMS(join_timeout=5000;join_retry_timeout=2000;shun=false;print_local_addr=true)
+#cache.cluster.multicast.ip=231.12.21.132
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.