jakarta.ejb.Lock Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ejb-api Show documentation

Jakarta Enterprise Beans

There is a newer version: 1.2.2.1-jre17

/*
 * 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.*;

/**
 * Declares a concurrency lock for a singleton session bean with container managed concurrency.
 *
 * 
 * This annotation may be specified on the bean class, the business methods of the bean class or both. Specifying the
 * annotation on a business method overrides the value specified at class level, if any.
 *
 * 

 * If this annotation is not used, a value of Lock(WRITE) is assumed.
 *
 * @since EJB 3.1
 */

@Target({ TYPE, METHOD })
@Retention(RUNTIME)
public @interface Lock {

    /**
     * 
value.
     *
     * @return a {@link jakarta.ejb.LockType} object.
     */
    LockType value() default LockType.WRITE;

}