ServletUriComponentsBuilder (Spring Framework 5.1.0.RELEASE API)

java.lang.Object
- org.springframework.web.util.UriComponentsBuilder
- - org.springframework.web.servlet.support.ServletUriComponentsBuilder

実装済みのインターフェース一覧:
java.lang.Cloneable, UriBuilder
```
public class ServletUriComponentsBuilder
extends UriComponentsBuilder
```
現在の HttpServletRequest に基づいてリンクを作成するための静的ファクトリメソッドが追加された UriComponentsBuilder。
注意 : このクラスは、クライアントから発信されたプロトコルを反映するために、存在する場合、"Forwarded" （RFC 7239）、"X-Forwarded-Host"、"X-Forwarded-Port"、"X-Forwarded-Proto" ヘッダーの値を使用します。とアドレス。ForwardedHeaderFilter を使用して、抽出して使用するか、このようなヘッダーを破棄するかを中央から選択することを検討してください。このフィルターの詳細については、Spring Framework リファレンスを参照してください。
導入:
3.1
作成者:
Rossen Stoyanchev

コンストラクター概要

コンストラクター
修飾子	コンストラクターと説明
`protected`	`ServletUriComponentsBuilder()` デフォルトコンストラクター。
`protected`	`ServletUriComponentsBuilder(ServletUriComponentsBuilder other)` 指定された ServletUriComponentsBuilder のディープコピーを作成します。

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`ServletUriComponentsBuilder`	`cloneBuilder()` この `UriComponentsBuilder` を複製します。
`static ServletUriComponentsBuilder`	`fromContextPath(HttpServletRequestEE request)` 指定された HttpServletRequest のホスト、ポート、スキーム、コンテキストパスからビルダーを準備します。
`static ServletUriComponentsBuilder`	`fromCurrentContextPath()` `RequestContextHolder` を介してリクエストが取得されることを除いて、`fromContextPath(HttpServletRequest)` と同じです。
`static ServletUriComponentsBuilder`	`fromCurrentRequest()` `RequestContextHolder` を介してリクエストが取得されることを除いて、`fromRequest(HttpServletRequest)` と同じです。
`static ServletUriComponentsBuilder`	`fromCurrentRequestUri()` `RequestContextHolder` を介してリクエストが取得されることを除いて、`fromRequestUri(HttpServletRequest)` と同じです。
`static ServletUriComponentsBuilder`	`fromCurrentServletMapping()` `RequestContextHolder` を介してリクエストが取得されることを除いて、`fromServletMapping(HttpServletRequest)` と同じです。
`static ServletUriComponentsBuilder`	`fromRequest(HttpServletRequestEE request)` HttpServletRequest のスキーム、ホスト、ポート、パス、クエリ文字列をコピーして、ビルダーを準備します。
`static ServletUriComponentsBuilder`	`fromRequestUri(HttpServletRequestEE request)` HttpServletRequest のホスト、ポート、スキーム、パス（クエリではなく）からビルダーを準備します。
`static ServletUriComponentsBuilder`	`fromServletMapping(HttpServletRequestEE request)` 指定された HttpServletRequest のホスト、ポート、スキーム、コンテキストパス、サーブレットマッピングからビルダーを準備します。
`protected static HttpServletRequestEE`	`getCurrentRequest()` `RequestContextHolder` を介して現在のリクエストを取得します。
`java.lang.String`	`removePathExtension()` `requestURI`EE からパス拡張子を削除します。

クラス org.springframework.web.util.UriComponentsBuilder から継承されたメソッド
build, build, build, build, buildAndExpand, buildAndExpand, clone, encode, encode, fragment, fromHttpRequest, fromHttpUrl, fromOriginHeader, fromPath, fromUri, fromUriString, host, newInstance, path, pathSegment, port, port, query, queryParam, queryParams, replacePath, replaceQuery, replaceQueryParam, replaceQueryParams, scheme, schemeSpecificPart, toUriString, uri, uriComponents, uriVariables, userInfo

クラス java.lang.Object から継承されたメソッド
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクターの詳細
  - ServletUriComponentsBuilder
```
protected ServletUriComponentsBuilder()
```
    デフォルトのコンストラクター。直接インスタンス化を防ぐために保護されています。
    関連事項:
    fromContextPath(HttpServletRequest), fromServletMapping(HttpServletRequest), fromRequest(HttpServletRequest), fromCurrentContextPath(), fromCurrentServletMapping(), fromCurrentRequest()
  - ServletUriComponentsBuilder
```
protected ServletUriComponentsBuilder(ServletUriComponentsBuilder other)
```
    指定された ServletUriComponentsBuilder のディープコピーを作成します。
    パラメーター:
    other - コピー元の他のビルダー
- メソッドの詳細
  - fromContextPath
```
public static ServletUriComponentsBuilder fromContextPath(HttpServletRequestEE request)
```
    指定された HttpServletRequest のホスト、ポート、スキーム、コンテキストパスからビルダーを準備します。
    注意 : 5.1 の時点で、このメソッドはクライアント発信アドレスを指定する "Forwarded" および "X-Forwarded-*" ヘッダーを無視します。ForwardedHeaderFilter を使用して、そのようなヘッダーを抽出して使用するか、破棄することを検討してください。
  - fromServletMapping
```
public static ServletUriComponentsBuilder fromServletMapping(HttpServletRequestEE request)
```
    指定された HttpServletRequest のホスト、ポート、スキーム、コンテキストパス、サーブレットマッピングからビルダーを準備します。
    サーブレットが名前でマップされている場合、例: "/main/*"、パスは "/main" で終わります。サーブレットが別のメソッドでマップされている場合、たとえば "/" または "*.do" の場合、結果は fromContextPath(HttpServletRequest) を呼び出す場合と同じになります。
    注意 : 5.1 の時点で、このメソッドはクライアント発信アドレスを指定する "Forwarded" および "X-Forwarded-*" ヘッダーを無視します。ForwardedHeaderFilter を使用して、そのようなヘッダーを抽出して使用するか、破棄することを検討してください。
  - fromRequestUri
```
public static ServletUriComponentsBuilder fromRequestUri(HttpServletRequestEE request)
```
    HttpServletRequest のホスト、ポート、スキーム、パス（クエリではなく）からビルダーを準備します。
    注意 : 5.1 の時点で、このメソッドはクライアント発信アドレスを指定する "Forwarded" および "X-Forwarded-*" ヘッダーを無視します。ForwardedHeaderFilter を使用して、そのようなヘッダーを抽出して使用するか、破棄することを検討してください。
  - fromRequest
```
public static ServletUriComponentsBuilder fromRequest(HttpServletRequestEE request)
```
    HttpServletRequest のスキーム、ホスト、ポート、パス、クエリ文字列をコピーして、ビルダーを準備します。
    注意 : 5.1 の時点で、このメソッドはクライアント発信アドレスを指定する "Forwarded" および "X-Forwarded-*" ヘッダーを無視します。ForwardedHeaderFilter を使用して、そのようなヘッダーを抽出して使用するか、破棄することを検討してください。
  - fromCurrentContextPath
```
public static ServletUriComponentsBuilder fromCurrentContextPath()
```
    RequestContextHolder を介してリクエストが取得されることを除いて、fromContextPath(HttpServletRequest) と同じです。
    注意 : このメソッドは、"Forwarded" および "X-Forwarded-*" ヘッダーから値が見つかった場合に抽出します。クラスレベルのドキュメントを参照してください。
    4.3.15 以降、このメソッドは contextPath を先頭に追加するのではなく、"X-Forwarded-Prefix" の値に置き換えて、ForwardedHeaderFilter と揃えます。
  - fromCurrentServletMapping
```
public static ServletUriComponentsBuilder fromCurrentServletMapping()
```
    RequestContextHolder を介してリクエストが取得されることを除いて、fromServletMapping(HttpServletRequest) と同じです。
    注意 : このメソッドは、"Forwarded" および "X-Forwarded-*" ヘッダーから値が見つかった場合に抽出します。クラスレベルのドキュメントを参照してください。
    4.3.15 以降、このメソッドは contextPath を先頭に追加するのではなく、"X-Forwarded-Prefix" の値に置き換えて、ForwardedHeaderFilter と揃えます。
  - fromCurrentRequestUri
```
public static ServletUriComponentsBuilder fromCurrentRequestUri()
```
    RequestContextHolder を介してリクエストが取得されることを除いて、fromRequestUri(HttpServletRequest) と同じです。
    注意 : このメソッドは、"Forwarded" および "X-Forwarded-*" ヘッダーから値が見つかった場合に抽出します。クラスレベルのドキュメントを参照してください。
    4.3.15 以降、このメソッドは contextPath を先頭に追加するのではなく、"X-Forwarded-Prefix" の値に置き換えて、ForwardedHeaderFilter と揃えます。
  - fromCurrentRequest
```
public static ServletUriComponentsBuilder fromCurrentRequest()
```
    RequestContextHolder を介してリクエストが取得されることを除いて、fromRequest(HttpServletRequest) と同じです。
    注意 : このメソッドは、"Forwarded" および "X-Forwarded-*" ヘッダーから値が見つかった場合に抽出します。クラスレベルのドキュメントを参照してください。
    4.3.15 以降、このメソッドは contextPath を先頭に追加するのではなく、"X-Forwarded-Prefix" の値に置き換えて、ForwardedHeaderFilter と揃えます。
  - getCurrentRequest
```
protected static HttpServletRequestEE getCurrentRequest()
```
    RequestContextHolder を介して現在のリクエストを取得します。
  - removePathExtension
```
@Nullable
public java.lang.String removePathExtension()
```
    requestURIEE からパス拡張子を削除します。UriComponentsBuilder.path(String) または UriComponentsBuilder.pathSegment(String...) を呼び出す前に、このメソッドを呼び出す必要があります。
```
 GET http://foo.com/rest/books/6.json

 ServletUriComponentsBuilder builder = ServletUriComponentsBuilder.fromRequestUri(this.request);
 String ext = builder.removePathExtension();
 String uri = builder.path("/pages/1.{ext}").buildAndExpand(ext).toUriString();
 assertEquals("http://foo.com/rest/books/6/pages/1.json", result);
 
```
    戻り値:
    可能な再利用のために削除されたパス拡張子、または null
    導入:
    4.0
  - cloneBuilder
```
public ServletUriComponentsBuilder cloneBuilder()
```
    クラスからコピーされた説明: UriComponentsBuilder
    この UriComponentsBuilder を複製します。
    オーバーライド:
    クラス UriComponentsBuilder の cloneBuilder
    戻り値:
    クローン化された UriComponentsBuilder オブジェクト

クラス ServletUriComponentsBuilder

コンストラクター概要

方法の概要

クラス org.springframework.web.util.UriComponentsBuilder から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

ServletUriComponentsBuilder

ServletUriComponentsBuilder

メソッドの詳細

fromContextPath

fromServletMapping

fromRequestUri

fromRequest

fromCurrentContextPath

fromCurrentServletMapping

fromCurrentRequestUri

fromCurrentRequest

getCurrentRequest

removePathExtension

cloneBuilder