Module jakarta.ejb

Package jakarta.ejb

Annotation Interface StatefulTimeout

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

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

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
long	value	The amount of time the stateful session bean can be idle.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
TimeUnit	unit	Units used for the specified value.

Element Details

value

long value

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.

Returns:

a long.

unit

TimeUnit unit

Units used for the specified value.

Returns:

a TimeUnit object.

Default:

MINUTES