/*
* JBoss, Home of Professional Open Source.
* Copyright 2007, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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 software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.ejb3.cache;
import org.wildfly.clustering.ejb.AffinitySupport;
import org.wildfly.clustering.ejb.IdentifierFactory;
/**
* Cache a stateful object and make sure any life cycle callbacks are
* called at the appropriate time.
*
* @author <a href="mailto:carlo.dewolf@jboss.com">Carlo de Wolf</a>
*/
public interface Cache<K, V extends Identifiable<K>> extends AffinitySupport<K>, IdentifierFactory<K> {
ThreadLocal<Object> CURRENT_GROUP = new ThreadLocal<>();
/**
* Creates and caches a new instance of <code>T</code>.
*
* @return a new <code>T</code>
*/
V create();
/**
* Get the specified object from cache. This will mark
* the object as being in use, and increase its usage count.
*
* @param key the identifier of the object
* @return the object, or null if it does not exist
*/
V get(K key);
/**
* Decreases the objects usage count. If the usage count hits 0 then the object will be released.
*
* @param obj the object
*/
void release(V obj);
/**
* Indicates whether or not the specified key is contained within this cache.
* @param key the cache key
* @return <code>true</code> if the key is present in the cache, <code>false</code> otherwise.
*/
boolean contains(K key);
/**
* Discard the specified object from cache.
*
* @param obj the object to discard
*/
void discard(V obj);
/**
* Remove and destroy the specified object from cache.
*
* @param key the identifier of the object
*/
void remove(K key);
/**
* Start the cache.
*/
void start();
/**
* Stop the cache.
*/
void stop();
int getCacheSize();
int getPassivatedCount();
int getTotalSize();
/**
* Checks whether the supplied {@link Throwable} is remotable meaning it can be safely sent to the client over the wire.
*/
default boolean isRemotable(Throwable throwable) {
return true;
}
}