パッケージ org.springframework.boot.actuate.endpoint.annotation

アノテーションインターフェース Endpoint

@TargetSE(TYPESE) @RetentionSE(RUNTIMESE) @DocumentedSE @Reflective public @interface Endpoint
実行中のアプリケーションに関する情報を提供するアクチュエーターエンドポイントとして型を識別します。エンドポイントは、JMX や HTTP などのさまざまなテクノロジーで公開できます。

ほとんどの @Endpoint クラスは、公開テクノロジー (JMX、Spring MVC、Spring、WebFlux、Jersey など) に自動的に適応される 1 つ以上の @ReadOperation、@WriteOperation、@DeleteOperation アノテーション付きメソッドを宣言します。

@Endpoint は、エンドポイントの最小公分母を表し、可能な限り広い範囲の露光技術をサポートするために定義できる操作方法の種類を意図的に制限しています。特定のテクノロジーに対するより深いサポートが必要な場合は、特定のテクノロジーに対して filtered であるエンドポイントを作成するか、より広いエンドポイントに extension を提供できます。

導入:
2.0.0
作成者:
Andy Wilkinson, Phillip Webb
関連事項:

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

    オプション要素
    修飾子と型
    オプションの要素
    説明
    Access
    defaultAccess
    デフォルトで許可されるエンドポイントへのアクセスレベル。
    boolean
    enableByDefault
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    3.4.0 以降、3.6.0 で削除され defaultAccess() を推奨
    StringSE
    id
    エンドポイントの ID（EndpointId ルールに従う必要があります）。

  • 要素の詳細

    • id

      StringSE id
      エンドポイントの ID（EndpointId ルールに従う必要があります）。
      戻り値:
      ID
      関連事項:
      デフォルト:
      ""

    • enableByDefault

      @DeprecatedSE(since="3.4.0", forRemoval=true) boolean enableByDefault
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      3.4.0 以降、3.6.0 で削除され defaultAccess() を推奨
      エンドポイントをデフォルトで有効または無効にする必要があるかどうか。
      戻り値:
      エンドポイントがデフォルトで有効になっている場合は true 
      デフォルト:
      true

    • defaultAccess

      Access defaultAccess
      デフォルトで許可されるエンドポイントへのアクセスレベル。
      戻り値:
      デフォルトのアクセスレベル
      導入:
      3.4.0
      デフォルト:
      UNRESTRICTED