/*
 * JBoss, Home of Professional Open Source
 * Copyright 2005, JBoss Inc., 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 javax.ejb.spi;

import javax.ejb.EJBHome;
import javax.ejb.EJBObject;

/**
 * <P>The HandleDelegate interface is implemented by the EJB container. 
 * It is used by portable implementations of javax.ejb.Handle and
 * javax.ejb.HomeHandle. It is not used by EJB components or by client components.
 * It provides methods to serialize and deserialize EJBObject and EJBHome
 * references to streams.</P>
 *
 * <P>The HandleDelegate object is obtained by JNDI lookup at the reserved name
 * "java:comp/HandleDelegate".</P>
 */
public interface HandleDelegate {

  /**
   * <P>Serialize the EJBObject reference corresponding to a Handle.</P>
   *
   * <P>This method is called from the writeObject method of portable
   * Handle implementation classes. The ostream object is the same
   * object that was passed in to the Handle class's writeObject.</P>
   *
   * @param ejbObject - The EJBObject reference to be serialized.
   * @param ostream - The output stream.
   * @exception java.io.IOException - The EJBObject could not be serialized
   *                                  because of a system-level failure.
   */
  public void writeEJBObject(EJBObject ejbObject,
                             java.io.ObjectOutputStream ostream)
    throws java.io.IOException;


  /**
   * <P>Deserialize the EJBObject reference corresponding to a Handle.</P>
   *
   * <P>readEJBObject is called from the readObject method of portable
   * Handle implementation classes. The istream object is the same object
   * that was passed in to the Handle class's readObject. When readEJBObject
   * is called, istream must point to the location in the stream at which
   * the EJBObject reference can be read. The container must ensure that
   * the EJBObject reference is capable of performing invocations immediately
   * after deserialization.</P>
   * 
   * @param istream - The input stream.
   * @return The deserialized EJBObject reference.
   * @exception java.io.IOException - The EJBObject could not be deserialized
   *                                  because of a system-level failure.
   * @exception java.lang.ClassNotFoundException - The EJBObject could not be
   *                                               deserialized because some
   *                                               class could not be found.
   */
  public EJBObject readEJBObject(java.io.ObjectInputStream istream)
    throws java.io.IOException, java.lang.ClassNotFoundException;

  /**
   * <P>Serialize the EJBHome reference corresponding to a HomeHandle.</P>
   *
   * <P>This method is called from the writeObject method of portable HomeHandle
   * implementation classes. The ostream object is the same object that was
   * passed in to the Handle class's writeObject.</P>
   *
   * @param ejbHome - The EJBHome reference to be serialized.
   * @param ostream - The output stream.
   * @exception java.io.IOException - The EJBObject could not be serialized
   *                                  because of a system-level failure.
   */
  public void writeEJBHome(EJBHome ejbHome,
                           java.io.ObjectOutputStream ostream)
    throws java.io.IOException;

  /**
   * <P>Deserialize the EJBHome reference corresponding to a HomeHandle.</P>
   *
   * <P>readEJBHome is called from the readObject method of portable HomeHandle
   * implementation classes. The istream object is the same object that was
   * passed in to the HomeHandle class's readObject. When readEJBHome is called,
   * istream must point to the location in the stream at which the EJBHome reference
   * can be read. The container must ensure that the EJBHome reference is capable
   * of performing invocations immediately after deserialization.</P>
   *
   * @param istream - The input stream.
   * @return The deserialized EJBHome reference.
   * @exception java.io.IOException - The EJBHome could not be deserialized because
   *                                  of a system-level failure.
   * @exception java.lang.ClassNotFoundException - The EJBHome could not be deserialized
   *                                               because some class could not be found.
   */
  public EJBHome readEJBHome(java.io.ObjectInputStream istream)
    throws java.io.IOException, java.lang.ClassNotFoundException;
}
