Package org.jboss.weld.ejb.api

Interface SessionObjectReference

All Superinterfaces:
Serializable
public interface SessionObjectReference extends Serializable
A serializable reference to a session object in the EJB container
Author:
Pete Muir

  • Method Summary

    Modifier and Type
    Method
    Description
    <S> S
    getBusinessObject(Class<S> businessInterfaceType)
    Get the reference from the EJB container to the session object for the given business interface
    boolean
    isRemoved()
    Determine whether the session object has been removed.
    void
    remove()
    Request the EJB container remove the stateful session object

  • Method Details

    • getBusinessObject

      <S> S getBusinessObject(Class<S> businessInterfaceType)
      Get the reference from the EJB container to the session object for the given business interface
      Type Parameters:
      S - the type of the business interface
      Parameters:
      businessInterfaceType - the type of the business interface
      Returns:
      a reference
      Throws:
      IllegalStateException - if the business interface is not a business interface of the session bean
      jakarta.ejb.NoSuchEJBException - if the session object has already been removed

    • remove

      void remove()
      Request the EJB container remove the stateful session object
      Throws:
      UnsupportedOperationException - if the reference is not backed by a stateful session object
      jakarta.ejb.NoSuchEJBException - if the session object has already been removed

    • isRemoved

      boolean isRemoved()
      Determine whether the session object has been removed. If the session object has yet to be referenced by getBusinessObject(Class) then this method should not return true.
      Returns:
      true if the session object has been removed