/**
 * Redistribution and use of this software and associated documentation
 * ("Software"), with or without modification, are permitted provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain copyright
 *    statements and notices.  Redistributions must also contain a
 *    copy of this document.
 *
 * 2. Redistributions in binary form must reproduce the
 *    above copyright notice, this list of conditions and the
 *    following disclaimer in the documentation and/or other
 *    materials provided with the distribution.
 *
 * 3. The name "Exolab" must not be used to endorse or promote
 *    products derived from this Software without prior written
 *    permission of Exoffice Technologies.  For written permission,
 *    please contact info@exolab.org.
 *
 * 4. Products derived from this Software may not be called "Exolab"
 *    nor may "Exolab" appear in their names without prior written
 *    permission of Exoffice Technologies. Exolab is a registered
 *    trademark of Exoffice Technologies.
 *
 * 5. Due credit should be given to the Exolab Project
 *    (http://www.exolab.org/).
 *
 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Copyright 1999 (C) Exoffice Technologies Inc. All Rights Reserved.
 *
 * $Id: PassivationStrategy.java,v 1.2 2002/02/25 20:31:00 dblevins Exp $
 */


package org.openejb.core.stateful;


import java.util.Hashtable;
import java.util.Properties;

/**
This interface is implemented to provide a passivation strategy for stateful
session beans.  

*/
public interface PassivationStrategy {
    
    /** @throws org.openejb.SystemException if an argument is invalid, e.g. a non-existing directory for passivation
     */
    public void init(Properties props) throws org.openejb.SystemException;
    
    /**
        If the PassivationStrategy operates is own thread for serializing
        beans to disk, then it must use the IntraVmCopyMonitor.prePassivationOperation() and
        IntraVmCopyMonitor.postPassivationOperation() methods to demarcate the start and 
        end of serialization of bean instance(s).
    */
    public void passivate(Hashtable stateTable)
    throws org.openejb.SystemException;
        
    /**
        The implementation must NOT use a separate thread to deserialize or otherwise 
        retrieve the instance when this method is called. It must use the current thread,
        OR associate the calling thread's ThreadContext with the new thread that is 
        deserializing the instance. The reason for this is that IvmContext are replaced with
        JndiEncArtivacts when serialized. These artifacts depend on the correct DeploymentInfo
        object being in the thread when its deserialized so that the artifact can replace itself
        with the correct IvmContext.
        
        Preserving the JNDI ENC context is required by the EJB 1.1 specification section 6.4.1.
    */
    public Object activate(Object primaryKey)
    throws org.openejb.SystemException;
    
}
