All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.sf.ehcache.exceptionhandler.CacheExceptionHandler Maven / Gradle / Ivy

Go to download

This is the ehcache core module. Pair it with other modules for added functionality.

There is a newer version: 2.6.11
Show newest version
/**
 *  Copyright 2003-2010 Terracotta, Inc.
 *
 *  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 net.sf.ehcache.exceptionhandler;

import net.sf.ehcache.Ehcache;

/**
 * A handler which may be registered with an Ehcache, to handle exceptions on Cache operations.
 * 

* Handlers may be registered at configuration time in ehcache.xml, using a CacheExceptionHandlerFactory, or * set at runtime (a strategy). *

* If an exception handler is registered, the default behaviour of throwing the exception will not occur. The handler * method onException will be called. Of course, if the handler decides to throw the exception, it will * propagate up through the call stack. If the handler does not, it won't. *

* Some common Exceptions thrown, and which therefore should be considered when implementing this class are listed below: *

    *
  • {@link IllegalStateException} if the cache is not {@link net.sf.ehcache.Status#STATUS_ALIVE} *
  • {@link IllegalArgumentException} if an attempt is made to put a null element into a cache *
  • {@link net.sf.ehcache.distribution.RemoteCacheException} if an issue occurs in remote synchronous replication *
  • *
  • *
* * @author Greg Luck * @version $Id: CacheExceptionHandler.java 2154 2010-04-06 02:45:52Z cdennis $ */ public interface CacheExceptionHandler { /** * Called if an Exception occurs in a Cache method. This method is not called * if an Error occurs. * * @param ehcache the cache in which the Exception occurred * @param key the key used in the operation, or null if the operation does not use a key or the key was null * @param exception the Exception caught. */ void onException(Ehcache ehcache, Object key, Exception exception); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy