パッケージ org.springframework.web.util

クラス DefaultUriBuilderFactory

java.lang.ObjectSE
org.springframework.web.util.DefaultUriBuilderFactory
実装されたすべてのインターフェース:
UriBuilderFactory, UriTemplateHandler
public class DefaultUriBuilderFactory extends ObjectSE implements UriBuilderFactory
URI の実際の構築を UriComponentsBuilder に依存する UriBuilderFactory。

共通のベース URI、代替エンコードモード戦略などを使用して UriBuilder インスタンスを作成するオプションを提供します。

導入:
5.0
作成者:
Rossen Stoyanchev
関連事項:

  • コンストラクターの詳細

    • DefaultUriBuilderFactory

      public DefaultUriBuilderFactory()
      ベース URI のないデフォルトコンストラクター。

      ターゲットアドレスは、各 UriBuilder で指定する必要があります。

    • DefaultUriBuilderFactory

      public DefaultUriBuilderFactory(StringSE baseUriTemplate)
      ベース URI を持つコンストラクター。

      指定された URI テンプレートは、UriComponentsBuilder.fromUriString(java.lang.String) を介して解析され、UriBuilder 自体がすでにターゲットアドレスを持つ URI テンプレートで作成されていない限り、UriComponentsBuilder.uriComponents(org.springframework.web.util.UriComponents) を介してすべての UriBuilder にベース URI として適用されます。

      パラメーター:
      baseUriTemplate - ベース URL を使用する URI テンプレート

    • DefaultUriBuilderFactory

      public DefaultUriBuilderFactory(UriComponentsBuilder baseUri)
      UriComponentsBuilder を使用した DefaultUriBuilderFactory(String) のバリアント。

  • メソッドの詳細

    • hasBaseUri

      public final boolean hasBaseUri()
      このファクトリがベース URI で構成されているかどうかを確認します。
      導入:
      6.1.4
      関連事項:

    • setParserType

      public void setParserType(UriComponentsBuilder.ParserType parserType)
      使用する UriComponentsBuilder.ParserType を設定します。

      デフォルトでは、UriComponentsBuilder は parser type を使用します。

      パラメーター:
      parserType - パーサー型
      導入:
      6.2
      関連事項:

    • getParserType

      @Nullable public UriComponentsBuilder.ParserType getParserType()
      設定されたパーサー型を返します。
      導入:
      6.2

    • setEncodingMode

      public void setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)
      使用する encoding mode を設定します。

      デフォルトでは、これは EncodingMode.TEMPLATE_AND_VALUES に設定されています。

      注意 : 5.1 より前のデフォルトは EncodingMode.URI_COMPONENT であったため、WebClient RestTemplate はデフォルトの動作を切り替えました。

      パラメーター:
      encodingMode - 使用するエンコードモード

    • getEncodingMode

      public DefaultUriBuilderFactory.EncodingMode getEncodingMode()
      設定されたエンコードモードを返します。

    • setDefaultUriVariables

      public void setDefaultUriVariables(@Nullable MapSE<StringSE,?> defaultUriVariables)
      変数のマップで URI テンプレートを展開するときに使用するデフォルトの URI 変数値を提供します。
      パラメーター:
      defaultUriVariables - デフォルトの URI 変数値

    • getDefaultUriVariables

      public MapSE<StringSE,?> getDefaultUriVariables()
      設定済みのデフォルト URI 変数値を返します。

    • setParsePath

      public void setParsePath(boolean parsePath)
      エンコードモードが EncodingMode.URI_COMPONENT に設定されている場合、入力パスをパスセグメントに解析するかどうか。これにより、パスの URI 変数がパスセグメントルールに従ってエンコードされ、たとえば "/" がエンコードされます。

      デフォルトでは、これは true に設定されています。

      パラメーター:
      parsePath - パスをパスセグメントに解析するかどうか

    • shouldParsePath

      public boolean shouldParsePath()
      エンコードモードが EncodingMode.URI_COMPONENT に設定されている場合、パスをパスセグメントに解析するかどうか。

    • expand

      public URISE expand(StringSE uriTemplate, MapSE<StringSE,?> uriVars)
      インターフェースからコピーされた説明: UriTemplateHandler
      URI 変数のマップを使用して、指定された URI テンプレートを展開します。
      次で指定:
      インターフェース UriTemplateHandler の expand 
      パラメーター:
      uriTemplate - URI テンプレート
      uriVars - 変数値
      戻り値:
      作成された URI インスタンス

    • expand

      public URISE expand(StringSE uriTemplate, ObjectSE... uriVars)
      インターフェースからコピーされた説明: UriTemplateHandler
      URI 変数の配列を使用して、指定された URI テンプレートを展開します。
      次で指定:
      インターフェース UriTemplateHandler の expand 
      パラメーター:
      uriTemplate - URI テンプレート
      uriVars - 変数値
      戻り値:
      作成された URI インスタンス

    • uriString

      public UriBuilder uriString(StringSE uriTemplate)
      インターフェースからコピーされた説明: UriBuilderFactory
      指定された URI テンプレートでビルダーを初期化します。
      次で指定:
      インターフェース UriBuilderFactory の uriString 
      パラメーター:
      uriTemplate - 使用する URI テンプレート
      戻り値:
      ビルダーインスタンス

    • builder

      public UriBuilder builder()
      インターフェースからコピーされた説明: UriBuilderFactory
      デフォルト設定で URI ビルダーを作成します。
      次で指定:
      インターフェース UriBuilderFactory の builder 
      戻り値:
      ビルダーインスタンス