jakarta.ejb.BeforeCompletion Maven / Gradle / Ivy
/*
* Copyright (c) 2006, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.ejb;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.*;
/**
* Designate a stateful session bean method to receive the before completion session synchronization callback.
*
*
* The before completion callback notifies a stateful session bean instance that a transaction is about to be committed.
*
* This method executes in the proper transaction context.
*
*
* Note: The instance may still cause the container to rollback the transaction by invoking the
* setRollbackOnly() method on the session context or by throwing an exception.
*
* A bean must have at most one BeforeCompletion method. The signature of this method must observe the
* following rules:
*
* - The method must not be declared as
final or static.
* - The method may have any access type.
*
- The return type must be
void.
* - The method must take no arguments.
*
*
*
* A stateful session bean class may use either the SessionSynchronization interface or the session
* synchronization annotations, but not both.
*
* @see SessionSynchronization
* @see AfterBegin
* @see AfterCompletion
* @since EJB 3.1
*/
@Target(METHOD)
@Retention(RUNTIME)
public @interface BeforeCompletion {
}