Contains the Enterprise Bean classes and interfaces that define the contracts between the enterprise bean and its clients and between the enterprise bean and the enterprise bean container.
Interface Summary Interface Description EJBContextThe EJBContext interface provides an instance with access to the container-provided runtime context of an enterprise bean instance. EJBHomeThe EJBHome interface must be extended by all enterprise beans' remote home interfaces. EJBLocalHomeThe EJBLocalHome interface must be extended by all enterprise beans' local home interfaces. EJBLocalObjectThe EJBLocalObject interface must be extended by all enterprise beans' local interfaces. EJBMetaDataThe EJBMetaData interface allows a client to obtain the enterprise bean's meta-data information. EJBObjectThe EJBObject interface is extended by all enterprise beans' remote interfaces. EnterpriseBeanThe EnterpriseBean interface is a common superinterface for the SessionBean, EntityBean and MessageDrivenBean interfaces. EntityBeanThe EntityBean interface is implemented by every entity bean class. EntityContextThe EntityContext interface provides an instance with access to the container-provided runtime context of an entity bean instance. HandleThe Handle interface is implemented by all enterprise bean object handles. HomeHandleThe HomeHandle interface is implemented by all home object handles. MessageDrivenBeanThe MessageDrivenBean interface defines methods that the enterprise bean container uses to notify a message driven bean instance of the instance's life cycle events. MessageDrivenContextThe MessageDrivenContext interface provides access to the runtime message-driven context that the container provides for a message-driven bean instance. SessionBeanThe SessionBean interface defines methods that the enterprise bean container uses to notify a session bean instance of the instance's life cycle events. SessionContextThe SessionContext interface provides access to the runtime session context that the container provides for a session bean instance. SessionSynchronizationThe SessionSynchronization interface allows a stateful session bean instance to be notified by its container of transaction boundaries. TimedObjectThe
TimedObjectinterface contains a callback method that is used to deliver timer expiration notifications.
Timerinterface contains information about a timer that was created through the enterprise bean Timer Service.
TimerHandleThe TimerHandle interface allows the bean provider to obtain a serializable timer handle that may be persisted. TimerServiceThe TimerService interface provides enterprise bean components with access to the container-provided Timer Service.
Class Summary Class Description AsyncResult<V>Wraps the result of an asynchronous method call as a
Futureobject, preserving compatability with the business interface signature.
ScheduleExpressionA calendar-based timeout expression for an enterprise bean timer. TimerConfigTimerConfig is used to specify additional timer configuration settings during timer creation.
Enum Summary Enum Description ConcurrencyManagementTypeUsed to specify the value of the
ConcurrencyManagementannotation for a singleton session bean.
LockTypeConcurrency lock type for singleton beans with container-managed concurrency. TransactionAttributeTypeThe enum
TransactionAttributeTypeis used with the
TransactionAttributeannotation to specify whether the methods of a session bean or message driven bean are called with a valid transaction context.
TransactionManagementTypeis used with the
TransactionManagementannotation to specify whether container-managed or bean-managed transaction management is used.
Exception Summary Exception Description AccessLocalExceptionAn AccessLocalException is thrown to indicate that the caller does not have permission to call the method. ConcurrentAccessExceptionA ConcurrentAccessException indicates that the client has attempted an invocation on a stateful session bean or singleton bean while another invocation is in progress and such concurrent access is not allowed. ConcurrentAccessTimeoutExceptionThis exception indicates that an attempt to concurrently access a stateful session or singleton bean method resulted in a timeout. CreateExceptionThe CreateException exception must be included in the throws clauses of all create methods defined in an enterprise bean's home or local home interface. DuplicateKeyExceptionThe DuplicateKeyException exception is thrown if an entity EJB object or enterprise bean local object cannot be created because an object with the same key already exists. EJBAccessExceptionThis exception indicates that client access to a business method was denied. EJBExceptionThe EJBException is thrown to report that the invoked business method or callback method could not be completed because of an unexpected error (e.g. EJBTransactionRequiredExceptionThis exception indicates that a request carried a null transaction context, but the target object requires an active transaction. EJBTransactionRolledbackExceptionThis exception is thrown to a caller of bean business method to indicate that the transaction associated with processing of the request has been rolled back, or marked to roll back. FinderExceptionThe FinderException exception must be included in the throws clause of every finder method of an entity bean's home or local home interface. IllegalLoopbackExceptionThis exception indicates that an attempt was made to perform an illegal loopback invocation. NoMoreTimeoutsExceptionThis exception indicates that a calendar-based timer will not result in any more timeouts. NoSuchEJBExceptionA NoSuchEJBException is thrown if an attempt is made to invoke a business method on a stateful session or singleton object that no longer exists. NoSuchEntityExceptionThe NoSuchEntityException exception is thrown by an entity bean instance to its container to report that the invoked business method or callback method could not be completed because of the underlying entity was removed from the database. NoSuchObjectLocalExceptionA NoSuchObjectLocalException is thrown if an attempt is made to invoke a method on a local object (local enterprise bean object or timer) that no longer exists. ObjectNotFoundExceptionThe ObjectNotFoundException exception is thrown by a finder or select method to indicate that the specified enterprise bean object or local object does not exist. RemoveExceptionThe RemoveException is thrown at an attempt to remove an enterprise bean object or local enterprise bean object when the enterprise bean or the container does not allow the enterprise bean object to be removed. TransactionRequiredLocalExceptionThis exception is thrown to a local client to indicate that a request carried a null transaction context, but the target object requires an active transaction. TransactionRolledbackLocalExceptionThis exception is thrown to a local client to indicate that the transaction associated with processing of the request has been rolled back, or marked to roll back.
Annotation Types Summary Annotation Type Description AccessTimeoutSpecifies the amount of time in a given time unit that a concurrent access attempt should block before timing out. ActivationConfigPropertyUsed to provide information to the deployer about the configuration of a message driven bean in its operational environment. AfterBeginDesignate a stateful session bean method to receive the after begin session synchronization callback. AfterCompletionDesignate a stateful session bean method to receive the after completion session synchronization callback. ApplicationExceptionApplied to an exception to denote that it is an application exception and should be reported to the client directly (i.e., unwrapped). AsynchronousUsed to mark a session bean method as an asynchronous method or to designate all business methods of a session bean class as asynchronous. BeforeCompletionDesignate a stateful session bean method to receive the before completion session synchronization callback. ConcurrencyManagementDeclares a singleton session bean's concurrency management type. DependsOnUsed to express an initialization dependency between singleton components. EJBIndicates a dependency on the local, no-interface, or remote view of an Enterprise Bean. EJBsDeclares multiple
InitDesignates a method of a session bean that corresponds to a
create<METHOD>method of an adapted home or local home interface (an interface that adapts an enterprise bean 2.1 or earlier EJBHome or EJBLocalHome client view respectively).
LocalDeclares the local business interface(s) for a session bean. LocalBeanDesignates that a session bean exposes a no-interface view. LocalHomeDeclares the local home or adapted local home interface for a session bean. LockDeclares a concurrency lock for a singleton session bean with container managed concurrency. MessageDrivenComponent-defining annotation for a message driven bean. PostActivateDesignates a method to receive a callback after a stateful session bean has been activated. PrePassivateDesignates a method to receive a callback before a stateful session bean is passivated. RemoteDeclares the remote business interface(s) for a session bean. RemoteHomeDeclares the remote home interface or adapted remote home interface for a session bean. RemoveApplied to a business method of a stateful session bean class to indicate to the container that the stateful session bean is to be removed by the container after completion of the method. ScheduleSchedule a timer for automatic creation with a timeout schedule based on a cron-like time expression. SchedulesApplied to a timer callback method to schedule multiple calendar-based timers for the method. SingletonComponent-defining annotation for a singleton session bean. StartupMark a singleton bean for eager initialization during the application startup sequence. StatefulComponent-defining annotation for a stateful session bean. StatefulTimeoutSpecifies 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. StatelessComponent-defining annotation for a stateless session bean. TimeoutDesignates 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. TransactionAttributeThe
TransactionAttributeannotation specifies whether the container is to invoke a business method within a transaction context.
TransactionManagementSpecifies whether a session bean or message driven bean has container managed transactions or bean managed transactions.