jakarta.ejb.StatefulTimeout 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.*;

import java.util.concurrent.TimeUnit;

/**
 * Specifies the amount of time a stateful session bean can be idle (not receive any client invocations) before it is
 * eligible for removal by the container.
 * 
 *
 * The semantics of the value element are as follows:
 * 

 * A value >0 indicates a timeout value in the units specified by the unit element.
 * 
A value of 0 means the bean is immediately eligible for removal.
 * 
A value of -1 means the bean will never be removed due to timeout.
 * 
 * Values less than -1 are not valid.
 *
 * @since EJB 3.1
 */

@Target(TYPE)
@Retention(RUNTIME)
public @interface StatefulTimeout {

    /**
     * The amount of time the stateful session bean can be idle.
     *
     * The semantics of this element are as follows:
     * 
     * A value >0 indicates a timeout value in the units specified by the unit element.
     * 
A value of 0 means the bean is immediately eligible for removal.
     * 
A value of -1 means the bean will never be removed due to timeout.
     * 
     * Values less than -1 are not valid.
     *
     * @return a long.
     */
    long value();

    /**
     * Units used for the specified value.
     *
     * @return a {@link java.util.concurrent.TimeUnit} object.
     */
    TimeUnit unit() default TimeUnit.MINUTES;

}