org.jboss.as.ejb3.cache.PassivationManager 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;

import org.jboss.as.clustering.VersionedMarshallingConfiguration;

/**
 * Manages passivation and replication lifecycle callbacks on an object.
 *
 * @author Carlo de Wolf
 * @author Paul Ferraro
 */
public interface PassivationManager> extends VersionedMarshallingConfiguration {
    /**
     * This method is called after an object has been retrieved deserialized after passivation.
     * @param obj the object
     */
    void postActivate(V obj);

    /**
     * This method is called before an object is serialized for passivation.
     * @param obj the object
     * @throws IllegalStateException if obj, or another object in the same serialization group as obj,
     *         is in use. Checking if an object is in use and throwing this exception is not required, so callers should not
     *         assume it will be thrown.
     */
    void prePassivate(V obj);
}