mirror of
https://github.com/github/codeql.git
synced 2025-12-19 18:33:16 +01:00
221 lines
9.9 KiB
Java
Generated
221 lines
9.9 KiB
Java
Generated
/*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
|
|
*
|
|
* Copyright (c) 1997-2018 Oracle and/or its affiliates. All rights reserved.
|
|
*
|
|
* The contents of this file are subject to the terms of either the GNU
|
|
* General Public License Version 2 only ("GPL") or the Common Development
|
|
* and Distribution License("CDDL") (collectively, the "License"). You
|
|
* may not use this file except in compliance with the License. You can
|
|
* obtain a copy of the License at
|
|
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
|
|
* or LICENSE.txt. See the License for the specific
|
|
* language governing permissions and limitations under the License.
|
|
*
|
|
* When distributing the software, include this License Header Notice in each
|
|
* file and include the License file at LICENSE.txt.
|
|
*
|
|
* GPL Classpath Exception:
|
|
* Oracle designates this particular file as subject to the "Classpath"
|
|
* exception as provided by Oracle in the GPL Version 2 section of the License
|
|
* file that accompanied this code.
|
|
*
|
|
* Modifications:
|
|
* If applicable, add the following below the License Header, with the fields
|
|
* enclosed by brackets [] replaced by your own identifying information:
|
|
* "Portions Copyright [year] [name of copyright owner]"
|
|
*
|
|
* Contributor(s):
|
|
* If you wish your version of this file to be governed by only the CDDL or
|
|
* only the GPL Version 2, indicate your decision by adding "[Contributor]
|
|
* elects to include this software in this distribution under the [CDDL or GPL
|
|
* Version 2] license." If you don't indicate a single choice of license, a
|
|
* recipient has the option to distribute your version of this file under
|
|
* either the CDDL, the GPL Version 2 or to extend the choice of license to
|
|
* its licensees as provided above. However, if you add GPL Version 2 code
|
|
* and therefore, elected the GPL Version 2 license, then the option applies
|
|
* only if the new code is made subject to such option by the copyright
|
|
* holder.
|
|
*/
|
|
|
|
package javax.ejb;
|
|
|
|
import java.rmi.RemoteException;
|
|
|
|
|
|
/**
|
|
* The EntityBean interface is implemented by every entity bean
|
|
* class. The container uses the EntityBean methods to notify the entity
|
|
* bean instances of the instance's life cycle events.
|
|
*
|
|
* <p>
|
|
* Applications written to the EJB 3.0 and later APIs should use the facilities
|
|
* of the Java Persistence API (<code>javax.persistence</code>) to model
|
|
* persistent entities.
|
|
*
|
|
* <p><b>Note:</b> Support for entity beans is optional as of EJB 3.2.
|
|
*
|
|
* @since EJB 1.0
|
|
*/
|
|
public interface EntityBean extends EnterpriseBean {
|
|
/**
|
|
* Set the associated entity context. The container invokes this method
|
|
* on an instance after the instance has been created.
|
|
*
|
|
* <p> This method is called in an unspecified transaction context.
|
|
*
|
|
* @param ctx An EntityContext interface for the instance. The instance
|
|
* should store the reference to the context in an instance variable.
|
|
*
|
|
* @exception EJBException Thrown by the method to indicate a failure
|
|
* caused by a system-level error.
|
|
*
|
|
* @exception RemoteException This exception is defined in the method
|
|
* signature to provide backward compatibility for enterprise beans
|
|
* written for the EJB 1.0 specification. Enterprise beans written
|
|
* for the EJB 1.1 specification should throw the
|
|
* javax.ejb.EJBException instead of this exception.
|
|
* Enterprise beans written for the EJB2.0 and higher specifications
|
|
* must throw the javax.ejb.EJBException instead of this exception.
|
|
*/
|
|
public void setEntityContext(EntityContext ctx) throws EJBException,
|
|
RemoteException;
|
|
|
|
/**
|
|
* Unset the associated entity context. The container calls this method
|
|
* before removing the instance.
|
|
*
|
|
* <p> This is the last method that the container invokes on the instance.
|
|
* The Java garbage collector will eventually invoke the finalize() method
|
|
* on the instance.
|
|
*
|
|
* <p> This method is called in an unspecified transaction context.
|
|
*
|
|
* @exception EJBException Thrown by the method to indicate a failure
|
|
* caused by a system-level error.
|
|
*
|
|
* @exception RemoteException This exception is defined in the method
|
|
* signature to provide backward compatibility for enterprise beans
|
|
* written for the EJB 1.0 specification. Enterprise beans written
|
|
* for the EJB 1.1 specification should throw the
|
|
* javax.ejb.EJBException instead of this exception.
|
|
* Enterprise beans written for the EJB2.0 and higher specifications
|
|
* must throw the javax.ejb.EJBException instead of this exception.
|
|
*/
|
|
public void unsetEntityContext() throws EJBException, RemoteException;
|
|
|
|
/**
|
|
* A container invokes this method before it removes the EJB object
|
|
* that is currently associated with the instance. This method
|
|
* is invoked when a client invokes a remove operation on the
|
|
* entity bean's home interface or the EJB object's remote interface.
|
|
* This method transitions the instance from the ready state to the pool
|
|
* of available instances.
|
|
*
|
|
* <p> This method is called in the transaction context of the remove
|
|
* operation.
|
|
*
|
|
* @exception RemoveException The enterprise Bean does not allow
|
|
* destruction of the object.
|
|
*
|
|
* @exception EJBException Thrown by the method to indicate a failure
|
|
* caused by a system-level error.
|
|
*
|
|
* @exception RemoteException This exception is defined in the method
|
|
* signature to provide backward compatibility for enterprise beans
|
|
* written for the EJB 1.0 specification. Enterprise beans written
|
|
* for the EJB 1.1 specification should throw the
|
|
* javax.ejb.EJBException instead of this exception.
|
|
* Enterprise beans written for the EJB2.0 and higher specifications
|
|
* must throw the javax.ejb.EJBException instead of this exception.
|
|
*/
|
|
public void ejbRemove() throws RemoveException, EJBException,
|
|
RemoteException;
|
|
|
|
/**
|
|
* A container invokes this method when the instance
|
|
* is taken out of the pool of available instances to become associated
|
|
* with a specific EJB object. This method transitions the instance to
|
|
* the ready state.
|
|
*
|
|
* <p> This method executes in an unspecified transaction context.
|
|
*
|
|
* @exception EJBException Thrown by the method to indicate a failure
|
|
* caused by a system-level error.
|
|
*
|
|
* @exception RemoteException This exception is defined in the method
|
|
* signature to provide backward compatibility for enterprise beans
|
|
* written for the EJB 1.0 specification. Enterprise beans written
|
|
* for the EJB 1.1 specification should throw the
|
|
* javax.ejb.EJBException instead of this exception.
|
|
* Enterprise beans written for the EJB2.0 and higher specifications
|
|
* must throw the javax.ejb.EJBException instead of this exception.
|
|
*/
|
|
public void ejbActivate() throws EJBException, RemoteException;
|
|
|
|
/**
|
|
* A container invokes this method on an instance before the instance
|
|
* becomes disassociated with a specific EJB object. After this method
|
|
* completes, the container will place the instance into the pool of
|
|
* available instances.
|
|
*
|
|
* <p> This method executes in an unspecified transaction context.
|
|
*
|
|
* @exception EJBException Thrown by the method to indicate a failure
|
|
* caused by a system-level error.
|
|
*
|
|
* @exception RemoteException This exception is defined in the method
|
|
* signature to provide backward compatibility for enterprise beans
|
|
* written for the EJB 1.0 specification. Enterprise beans written
|
|
* for the EJB 1.1 specification should throw the
|
|
* javax.ejb.EJBException instead of this exception.
|
|
* Enterprise beans written for the EJB2.0 and higher specifications
|
|
* must throw the javax.ejb.EJBException instead of this exception.
|
|
*/
|
|
public void ejbPassivate() throws EJBException, RemoteException;
|
|
|
|
/**
|
|
* A container invokes this method to instruct the
|
|
* instance to synchronize its state by loading it state from the
|
|
* underlying database.
|
|
*
|
|
* <p> This method always executes in the transaction context determined
|
|
* by the value of the transaction attribute in the deployment descriptor.
|
|
*
|
|
* @exception EJBException Thrown by the method to indicate a failure
|
|
* caused by a system-level error.
|
|
*
|
|
* @exception RemoteException This exception is defined in the method
|
|
* signature to provide backward compatibility for enterprise beans
|
|
* written for the EJB 1.0 specification. Enterprise beans written
|
|
* for the EJB 1.1 specification should throw the
|
|
* javax.ejb.EJBException instead of this exception.
|
|
* Enterprise beans written for the EJB2.0 and higher specifications
|
|
* must throw the javax.ejb.EJBException instead of this exception.
|
|
*/
|
|
public void ejbLoad() throws EJBException, RemoteException;
|
|
|
|
/**
|
|
* A container invokes this method to instruct the
|
|
* instance to synchronize its state by storing it to the underlying
|
|
* database.
|
|
*
|
|
* <p> This method always executes in the transaction context determined
|
|
* by the value of the transaction attribute in the deployment descriptor.
|
|
*
|
|
* @exception EJBException Thrown by the method to indicate a failure
|
|
* caused by a system-level error.
|
|
*
|
|
* @exception RemoteException This exception is defined in the method
|
|
* signature to provide backward compatibility for enterprise beans
|
|
* written for the EJB 1.0 specification. Enterprise beans written
|
|
* for the EJB 1.1 specification should throw the
|
|
* javax.ejb.EJBException instead of this exception.
|
|
* Enterprise beans written for the EJB2.0 and higher specifications
|
|
* must throw the javax.ejb.EJBException instead of this exception.
|
|
*/
|
|
public void ejbStore() throws EJBException, RemoteException;
|
|
}
|
|
|
|
|