パッケージ jakarta.jms

アノテーション型 JMSConnectionFactoryDefinition

  • @TargetSE(TYPESE)
@RetentionSE(RUNTIMESE)
@RepeatableSE(JMSConnectionFactoryDefinitions.class)
public @interface JMSConnectionFactoryDefinition
    アプリケーションは、このアノテーションを使用して、運用環境で必要な Jakarta Messaging  ConnectionFactory リソースを指定できます。これにより、アプリケーションのデプロイで使用して必要なリソースをプロビジョニングできる情報が提供され、最小限の管理構成でアプリケーションを Jakarta EE 環境にデプロイできます。

    ConnectionFactory リソースは、一般的に使用されるプロパティのアノテーション要素を設定することで構成できます。追加のプロパティは、properties 要素を使用して指定できます。一度定義されると、ConnectionFactory リソースは、他の ConnectionFactory リソースと同じ方法で、たとえば Resource アノテーションの lookup 要素を使用して、コンポーネントによって参照される場合があります。

    導入:
    JMS 2.0
    バージョン:
    Jakarta Messaging 2.0
    関連事項:
    Resource

    • 必須定数のサマリー

      必須要素  
      修飾子と型 必須要素 説明
      StringSEname
      定義されている Jakarta Messaging 接続ファクトリの JNDI 名。

    • オプション要素のサマリー

      オプション要素  
      修飾子と型 オプションの要素 説明
      StringSEclassName
      Jakarta Messaging 接続ファクトリ実装クラスの完全修飾名。
      StringSEclientId
      接続に使用するクライアント ID。
      StringSEdescription
      この Jakarta Messaging 接続ファクトリの説明。
      StringSEinterfaceName
      Jakarta Messaging 接続ファクトリインターフェースの完全修飾名。
      intmaxPoolSize
      接続プールに同時に割り当てられる接続の最大数。
      intminPoolSize
      接続プールに同時に割り当てる必要のある接続の最小数。
      StringSEpassword
      接続認証に使用するパスワード。
      StringSE[]properties
      Jakarta Messaging 接続ファクトリプロパティ。
      StringSEresourceAdapter
      リソースアダプター名。
      booleantransactional
      接続がトランザクションに参加しない場合は、false に設定します。
      StringSEuser
      接続認証に使用するユーザー名。

    • 要素の詳細

      • name

        StringSE name
        定義されている Jakarta Messaging 接続ファクトリの JNDI 名。
        戻り値:
        定義されている Jakarta Messaging 接続ファクトリの JNDI 名。

      • description

        StringSE description
        この Jakarta Messaging 接続ファクトリの説明。
        戻り値:
        この Jakarta Messaging 接続ファクトリの説明。
        デフォルト:
        ""

      • interfaceName

        StringSE interfaceName
        Jakarta Messaging 接続ファクトリインターフェースの完全修飾名。許可される値は、jakarta.jms.ConnectionFactory または jakarta.jms.QueueConnectionFactory または jakarta.jms.TopicConnectionFactory です。指定しない場合は、jakarta.jms.ConnectionFactory が使用されます。
        戻り値:
        Jakarta Messaging 接続ファクトリインターフェースの完全修飾名。
        デフォルト:
        "jakarta.jms.ConnectionFactory"

      • className

        StringSE className
        Jakarta Messaging 接続ファクトリ実装クラスの完全修飾名。リソースアダプターが使用されている場合は無視されます。
        戻り値:
        Jakarta Messaging 接続ファクトリ実装クラスの完全修飾名。
        デフォルト:
        ""

      • resourceAdapter

        StringSE resourceAdapter
        リソースアダプター名。指定されていない場合、アプリケーションサーバーはデフォルトの動作を定義します。これには、リソースアダプターの使用が含まれる場合と含まれない場合があります。
        戻り値:
        リソースアダプター名。
        デフォルト:
        ""

      • user

        StringSE user
        接続認証に使用するユーザー名。
        戻り値:
        接続認証に使用するユーザー名。
        デフォルト:
        ""

      • password

        StringSE password
        接続認証に使用するパスワード。
        戻り値:
        接続認証に使用するパスワード。
        デフォルト:
        ""

      • clientId

        StringSE clientId
        接続に使用するクライアント ID。
        戻り値:
        接続に使用するクライアント ID。
        デフォルト:
        ""

      • properties

        StringSE[] properties
        Jakarta Messaging 接続ファクトリプロパティ。これは、ベンダー固有のプロパティまたはあまり一般的に使用されていない ConnectionFactory プロパティの場合があります。

        プロパティは、propertyName = propertyValue の形式を使用して指定され、配列要素ごとに 1 つのプロパティがあります。

        戻り値:
        Jakarta Messaging 接続ファクトリプロパティ。
        デフォルト:
        {}

      • transactional

        boolean transactional
        接続がトランザクションに参加しない場合は、false に設定します。

        デフォルトでは、トランザクションがアクティブまたはアクティブになったときにトランザクションに参加します。

        戻り値:
        接続がトランザクションに参加する必要があるかどうか。
        デフォルト:
        true

      • maxPoolSize

        int maxPoolSize
        接続プールに同時に割り当てられる接続の最大数。

        デフォルトはベンダー固有です。

        戻り値:
        接続プールに同時に割り当てる必要のある接続の最大数。
        デフォルト:
        -1

      • minPoolSize

        int minPoolSize
        接続プールに同時に割り当てる必要のある接続の最小数。

        デフォルトはベンダー固有です。

        戻り値:
        接続プールに同時に割り当てる必要のある接続の最小数。
        デフォルト:
        -1