public interface UriInfo
getBaseUri()
を参照してください。 すべてのメソッドは、リクエストのスコープ外で(プロバイダーコンストラクターなどから)呼び出されると、java.lang.IllegalStateException
をスローします。
Context
修飾子と型 | メソッドと説明 |
---|---|
URISE | getAbsolutePath() リクエストの絶対パスを取得します。 |
UriBuilder | getAbsolutePathBuilder() リクエストの絶対パスを UriBuilder の形式で取得します。 |
URISE | getBaseUri() アプリケーションのベース URI を取得します。 |
UriBuilder | getBaseUriBuilder() アプリケーションのベース URI を UriBuilder の形式で取得します。 |
ListSE<ObjectSE> | getMatchedResources() 現在一致しているリソースクラスインスタンスの読み取り専用リストを取得します。 |
ListSE<StringSE> | getMatchedURIs() 一致したリソースの URI の読み取り専用リストを取得します。 |
ListSE<StringSE> | getMatchedURIs(boolean decode) 一致したリソースの URI の読み取り専用リストを取得します。 |
StringSE | getPath() 現在のリクエストのベース URI からの相対パスを文字列として取得します。 |
StringSE | getPath(boolean decode) 現在のリクエストのベース URI からの相対パスを文字列として取得します。 |
MultivaluedMap<StringSE, StringSE> | getPathParameters() 埋め込まれた URI テンプレートパラメーターの値を取得します。 |
MultivaluedMap<StringSE, StringSE> | getPathParameters(boolean decode) 埋め込まれた URI テンプレートパラメーターの値を取得します。 |
ListSE<PathSegment> | getPathSegments() PathSegment のリストとして、ベース URI に対する現在のリクエストのパスを取得します。 |
ListSE<PathSegment> | getPathSegments(boolean decode) PathSegment のリストとして、ベース URI に対する現在のリクエストのパスを取得します。 |
MultivaluedMap<StringSE, StringSE> | getQueryParameters() 現在のリクエストの URI クエリパラメーターを取得します。 |
MultivaluedMap<StringSE, StringSE> | getQueryParameters(boolean decode) 現在のリクエストの URI クエリパラメーターを取得します。 |
URISE | getRequestUri() クエリパラメーターを含む絶対リクエスト URI を取得します。 |
UriBuilder | getRequestUriBuilder() UriBuilder の形式で絶対リクエスト URI を取得します。 |
URISE | relativize(URISE uri) 現在のリクエスト URI に関して URI を相対化します。 |
URISE | resolve(URISE uri) アプリケーションのベース URI に関連する相対 URI を解決します。 |
StringSE getPath()
getPath(true)
と同等です。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。StringSE getPath(boolean decode)
decode
- エスケープされたオクテットのシーケンスがデコードされるか(true
)、デコードされないか(false
)を制御します。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。ListSE<PathSegment> getPathSegments()
PathSegment
のリストとして、ベース URI に対する現在のリクエストのパスを取得します。このメソッドは、パスを解析する必要がある場合、特にマトリックスパラメーターがパスに存在する可能性がある場合に役立ちます。パスセグメントのエスケープされたオクテットとマトリックスパラメーター値のすべてのシーケンスがデコードされます。これは getPathSegments(true)
と同等です。PathSegment
の変更不可能なリスト。各パスセグメントのマトリックスパラメーターマップも変更できません。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合 PathSegment
, マトリックス URIListSE<PathSegment> getPathSegments(boolean decode)
PathSegment
のリストとして、ベース URI に対する現在のリクエストのパスを取得します。このメソッドは、パスを解析する必要がある場合、特にマトリックスパラメーターがパスに存在する可能性がある場合に役立ちます。decode
- パスセグメントのエスケープされたオクテットのシーケンスとマトリックスパラメーター値がデコードされるか(true
)、デコードされないか(false
)を制御します。PathSegment
の変更不可能なリスト。各パスセグメントのマトリックスパラメーターマップも変更できません。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合 PathSegment
, マトリックス URIURISE getRequestUri()
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合 UriBuilder getRequestUriBuilder()
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。URISE getAbsolutePath()
uriInfo.getBaseUri().resolve(uriInfo.getPath(false))
のショートカットです。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。UriBuilder getAbsolutePathBuilder()
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。URISE getBaseUri()
UriBuilder getBaseUriBuilder()
MultivaluedMap<StringSE,StringSE> getPathParameters()
getPathParameters(true)
と同等です。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。Path
, PathParam
MultivaluedMap<StringSE,StringSE> getPathParameters(boolean decode)
decode
- エスケープされたオクテットのシーケンスがデコードされるか(true
)、デコードされないか(false
)を制御します。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。Path
, PathParam
MultivaluedMap<StringSE,StringSE> getQueryParameters()
getQueryParameters(true)
と同等です。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。MultivaluedMap<StringSE,StringSE> getQueryParameters(boolean decode)
decode
- パラメーター名と値のエスケープされたオクテットのシーケンスをデコードするか(true
)、デコードしないか(false
)を制御します。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。ListSE<StringSE> getMatchedURIs()
getMatchedURIs(true)
と同等です。エントリにはクエリパラメーターは含まれませんが、リクエスト URI に存在する場合はマトリックスパラメーターが含まれます。エントリは、現在のリソース URI を最初に、逆リクエスト URI の一致順序で並べられます。例: 次のリソースクラスが与えられます。@Path("foo") public class FooResource { @GET public String getFoo() {...} @Path("bar") public BarResource getBarResource() {...} } public class BarResource { @GET public String getBar() {...} }
リクエスト uri に基づいてこのメソッドによって返される値と、メソッドの呼び出し元は次のとおりです。
リクエスト | から呼び出された | 値 |
---|---|---|
/foo を入手 | FooResource.getFoo | foo |
/foo/bar を入手 | FooResource.getBarResource | foo/bar、foo |
/foo/bar を入手 | BarResource.getBar | foo/bar、foo |
ListSE<StringSE> getMatchedURIs(boolean decode)
getMatchedURIs()
を参照してください。リクエストのマッチングの前にメソッドが呼び出された場合(たとえば、事前マッチングフィルターから)、メソッドは空のリストを返します。decode
- エスケープされたオクテットのシーケンスがデコードされるか(true
)、デコードされないか(false
)を制御します。ListSE<ObjectSE> getMatchedResources()
@Path("foo") public class FooResource { @GET public String getFoo() {...} @Path("bar") public BarResource getBarResource() {...} } public class BarResource { @GET public String getBar() {...} }
リクエスト uri に基づいてこのメソッドによって返される値と、メソッドの呼び出し元は次のとおりです。
リクエスト | から呼び出された | 値 |
---|---|---|
/foo を入手 | FooResource.getFoo | FooResource |
/foo/bar を入手 | FooResource.getBarResource | FooResource |
/foo/bar を入手 | BarResource.getBar | BarResource, FooResource |
URISE resolve(URISE uri)
uri
- アプリケーションのベース URI に対して解決する URI。URISE relativize(URISE uri)
現在のリクエスト URI を基準にして URI を相対化します。相対化は次のように機能します。
resolve(java.net.URI)
を使用して解決されます。 例(ベース URI http://example.com:8080/app/root/
の場合):
リクエスト URI : http://example.com:8080/app/root/a/b/c/resource.html
提供される URI : a/b/c/d/file.txt
返された URI : d/file.txt
リクエスト URI : http://example.com:8080/app/root/a/b/c/resource.html
提供される URI : http://example2.com:9090/app2/root2/a/d/file.txt
返された URI : http://example2.com:9090/app2/root2/a/d/file.txt
2 番目の例では、指定された URI が絶対的であり、それとリクエスト URI の間に共通のプレフィックスがない場合に返されます。
uri
- リクエスト URI に対して相対化する URI。IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。Copyright © 2019 Eclipse Foundation.
Use is subject to license terms.