jakarta.ejb.Timeout Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS 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).
/*
* Copyright (c) 1997, 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.*;
/**
* Designates a method on a stateless session bean class, a singleton session bean class, a message driven bean class,
* or an enterprise bean 2.x entity bean class that should receive enterprise bean timer expirations for that bean.
*
* The method to which the Timeout annotation is applied must have one of the following signatures, where
* <METHOD> designates the method name:
*
*
*
* void <METHOD>()
* void <METHOD>(Timer timer)
*
*
* A timeout callback method can have public, private, protected, or package level access. A timeout callback method
* must not be declared as final or static. Timeout callback methods must not throw application exceptions.
*
* If the bean implements the TimedObject interface, the Timeout annotation can only be
* applied to the ejbTimeout method.
*
* @since EJB 3.0
*/
@Target(METHOD)
@Retention(RUNTIME)
public @interface Timeout {
}