Package com.linecorp.armeria.common

Interface RequestTarget

@UnstableApi
public interface RequestTarget

An HTTP request target, as defined in Section 3.2, RFC 9112.

Note: This interface doesn't support the authority form.

Method Summary

Modifier and Type	Method	Description
@Nullable String	authority()	Returns the authority of this RequestTarget.
static @Nullable RequestTarget	forClient(String reqTarget)	Returns a RequestTarget parsed and normalized from the specified request target string in the context of client-side application.
static @Nullable RequestTarget	forClient(String reqTarget, @Nullable String prefix)	Returns a RequestTarget parsed and normalized from the specified request target string in the context of client-side application.
RequestTargetForm	form()	Returns the form of this RequestTarget.
static @Nullable RequestTarget	forServer(String reqTarget)	Returns a RequestTarget parsed and normalized from the specified request target string in the context of server-side application.
@Nullable String	fragment()	Returns the fragment of this RequestTarget.
String	maybePathWithMatrixVariables()	Returns the path of this RequestTarget, which always starts with '/'.
String	path()	Returns the path of this RequestTarget, which always starts with '/'.
default String	pathAndQuery()	Returns the string that combines path() and query().
@Nullable String	query()	Returns the query of this RequestTarget.
@Nullable String	scheme()	Returns the scheme of this RequestTarget.
String	toString()	Returns the string representation of this RequestTarget.

Method Details

forServer

@Nullable
static @Nullable RequestTarget forServer(String reqTarget)

Returns a RequestTarget parsed and normalized from the specified request target string in the context of server-side application. It rejects an absolute or authority form request target. It also normalizes '#' into '%2A' instead of parsing a fragment. Use forClient(String) if you want to parse an absolute form request target or a fragment.

Parameters:

reqTarget - the request target string

Returns:

a RequestTarget if parsed and normalized successfully, or null otherwise.

forClient

@Nullable
static @Nullable RequestTarget forClient(String reqTarget)

Returns a RequestTarget parsed and normalized from the specified request target string in the context of client-side application. It rejects an authority form request target.

Parameters:

reqTarget - the request target string

Returns:

a RequestTarget if parsed and normalized successfully, or null otherwise.

See Also:

• forServer(String)

forClient

@Nullable
static @Nullable RequestTarget forClient(String reqTarget,
 @Nullable
 @Nullable String prefix)

Returns a RequestTarget parsed and normalized from the specified request target string in the context of client-side application. It rejects an authority form request target.

Parameters:

reqTarget - the request target string

prefix - the prefix to add to reqTarget. No prefix is added if null or empty.

Returns:

a RequestTarget if parsed and normalized successfully, or null otherwise.

See Also:

• forServer(String)

form

RequestTargetForm form()

Returns the form of this RequestTarget.

scheme

@Nullable
@Nullable String scheme()

Returns the scheme of this RequestTarget.

Returns:

a non-empty string if form() is RequestTargetForm.ABSOLUTE. null otherwise.

authority

@Nullable
@Nullable String authority()

Returns the authority of this RequestTarget.

Returns:

a non-empty string if form() is RequestTargetForm.ABSOLUTE. null otherwise.

path

String path()

Returns the path of this RequestTarget, which always starts with '/'.

maybePathWithMatrixVariables

String maybePathWithMatrixVariables()

Returns the path of this RequestTarget, which always starts with '/'. Unlike path(), the returned string contains matrix variables it the original request path contains them.

See Also:

• Matrix Variables

query

@Nullable
@Nullable String query()

Returns the query of this RequestTarget.

pathAndQuery

default String pathAndQuery()

Returns the string that combines path() and query().

Returns:

path() + '?' + query() if query() is non-null. path() if query() is null.

fragment

@Nullable
@Nullable String fragment()

Returns the fragment of this RequestTarget.

toString

String toString()

Returns the string representation of this RequestTarget.

Overrides:

toString in class Object

Returns:

One of the following:

• An absolute URI if form() is RequestTargetForm.ABSOLUTE, e.g. "https://example.com/foo?bar#baz
• Path with query and fragment if form() is RequestTargetForm.ORIGIN, e.g. "/foo?bar#baz"
• "*" if form() is RequestTargetForm.ASTERISK