1 /** 2 * Redistribution and use of this software and associated documentation 3 * ("Software"), with or without modification, are permitted provided 4 * that the following conditions are met: 5 * 6 * 1. Redistributions of source code must retain copyright 7 * statements and notices. Redistributions must also contain a 8 * copy of this document. 9 * 10 * 2. Redistributions in binary form must reproduce the 11 * above copyright notice, this list of conditions and the 12 * following disclaimer in the documentation and/or other 13 * materials provided with the distribution. 14 * 15 * 3. The name "Exolab" must not be used to endorse or promote 16 * products derived from this Software without prior written 17 * permission of Exoffice Technologies. For written permission, 18 * please contact info@exolab.org. 19 * 20 * 4. Products derived from this Software may not be called "Exolab" 21 * nor may "Exolab" appear in their names without prior written 22 * permission of Exoffice Technologies. Exolab is a registered 23 * trademark of Exoffice Technologies. 24 * 25 * 5. Due credit should be given to the Exolab Project 26 * (http://www.exolab.org/). 27 * 28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS 29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT 30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 39 * OF THE POSSIBILITY OF SUCH DAMAGE. 40 * 41 * Copyright 1999 (C) Exoffice Technologies Inc. All Rights Reserved. 42 * 43 * $Id: PassivationStrategy.java 1096 2004-03-26 21:41:16Z dblevins $ 44 */ 45 46 47 package org.openejb.core.stateful; 48 49 50 import java.util.Hashtable; 51 import java.util.Properties; 52 53 /** 54 This interface is implemented to provide a passivation strategy for stateful 55 session beans. 56 57 */ 58 public interface PassivationStrategy { 59 60 /** @throws org.openejb.SystemException if an argument is invalid, e.g. a non-existing directory for passivation 61 */ 62 public void init(Properties props) throws org.openejb.SystemException; 63 64 /** 65 If the PassivationStrategy operates is own thread for serializing 66 beans to disk, then it must use the IntraVmCopyMonitor.prePassivationOperation() and 67 IntraVmCopyMonitor.postPassivationOperation() methods to demarcate the start and 68 end of serialization of bean instance(s). 69 */ 70 public void passivate(Hashtable stateTable) 71 throws org.openejb.SystemException; 72 73 /** 74 The implementation must NOT use a separate thread to deserialize or otherwise 75 retrieve the instance when this method is called. It must use the current thread, 76 OR associate the calling thread's ThreadContext with the new thread that is 77 deserializing the instance. The reason for this is that IvmContext are replaced with 78 JndiEncArtivacts when serialized. These artifacts depend on the correct DeploymentInfo 79 object being in the thread when its deserialized so that the artifact can replace itself 80 with the correct IvmContext. 81 82 Preserving the JNDI ENC context is required by the EJB 1.1 specification section 6.4.1. 83 */ 84 public Object activate(Object primaryKey) 85 throws org.openejb.SystemException; 86 87 } 88