javax.ejb.spi.HandleDelegate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

package javax.ejb.spi;

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

/**
 * 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.
 *
 * The HandleDelegate object is obtained by JNDI lookup at the reserved name
 * "java:comp/HandleDelegate".
 */
public interface HandleDelegate {

  /**
   * Serialize the EJBObject reference corresponding to a Handle.
   *
   * 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.
   *
   * @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;


  /**
   * Deserialize the EJBObject reference corresponding to a Handle.
   *
   * 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.
   * 
   * @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;

  /**
   * Serialize the EJBHome reference corresponding to a HomeHandle.
   *
   * 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.
   *
   * @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;

  /**
   * Deserialize the EJBHome reference corresponding to a HomeHandle.
   *
   * 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.
   *
   * @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;
}