インターフェース InterceptorContext

メソッドの詳細

• getProperty

  ObjectSE getProperty(StringSE name)

  現在のリクエスト / レスポンス交換コンテキストに登録されている指定された名前のプロパティを返します。その名前のプロパティがない場合は null を返します。

  プロパティを使用すると、JAX-RS フィルターとインターセプターがこのインターフェースでまだ提供されていない追加のカスタム情報を交換できます。

  サポートされているプロパティのリストは、getPropertyNames() を使用して取得できます。カスタムプロパティ名は、パッケージ名と同じ規則に従う必要があります。

  サーバー側のサーブレットコンテナーでは、プロパティは ServletRequest によってサポートされ、ServletRequest で使用可能なすべての属性が含まれます。

  パラメーター:

  name - プロパティの名前を指定する String。

  戻り値:

  プロパティの値を含む Object、または指定された名前に一致するプロパティが存在しない場合は null 

  関連事項:

  • getPropertyNames()

• hasProperty

  default boolean hasProperty(StringSE name)

  指定された名前のプロパティが現在のリクエスト / レスポンス交換コンテキストに登録されている場合は true を返し、その名前のプロパティが存在しない場合は false を返します。

  getProperty(java.lang.String) メソッドとプロパティ名を使用して、プロパティの値を取得します。

  パラメーター:

  name - プロパティの名前を指定する String。

  戻り値:

  このプロパティがコンテキストに登録されている場合は true、指定された名前に一致するプロパティが存在しない場合は false。

  関連事項:

  • getPropertyNames()

• getPropertyNames

  CollectionSE<StringSE> getPropertyNames()

  現在のリクエスト / レスポンス交換コンテキストのコンテキスト内で使用可能なプロパティ名を含む不変の collectionSE を返します。

  getProperty(java.lang.String) メソッドとプロパティ名を使用して、プロパティの値を取得します。

  サーブレットコンテナーでは、プロパティは ServletRequest と同期され、ServletRequest で利用可能なすべての属性を公開します。プロパティの変更は、関連する ServletRequest のプロパティセットにも反映されます。

  戻り値:

  プロパティ名の不変の collectionSE。

  関連事項:

  • getProperty(java.lang.String)

• setProperty

  void setProperty(StringSE name, ObjectSE object)

  現在のリクエスト / レスポンス交換コンテキスト内の指定されたプロパティ名にオブジェクトをバインドします。指定した名前がすでにプロパティに使用されている場合、このメソッドはプロパティの値を新しい値に置き換えます。

  プロパティを使用すると、JAX-RS フィルターとインターセプターがこのインターフェースでまだ提供されていない追加のカスタム情報を交換できます。

  サポートされているプロパティのリストは、getPropertyNames() を使用して取得できます。カスタムプロパティ名は、パッケージ名と同じ規則に従う必要があります。

  null 値が渡される場合、効果は removeProperty(String) メソッドを呼び出すのと同じです。

  サーバー側のサーブレットコンテナーでは、プロパティは ServletRequest によってサポートされ、ServletRequest で使用可能なすべての属性が含まれます。

  パラメーター:

  name - プロパティの名前を指定する String。

  object - バインドされるプロパティを表す Object 

• removeProperty

  void removeProperty(StringSE name)

  現在のリクエスト / レスポンス交換コンテキストから、指定された名前のプロパティを削除します。削除後、getProperty(java.lang.String) を呼び出してプロパティ値を取得すると、null が返されます。

  サーバー側のサーブレットコンテナーでは、プロパティは ServletRequest によってサポートされ、ServletRequest で使用可能なすべての属性が含まれます。

  パラメーター:

  name - 削除するプロパティの名前を指定する String 

• getAnnotations

  AnnotationSE[] getAnnotations()

  インターセプトされたエンティティプロバイダの呼び出しを開始したアーティファクトで正式に宣言されたアノテーションの配列を取得します。例: メッセージ本文をメソッドパラメーターに変換する場合、これは Method.getParameterAnnotations() によって返されるそのパラメーターのアノテーションになります。サーバー側のレスポンスエンティティインスタンスが出力ストリームに変換される場合、これは Method.getAnnotations() によって返される一致したリソースメソッドのアノテーションになります。このメソッドは、特定のリソースメソッドのコンテキストで（たとえば、クライアント API の一部として）インターセプターが呼び出されない場合、空の配列を返すことがありますが、null を返すことはありません。

  戻り値:

  インターセプトされたエンティティプロバイダの呼び出しを開始したアーティファクトで宣言されたアノテーション。

• setAnnotations

  void setAnnotations(AnnotationSE[] annotations)

  インターセプトされたエンティティプロバイダの呼び出しを開始したアーティファクトの正式な宣言のアノテーションを更新します。このメソッドを呼び出しても、クライアント API には影響しません。

  パラメーター:

  annotations - インターセプトされたエンティティプロバイダーの呼び出しを開始したアーティファクトの更新されたアノテーション宣言。null であってはなりません。

  例外:

  NullPointerExceptionSE - 入力パラメーターが null の場合。

• getType

  ClassSE<?> getType()

  対応するメッセージ本文プロバイダーがサポートする Java 型を取得します。

  戻り値:

  プロバイダーがサポートする java 型

• setType

  void setType(ClassSE<?> type)

  メッセージ本文プロバイダーを呼び出す前に Java 型を更新します。

  パラメーター:

  type - プロバイダーの java 型

• getGenericType

  TypeSE getGenericType()

  生成または書き込まれるオブジェクトの型を取得します。

  戻り値:

  生成または書き込まれたオブジェクトの型

• setGenericType

  void setGenericType(TypeSE genericType)

  生成または書き込まれるオブジェクトの更新型。

  パラメーター:

  genericType - オブジェクトの新しい型

• getMediaType

  MediaType getMediaType()

  HTTP エンティティのメディア型を取得します。

  戻り値:

  HTTP エンティティのメディア型

• setMediaType

  void setMediaType(MediaType mediaType)

  HTTP エンティティのメディア型を更新します。

  パラメーター:

  mediaType - HTTP エンティティの新しい型