Skip to content
ehcache
Ruby JavaScript
Find file
Latest commit 001bef7 Sep 2, 2012 Jason Voegele Update version to 1.3.2.
Failed to load latest commit information.
bin Support standalone ActiveSupport::Cache usage of Ehcache Nov 5, 2011
config More complete YAML configuration support. Nov 3, 2010
examples Added examples directory with simple example. Oct 28, 2010
ext Support off-heap store and distributed caching. Mar 20, 2012
lib Update version to 1.3.2. Sep 2, 2012
script initial commit Jun 12, 2008
spec added ehcache_store, and simplified rails install Jul 3, 2008
src/net/sf/ehcache Support off-heap store and distributed caching. Mar 20, 2012
tasks initial commit Jun 12, 2008
test More complete YAML config plus a bit of documentation. Nov 3, 2010
website add some simple memcache-like aliases for compatibility sake Jul 3, 2008
.gitignore Add *.gem to git ignore. Sep 2, 2012
Gemfile Add bundler support Nov 3, 2011
Gemfile.lock Update version to 1.3.2. Sep 2, 2012
History.txt small fixes Aug 20, 2008
License.txt Added self to copyright notices. Nov 15, 2010
Manifest.txt add some simple memcache-like aliases for compatibility sake Jul 3, 2008
PostInstall.txt add some simple memcache-like aliases for compatibility sake Jul 3, 2008
README.txt Adding Gemfile install instructions to README Apr 16, 2012
Rakefile Removing Jeweler and using straight Bundler instead. Also tidied up a… Mar 21, 2012
VERSION Update version to 1.3.2. Sep 2, 2012
jruby-ehcache-rails2.gemspec Remove date specification from gemspecs. Sep 2, 2012
jruby-ehcache-rails3.gemspec Remove date specification from gemspecs. Sep 2, 2012
jruby-ehcache.gemspec Remove date specification from gemspecs. Sep 2, 2012

README.txt

= jruby-ehcache - Ehcache for JRuby

http://github.com/dylanz/ehcache

== DESCRIPTION:

jruby-ehcache is a JRuby interface to Java's (JSR-107 compliant) Ehcache.
It provides 100% full coverage of the native Ehcache API and also provides
some Rubyesque enhancements to make it idiomatic to Ruby developers.
Configuration is done with the traditional ehcache.xml file that Java
developers use.

Some biased and non-biased Ehcache VS Memcache articles:
http://gregluck.com/blog/archives/2007/05/comparing_memca.html
http://feedblog.org/2007/05/21/unfair-benchmarks-of-ehcache-vs-memcached
http://blog.aristotlesdog.com/2008/05/01/memcached_vs_ehcache/
http://www.hugotroche.com/my_weblog/2008/06/ehcache-vs-memc.html

For more information on Ehcache, see:
http://www.ehcache.org/

Configuration, Code Samples and everything else, see:
http://ehcache.org/documentation/index.html

Google Groups:
http://groups.google.com/group/ehcache-jruby

Tickets:
http://dylanz.lighthouseapp.com/projects/14518-ehcache-jruby/overview


== BASIC USAGE:
require 'ehcache'
manager = CacheManager.new
cache = manager.cache
cache.put("key", "value", {:ttl => 120})
cache.get("key")  # => returns the Ehcache Element object
cache["key"]      # => returns "value", the value of the Element
manager.shutdown


== RAILS:

Rails 2 and Rails 3 integration are provided by the separate
jruby-ehcache-rails2 and jruby-ehcache-rails3 gems.  To install, choose the
correct version for your Rails application and use JRuby's gem command to
install, e.g.:

$ jgem install jruby-ehcache-rails3
OR
$ jruby -S gem install jruby-ehcache-rails3


== GEMFILE:

Add the gem as you normally would in your Gemfile, making sure to require
'ehcache' explicitly.  Here is an example of adding the rails3 gem to a Gemfile.

gem 'jruby-ehcache-rails3', :require => 'ehcache'



== REQUIREMENTS:

Tested with JRuby 1.5.3.


== INSTALL:

$ sudo jruby -S gem install jruby-ehcache


== LICENSE:
Copyright (c) 2008 - 2010 Dylan Stamat <dstamat@elctech.com> and
                          Jason Voegele <jason@jvoegele.com>

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.