インターフェース ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder<B>>

型パラメーター:
B - ビルダー型への自己参照
すべてのスーパーインターフェース:
MockMvcBuilder
すべての既知の実装クラス:
AbstractMockMvcBuilderDefaultMockMvcBuilderStandaloneMockMvcBuilder

public interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder<B>> extends MockMvcBuilder
MockMvc を構築するための一般的な方法を定義します。
導入:
4.1
作成者:
Rossen Stoyanchev, Sam Brannen
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    <T extends B>
    T
    DispatcherServlet プロパティのカスタマイズを可能にする dispatchOptions(boolean) のより高度なバリアント。
    <T extends B>
    T
    addFilter(FilterEE filter, StringSE... urlPatterns)
    特定のパターンにマップされたフィルターを追加します。
    <T extends B>
    T
    addFilter(FilterEE filter, StringSE filterName, MapSE<StringSE,StringSE> initParams, EnumSetSE<DispatcherTypeEE> dispatcherTypes, StringSE... urlPatterns)
    指定された init パラメーターを使用して Filter.init(FilterConfig)EE 経由で初期化され、指定されたディスパッチャー型と URL パターンに一致するリクエストにのみ適用されるフィルターを追加します。
    <T extends B>
    T
    addFilters(FilterEE... filters)
    すべてのリクエストにマップされたフィルターを追加します。
    <T extends B>
    T
    alwaysDo(ResultHandler resultHandler)
    すべてのレスポンスに常に適用されるグローバルアクションを定義します。
    <T extends B>
    T
    すべてのレスポンスに常に適用されるグローバルな期待を定義します。
    <T extends B>
    T
    MockMvc のセットアップを自動化し、特定の目的のために設定する MockMvcConfigurer を追加します (例
    <T extends B>
    T
    実行されたすべてのリクエストにマージされるデフォルトのリクエストプロパティを定義します。
    default <T extends B>
    T
    defaultResponseCharacterEncoding(CharsetSE defaultResponseCharacterEncoding)
    すべてのレスポンスに適用されるデフォルトの文字エンコードを定義します。
    <T extends B>
    T
    dispatchOptions(boolean dispatchOptions)
    HTTP OPTIONS リクエストの処理を許可する DispatcherServlet プロパティ dispatchOptionsRequest を有効にするかどうか。

    インターフェース org.springframework.test.web.servlet.MockMvcBuilder から継承されたメソッド

    build
  • メソッドの詳細

    • addFilters

      <T extends B> T addFilters(FilterEE... filters)
      すべてのリクエストにマップされたフィルターを追加します。フィルターは同じ順序で呼び出されます。

      メモ: フィルターを Filter.init(FilterConfig)EE で初期化する必要がある場合は、代わりに addFilter(Filter, String, Map, EnumSet, String...) を使用してください。

      パラメーター:
      filters - 追加するフィルター
    • addFilter

      <T extends B> T addFilter(FilterEE filter, StringSE... urlPatterns)
      特定のパターンにマップされたフィルターを追加します。

      メモ: フィルターを Filter.init(FilterConfig)EE で初期化する必要がある場合は、代わりに addFilter(Filter, String, Map, EnumSet, String...) を使用してください。

      パラメーター:
      filter - 追加するフィルター
      urlPatterns - マッピング先の URL パターン。空の場合、すべてのリクエストに一致します
    • addFilter

      <T extends B> T addFilter(FilterEE filter, @Nullable StringSE filterName, MapSE<StringSE,StringSE> initParams, EnumSetSE<DispatcherTypeEE> dispatcherTypes, StringSE... urlPatterns)
      指定された init パラメーターを使用して Filter.init(FilterConfig)EE 経由で初期化され、指定されたディスパッチャー型と URL パターンに一致するリクエストにのみ適用されるフィルターを追加します。
      パラメーター:
      filter - 追加するフィルター
      filterName - フィルターに使用する名前。null の場合、MockFilterConfig は名前なしで作成され、デフォルトでは名前の空の文字列が使用されます。
      initParams - フィルターを初期化するための初期パラメーター
      dispatcherTypes - フィルターが適用されるディスパッチャーの型
      urlPatterns - マッピング先の URL パターン。空の場合、すべてのリクエストに一致します
      導入:
      6.1
      関連事項:
    • defaultRequest

      <T extends B> T defaultRequest(RequestBuilder requestBuilder)
      実行されたすべてのリクエストにマージされるデフォルトのリクエストプロパティを定義します。実際、これは、コンテンツ型、リクエストパラメーター、セッション属性、その他のリクエストプロパティなど、すべてのリクエストに共通の初期化を定義するメカニズムを提供します。

      リクエストの実行時に指定されたプロパティは、ここで定義されたデフォルトのプロパティをオーバーライドします。

      パラメーター:
      requestBuilder - RequestBuilder; MockMvcRequestBuilders の静的ファクトリメソッドを参照してください
    • defaultResponseCharacterEncoding

      default <T extends B> T defaultResponseCharacterEncoding(CharsetSE defaultResponseCharacterEncoding)
      すべてのレスポンスに適用されるデフォルトの文字エンコードを定義します。

      このメソッドのデフォルトの実装は UnsupportedOperationExceptionSE をスローします。具体的な実装では、このメソッドをオーバーライドすることをお勧めします。

      パラメーター:
      defaultResponseCharacterEncoding - デフォルトのレスポンス文字エンコード
      導入:
      5.3.10
    • alwaysExpect

      <T extends B> T alwaysExpect(ResultMatcher resultMatcher)
      すべてのレスポンスに常に適用されるグローバルな期待を定義します。例: ステータスコード 200(OK)、コンテンツ型 "application/json" など。
      パラメーター:
      resultMatcher - ResultMatcher; MockMvcResultMatchers の静的ファクトリメソッドを参照してください
    • alwaysDo

      <T extends B> T alwaysDo(ResultHandler resultHandler)
      すべてのレスポンスに常に適用されるグローバルアクションを定義します。例: System.out に対して実行されたリクエストと結果のレスポンスに関する詳細情報を書き込む。
      パラメーター:
      resultHandler - ResultHandler; MockMvcResultHandlers の静的ファクトリメソッドを参照してください
    • dispatchOptions

      <T extends B> T dispatchOptions(boolean dispatchOptions)
      HTTP OPTIONS リクエストの処理を許可する DispatcherServlet プロパティ dispatchOptionsRequest を有効にするかどうか。
    • addDispatcherServletCustomizer

      <T extends B> T addDispatcherServletCustomizer(DispatcherServletCustomizer customizer)
      DispatcherServlet プロパティのカスタマイズを可能にする dispatchOptions(boolean) のより高度なバリアント。
      導入:
      5.3
    • apply

      <T extends B> T apply(MockMvcConfigurer configurer)
      MockMvc のセットアップを自動化し、特定の目的(セキュリティなど)用に構成する MockMvcConfigurer を追加します。

      リクエスト全体で HTTP セッションを再利用するために使用できる組み込み SharedHttpSessionConfigurer があります。Spring Security のようなサードパーティのフレームワークもこのメカニズムを使用して、設定のショートカットを提供します。

      関連事項: