クラス ServletUriComponentsBuilder
java.lang.ObjectSE
org.springframework.web.util.UriComponentsBuilder
org.springframework.web.servlet.support.ServletUriComponentsBuilder
- 実装されたすべてのインターフェース:
CloneableSE
,UriBuilder
現在の HttpServletRequest に基づいてリンクを作成するための静的ファクトリメソッドが追加された UriComponentsBuilder。
注意 : 5.1 以降、このクラスのメソッドは、クライアントが発信したアドレスを指定する "Forwarded"
および "X-Forwarded-*"
ヘッダーを抽出しません。基になるサーバーから ForwardedHeaderFilter
などを使用して、そのようなヘッダーを抽出して使用するか、破棄してください。
- 導入:
- 3.1
- 作成者:
- Rossen Stoyanchev
コンストラクターのサマリー
コンストラクター修飾子コンストラクター説明protected
デフォルトコンストラクター。protected
指定された ServletUriComponentsBuilder のディープコピーを作成します。メソッドのサマリー
修飾子と型メソッド説明このUriComponentsBuilder
を複製します。static ServletUriComponentsBuilder
fromContextPath
(HttpServletRequestEE request) 指定された HttpServletRequest のホスト、ポート、スキーム、コンテキストパスからビルダーを準備します。static ServletUriComponentsBuilder
RequestContextHolder
を介してリクエストが取得されることを除いて、fromContextPath(HttpServletRequest)
と同じです。static ServletUriComponentsBuilder
RequestContextHolder
を介してリクエストが取得されることを除いて、fromRequest(HttpServletRequest)
と同じです。static ServletUriComponentsBuilder
RequestContextHolder
を介してリクエストが取得されることを除いて、fromRequestUri(HttpServletRequest)
と同じです。static ServletUriComponentsBuilder
RequestContextHolder
を介してリクエストが取得されることを除いて、fromServletMapping(HttpServletRequest)
と同じです。static ServletUriComponentsBuilder
fromRequest
(HttpServletRequestEE request) HttpServletRequest のスキーム、ホスト、ポート、パス、クエリ文字列をコピーして、ビルダーを準備します。static ServletUriComponentsBuilder
fromRequestUri
(HttpServletRequestEE request) HttpServletRequest のホスト、ポート、スキーム、パス(クエリではなく)からビルダーを準備します。static ServletUriComponentsBuilder
fromServletMapping
(HttpServletRequestEE request) 指定された HttpServletRequest のホスト、ポート、スキーム、コンテキストパス、サーブレットマッピングからビルダーを準備します。protected static HttpServletRequestEE
RequestContextHolder
を介して現在のリクエストを取得します。requestURI
からパス拡張子を削除します。クラス org.springframework.web.util.UriComponentsBuilder から継承されたメソッド
build, build, build, build, buildAndExpand, buildAndExpand, clone, encode, encode, fragment, fromHttpRequest, fromHttpUrl, fromOriginHeader, fromPath, fromUri, fromUriString, host, newInstance, parseForwardedFor, path, pathSegment, port, port, query, queryParam, queryParam, queryParamIfPresent, queryParams, replacePath, replaceQuery, replaceQueryParam, replaceQueryParam, replaceQueryParams, scheme, schemeSpecificPart, toUriString, uri, uriComponents, uriVariables, userInfo
コンストラクターの詳細
ServletUriComponentsBuilder
protected ServletUriComponentsBuilder()デフォルトのコンストラクター。直接インスタンス化を防ぐために保護されています。ServletUriComponentsBuilder
指定された ServletUriComponentsBuilder のディープコピーを作成します。- パラメーター:
other
- コピー元の他のビルダー
メソッドの詳細
fromContextPath
指定された HttpServletRequest のホスト、ポート、スキーム、コンテキストパスからビルダーを準備します。fromServletMapping
指定された HttpServletRequest のホスト、ポート、スキーム、コンテキストパス、サーブレットマッピングからビルダーを準備します。サーブレットが名前でマップされている場合、例:
"/main/*"
、パスは "/main" で終わります。サーブレットが別のメソッドでマップされている場合、たとえば"/"
または"*.do"
の場合、結果はfromContextPath(HttpServletRequest)
を呼び出す場合と同じになります。fromRequestUri
HttpServletRequest のホスト、ポート、スキーム、パス(クエリではなく)からビルダーを準備します。fromRequest
HttpServletRequest のスキーム、ホスト、ポート、パス、クエリ文字列をコピーして、ビルダーを準備します。fromCurrentContextPath
RequestContextHolder
を介してリクエストが取得されることを除いて、fromContextPath(HttpServletRequest)
と同じです。fromCurrentServletMapping
RequestContextHolder
を介してリクエストが取得されることを除いて、fromServletMapping(HttpServletRequest)
と同じです。fromCurrentRequestUri
RequestContextHolder
を介してリクエストが取得されることを除いて、fromRequestUri(HttpServletRequest)
と同じです。fromCurrentRequest
RequestContextHolder
を介してリクエストが取得されることを除いて、fromRequest(HttpServletRequest)
と同じです。getCurrentRequest
RequestContextHolder
を介して現在のリクエストを取得します。removePathExtension
requestURI
からパス拡張子を削除します。UriComponentsBuilder.path(String)
またはUriComponentsBuilder.pathSegment(String...)
を呼び出す前に、このメソッドを呼び出す必要があります。GET http://www.foo.example/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://www.foo.example/rest/books/6/pages/1.json", result);
- 戻り値:
- 可能な再利用のために削除されたパス拡張子、または
null
- 導入:
- 4.0
cloneBuilder
クラスからコピーされた説明:UriComponentsBuilder
このUriComponentsBuilder
を複製します。- オーバーライド:
- クラス
UriComponentsBuilder
のcloneBuilder
- 戻り値:
- クローン化された
UriComponentsBuilder
オブジェクト