jakarta.interceptor.AroundTimeout Maven / Gradle / Ivy
/*
* 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.interceptor;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Defines an interceptor method that interposes on timeout methods. The method must take a single parameter of type
* {@link InvocationContext} and have a return type {@link java.lang.Object}. The method must not be
* declared as abstract, final, or static.
*
*
* @AroundTimeout
* public Object interceptTimeout(InvocationContext ctx) throws Exception { ... }
*
*
*
* AroundTimeout methods may be declared in interceptor classes, in the superclasses of interceptor classes, in
* the target class, and/or in superclasses of the target class.
*
*
*
* A given class must not declare more than one AroundTimeout method.
*
*
*
* An AroundTimeout method can invoke any component or resource that its corresponding timeout method can
* invoke.
*
*
*
* {@link InvocationContext#getTimer()} allows any AroundTimeout method to retrieve the timer
* object associated with the timeout.
*
*
*
* In general, AroundTimeout method invocations occur within the same transaction and security context as the
* timeout method on which they are interposing.
*
*
*
* AroundTimeout methods may throw any exceptions that are allowed by the throws clause of the timeout method
* on which they are interposing. They may catch and suppress exceptions and recover by calling
* {@link InvocationContext#proceed()}.
*
*
* @since Jakarta Interceptors 1.1
*/
@Target(METHOD)
@Retention(RUNTIME)
public @interface AroundTimeout {
}