javax.ejb.EJBHome 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;

import java.rmi.RemoteException;

/**
 * The EJBHome interface must be extended by all enterprise Beans' remote home interfaces.
 * An enterprise Bean's remote home interface defines the methods that allow a remote client to
 * create, find, and remove EJB objects, as well as home business methods that are not specific to
 * a bean instance (Session Beans do not have finders and home methods).
 *
 * The remote home interface is defined by the enterprise Bean provider and implemented by the
 * enterprise Bean container.
 */
public interface EJBHome extends java.rmi.Remote {

   /**
    * Remove an EJB object identified by its handle.
    *
    * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
    * @exception RemoveException - Thrown if the enterprise Bean or the container does not allow
    * the client to remove the object.
    */
   public void remove(Handle handle) throws RemoteException, RemoveException;

   /**
    * Remove an EJB object identified by its primary key.
    *
    * This method can be used only for an entity bean. An attempt to call this method on
    * a session bean will result in a RemoteException.
    *
    * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
    * @exception RemoveException - Thrown if the enterprise Bean or the container does not allow
    * the client to remove the object.
    */
   public void remove(Object primaryKey) throws RemoteException, RemoveException;

  /**
   * Obtain the EJBMetaData interface for the enterprise Bean. The EJBMetaData interface allows
   * the client to obtain information about the enterprise Bean.
   *
   * The information obtainable via the EJBMetaData interface is intended to be used by tools.
   *
   * @return The enterprise Bean's EJBMetaData interface.
   * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
   */
  public EJBMetaData getEJBMetaData() throws RemoteException;

  /**
   * Obtain a handle for the remote home object. The handle can be used at later time to re-obtain
   * a reference to the remote home object, possibly in a different Java Virtual Machine.
   *
   * @return A handle for the remote home object.
   * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
   */
  public HomeHandle getHomeHandle() throws RemoteException;

}