org.jboss.as.ejb3.cache.spi.PassivatingBackingCache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-as-ejb3
The newest version!
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2007, Red Hat Middleware LLC, and individual contributors as indicated
 * by the @authors tag. See the copyright.txt 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.spi;

import java.io.Serializable;

import org.jboss.as.ejb3.cache.Cacheable;

/**
 * A {@link BackingCache} which passivates unused objects.
 * 
 * A PassivatingBackingCache is linked to a some sort of persistent store to store the passivated object and to a
 * PassivationManager to manage lifecycle callbacks on the object.
 * 
 *
 * @see BackingCacheEntryStore
 *
 * @author Carlo de Wolf
 * @author Brian Stansberry
 * @author Paul Ferraro
 */
public interface PassivatingBackingCache, E extends BackingCacheEntry> extends BackingCache, Passivatable {
    /**
     * Gets any {@link GroupCompatibilityChecker} this cache is using.
     *
     * @return the checker, or null if this cache is not using one.
     */
    GroupCompatibilityChecker getCompatibilityChecker();
}