Package jakarta.ejb

Annotation Type MessageDriven

  • @Target(TYPE)
@Retention(RUNTIME)
public @interface MessageDriven
    Component-defining annotation for a message driven bean.

    The message driven bean must implement the appropriate message listener interface for the messaging type that the message-driven bean supports or specify the message listener interface using the messageListenerInterface element of this annotation.

    Since:
    EJB 3.0
    See Also:
    ActivationConfigProperty

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      ActivationConfigProperty[] activationConfig
      Activation config properties.
      java.lang.String description
      A string describing the message driven bean.
      java.lang.String mappedName
      A product specific name(e.g. global JNDI name of a queue) that this message-driven bean should be mapped to.
      java.lang.Class messageListenerInterface
      Message-listener interface.
      java.lang.String name
      The ejb-name for this bean.

    • Element Detail

      • name

        java.lang.String name
        The ejb-name for this bean. Defaults to the unqualified name of the message driven bean class.
        Returns:
        a String object.
        Default:
        ""

      • messageListenerInterface

        java.lang.Class messageListenerInterface
        Message-listener interface. If the message-driven bean class implements more than one interface other than java.io.Serializable, java.io.Externalizable, or any of the interfaces defined by the jakarta.ejb package, the message listener interface must be specified.
        Returns:
        a Class object.
        Default:
        java.lang.Object.class

      • mappedName

        java.lang.String mappedName
        A product specific name(e.g. global JNDI name of a queue) that this message-driven bean should be mapped to. Application servers are not required to support any particular form or type of mapped name, nor the ability to use mapped names. The mapped name is product-dependent and often installation-dependent. No use of a mapped name is portable.
        Returns:
        a String object.
        Default:
        ""

      • description

        java.lang.String description
        A string describing the message driven bean.
        Returns:
        a String object.
        Default:
        ""