Apache HttpClient 4.5.14 · org.apache.http.client.utils.URIUtils

Modifier and Type	Class and Description
public static enum	URIUtils.UriFlag Flags that control how URI is being rewritten.

Modifier and Type	Field and Description
public static final EnumSet<URIUtils.UriFlag>	DROP_FRAGMENT Set of uri flags containing `UriFlag#DROP_FRAGMENT`.
public static final EnumSet<URIUtils.UriFlag>	DROP_FRAGMENT_AND_NORMALIZE Set of uri flags containing `UriFlag#DROP_FRAGMENT` and `UriFlag#NORMALIZE`.
public static final EnumSet<URIUtils.UriFlag>	NO_FLAGS Empty set of uri flags.
public static final EnumSet<URIUtils.UriFlag>	NORMALIZE Set of uri flags containing `UriFlag#NORMALIZE`.

Access	Constructor and Description
private	URIUtils() This class should not be instantiated.

Method Summary

Modifier and Type	Method and Description
public static URI	createURI(final String Scheme name scheme, final String Host name host, final int Port number port, final String Path path, final String Query query, final String Fragment fragment) Deprecated (4.2) use `URIBuilder`. Constructs a `URI` using all the parameters.
public static HttpHost	Returns: the target host if the URI is absolute or `null` if the URI is relative or does not contain a valid host name. extractHost(final URI uri) Extracts target host from the given `URI`.
public static URI	Returns: the URI without dot segments normalizeSyntax(final URI the original URI uri) Removes dot segments according to RFC 3986, section 5.2.4 and Syntax-Based Normalization according to RFC 3986, section 6.2.2.
public static URI	Returns: the resulting URI resolve(final URI the base URI baseURI, final String the URI reference reference) Resolves a URI reference against a base URI.
public static URI	Returns: the resulting URI resolve(final URI the base URI baseURI, final URI the URI reference reference) Resolves a URI reference against a base URI.
public static URI	Returns: interpreted (absolute) URI resolve(final URI original request before any redirects originalURI, final HttpHost if the last URI is relative, it is resolved against this target, or `null` if not available. target, final List<URI> collection of redirect locations since the original request or `null` if not available. redirects) Derives the interpreted (absolute) URI that was used to generate the last request.
public static URI	rewriteURI(final URI Contains the path, query and fragment to use. uri, final HttpHost Contains the scheme, host and port to use. target, final boolean True if the fragment should not be copied. dropFragment) Deprecated (4.5.8) Use `rewriteURI(URI, HttpHost, EnumSet)` A convenience method for creating a new `URI` whose scheme, host and port are taken from the target host, but whose path, query and fragment are taken from the existing URI.
public static URI	rewriteURI(final URI Contains the path, query and fragment to use. uri, final HttpHost Contains the scheme, host and port to use. target, final EnumSet<URIUtils.UriFlag> True if the fragment should not be copied. flags) A convenience method for creating a new `URI` whose scheme, host and port are taken from the target host, but whose path, query and fragment are taken from the existing URI.
public static URI	rewriteURI(final URI uri, final HttpHost target) A convenience method for `URIUtils#rewriteURI(URI, HttpHost, EnumSet)` that always keeps the fragment.
public static URI	rewriteURI(final URI original URI. uri) A convenience method that creates a new `URI` whose scheme, host, port, path, query are taken from the existing URI, dropping any fragment or user-information.
public static URI	rewriteURIForRoute(final URI original URI. uri, final RouteInfo route) A convenience method that optionally converts the original `java.net.URI` either to a relative or an absolute form as required by the specified route.
public static URI	rewriteURIForRoute(final URI original URI. uri, final RouteInfo route, final boolean normalizeUri) A convenience method that optionally converts the original `java.net.URI` either to a relative or an absolute form as required by the specified route.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DROP_FRAGMENT	back to summary
public static final EnumSet<URIUtils.UriFlag> DROP_FRAGMENT Set of uri flags containing `UriFlag#DROP_FRAGMENT`. Since 4.5.8

DROP_FRAGMENT_AND_NORMALIZE	back to summary
public static final EnumSet<URIUtils.UriFlag> DROP_FRAGMENT_AND_NORMALIZE Set of uri flags containing `UriFlag#DROP_FRAGMENT` and `UriFlag#NORMALIZE`. Since 4.5.8

NO_FLAGS	back to summary
public static final EnumSet<URIUtils.UriFlag> NO_FLAGS Empty set of uri flags. Since 4.5.8

NORMALIZE	back to summary
public static final EnumSet<URIUtils.UriFlag> NORMALIZE Set of uri flags containing `UriFlag#NORMALIZE`. Since 4.5.8

URIUtils	back to summary
private URIUtils() This class should not be instantiated.

Method Detail

createURI back to summary

createURI	back to summary
public static URI createURI(final String scheme, final String host, final int port, final String path, final String query, final String fragment) throws URISyntaxException Deprecated (4.2) use `URIBuilder`. Constructs a `URI` using all the parameters. This should be used instead of `URI#URI(String, String, String, int, String, String, String)` or any of the other URI multi-argument URI constructors. Parameters scheme:String Scheme name host:String Host name port:int Port number path:String Path query:String Query fragment:String Fragment Annotations @Deprecated Exceptions URISyntaxException: If both a scheme and a path are given but the path is relative, if the URI string constructed from the given components violates RFC 2396, or if the authority component of the string is present but cannot be parsed as a server-based authority

public static URI createURI(final String scheme, final String host, final int port, final String path, final String query, final String fragment) throws URISyntaxException

Deprecated

(4.2) use URIBuilder.

Constructs a URI using all the parameters. This should be used instead of URI#URI(String, String, String, int, String, String, String) or any of the other URI multi-argument URI constructors.

Parameters

scheme:String: Scheme name
host:String: Host name
port:int: Port number
path:String: Path
query:String: Query
fragment:String: Fragment

Annotations

@Deprecated

Exceptions

URISyntaxException:: If both a scheme and a path are given but the path is relative, if the URI string constructed from the given components violates RFC 2396, or if the authority component of the string is present but cannot be parsed as a server-based authority

extractHost back to summary

extractHost	back to summary
public static HttpHost extractHost(final URI uri) Extracts target host from the given `URI`. Returns:HttpHost the target host if the URI is absolute or `null` if the URI is relative or does not contain a valid host name. Since 4.1

public static HttpHost extractHost(final URI uri)

Extracts target host from the given URI.

Returns:HttpHost: the target host if the URI is absolute or null if the URI is relative or does not contain a valid host name.
Since: 4.1

normalizeSyntax	back to summary
public static URI normalizeSyntax(final URI uri) throws URISyntaxException Removes dot segments according to RFC 3986, section 5.2.4 and Syntax-Based Normalization according to RFC 3986, section 6.2.2. Parameters uri:URI the original URI Returns:URI the URI without dot segments Since 4.5

normalizeSyntax

back to summary

public static URI normalizeSyntax(final URI uri) throws URISyntaxException

Removes dot segments according to RFC 3986, section 5.2.4 and Syntax-Based Normalization according to RFC 3986, section 6.2.2.

Parameters

uri:URI: the original URI

Returns:URI

the URI without dot segments

Since

4.5

resolve	back to summary
public static URI resolve(final URI baseURI, final String reference) Resolves a URI reference against a base URI. Work-around for bug in java.net.URI (http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535) Parameters baseURI:URI the base URI reference:String the URI reference Returns:URI the resulting URI

resolve

back to summary

public static URI resolve(final URI baseURI, final String reference)

Resolves a URI reference against a base URI. Work-around for bug in java.net.URI (http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535)

Parameters

baseURI:URI: the base URI
reference:String: the URI reference

Returns:URI

the resulting URI

resolve	back to summary
public static URI resolve(final URI baseURI, final URI reference) Resolves a URI reference against a base URI. Work-around for bugs in java.net.URI (e.g. http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535) Parameters baseURI:URI the base URI reference:URI the URI reference Returns:URI the resulting URI

resolve

back to summary

public static URI resolve(final URI baseURI, final URI reference)

Resolves a URI reference against a base URI. Work-around for bugs in java.net.URI (e.g. http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535)

Parameters

baseURI:URI: the base URI
reference:URI: the URI reference

Returns:URI

the resulting URI

resolve back to summary

resolve	back to summary
public static URI resolve(final URI originalURI, final HttpHost target, final List<URI> redirects) throws URISyntaxException Derives the interpreted (absolute) URI that was used to generate the last request. This is done by extracting the request-uri and target origin for the last request and scanning all the redirect locations for the last fragment identifier, then combining the result into a `URI`. Parameters originalURI:URI original request before any redirects target:HttpHost if the last URI is relative, it is resolved against this target, or `null` if not available. redirects:List<URI> collection of redirect locations since the original request or `null` if not available. Returns:URI interpreted (absolute) URI

public static URI resolve(final URI originalURI, final HttpHost target, final List<URI> redirects) throws URISyntaxException

Derives the interpreted (absolute) URI that was used to generate the last request. This is done by extracting the request-uri and target origin for the last request and scanning all the redirect locations for the last fragment identifier, then combining the result into a URI.

Parameters

originalURI:URI: original request before any redirects
target:HttpHost: if the last URI is relative, it is resolved against this target, or null if not available.
redirects:List<URI>: collection of redirect locations since the original request or null if not available.

Returns:URI

interpreted (absolute) URI

rewriteURI back to summary

rewriteURI	back to summary
public static URI rewriteURI(final URI uri, final HttpHost target, final boolean dropFragment) throws URISyntaxException Deprecated (4.5.8) Use `rewriteURI(URI, HttpHost, EnumSet)` A convenience method for creating a new `URI` whose scheme, host and port are taken from the target host, but whose path, query and fragment are taken from the existing URI. The fragment is only used if dropFragment is false. The path is set to "/" if not explicitly specified. Parameters uri:URI Contains the path, query and fragment to use. target:HttpHost Contains the scheme, host and port to use. dropFragment:boolean True if the fragment should not be copied. Annotations @Deprecated Exceptions URISyntaxException: If the resulting URI is invalid.

public static URI rewriteURI(final URI uri, final HttpHost target, final boolean dropFragment) throws URISyntaxException

Deprecated

(4.5.8) Use rewriteURI(URI, HttpHost, EnumSet)

A convenience method for creating a new URI whose scheme, host and port are taken from the target host, but whose path, query and fragment are taken from the existing URI. The fragment is only used if dropFragment is false. The path is set to "/" if not explicitly specified.

Parameters

uri:URI: Contains the path, query and fragment to use.
target:HttpHost: Contains the scheme, host and port to use.
dropFragment:boolean: True if the fragment should not be copied.

Annotations

@Deprecated

Exceptions

URISyntaxException:: If the resulting URI is invalid.

rewriteURI back to summary

rewriteURI	back to summary
public static URI rewriteURI(final URI uri, final HttpHost target, final EnumSet<URIUtils.UriFlag> flags) throws URISyntaxException A convenience method for creating a new `URI` whose scheme, host and port are taken from the target host, but whose path, query and fragment are taken from the existing URI. What exactly is used and how is driven by the passed in flags. The path is set to "/" if not explicitly specified. Parameters uri:URI Contains the path, query and fragment to use. target:HttpHost Contains the scheme, host and port to use. flags:EnumSet<URIUtils.UriFlag> True if the fragment should not be copied. Exceptions URISyntaxException: If the resulting URI is invalid. Since 4.5.8

public static URI rewriteURI(final URI uri, final HttpHost target, final EnumSet<URIUtils.UriFlag> flags) throws URISyntaxException

A convenience method for creating a new URI whose scheme, host and port are taken from the target host, but whose path, query and fragment are taken from the existing URI. What exactly is used and how is driven by the passed in flags. The path is set to "/" if not explicitly specified.

Parameters

uri:URI: Contains the path, query and fragment to use.
target:HttpHost: Contains the scheme, host and port to use.
flags:EnumSet<URIUtils.UriFlag>: True if the fragment should not be copied.

Exceptions

URISyntaxException:: If the resulting URI is invalid.

Since

4.5.8

rewriteURI	back to summary
public static URI rewriteURI(final URI uri, final HttpHost target) throws URISyntaxException A convenience method for `URIUtils#rewriteURI(URI, HttpHost, EnumSet)` that always keeps the fragment.

rewriteURI back to summary

rewriteURI	back to summary
public static URI rewriteURI(final URI uri) throws URISyntaxException A convenience method that creates a new `URI` whose scheme, host, port, path, query are taken from the existing URI, dropping any fragment or user-information. The path is set to "/" if not explicitly specified. The existing URI is returned unmodified if it has no fragment or user-information and has a path. Parameters uri:URI original URI. Exceptions URISyntaxException: If the resulting URI is invalid.

public static URI rewriteURI(final URI uri) throws URISyntaxException

A convenience method that creates a new URI whose scheme, host, port, path, query are taken from the existing URI, dropping any fragment or user-information. The path is set to "/" if not explicitly specified. The existing URI is returned unmodified if it has no fragment or user-information and has a path.

Parameters

uri:URI: original URI.

Exceptions

URISyntaxException:: If the resulting URI is invalid.

rewriteURIForRoute back to summary

rewriteURIForRoute	back to summary
public static URI rewriteURIForRoute(final URI uri, final RouteInfo route) throws URISyntaxException A convenience method that optionally converts the original `java.net.URI` either to a relative or an absolute form as required by the specified route. Parameters uri:URI original URI. Exceptions URISyntaxException: If the resulting URI is invalid. Since 4.4

public static URI rewriteURIForRoute(final URI uri, final RouteInfo route) throws URISyntaxException

A convenience method that optionally converts the original java.net.URI either to a relative or an absolute form as required by the specified route.

Parameters

uri:URI: original URI.

Exceptions

URISyntaxException:: If the resulting URI is invalid.

Since

4.4

rewriteURIForRoute back to summary

rewriteURIForRoute	back to summary
public static URI rewriteURIForRoute(final URI uri, final RouteInfo route, final boolean normalizeUri) throws URISyntaxException A convenience method that optionally converts the original `java.net.URI` either to a relative or an absolute form as required by the specified route. Parameters uri:URI original URI. Exceptions URISyntaxException: If the resulting URI is invalid. Since 4.5.8

public static URI rewriteURIForRoute(final URI uri, final RouteInfo route, final boolean normalizeUri) throws URISyntaxException

A convenience method that optionally converts the original java.net.URI either to a relative or an absolute form as required by the specified route.

Parameters

uri:URI: original URI.

Exceptions

URISyntaxException:: If the resulting URI is invalid.

Since

4.5.8

Modifier and Type	Method and Description
public static URIUtils.UriFlag	valueOf(String name)
public static URIUtils.UriFlag[]	values()

public Class URIUtils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum URIUtils.UriFlag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
public static final URIUtils.UriFlag	DROP_FRAGMENT
public static final URIUtils.UriFlag	NORMALIZE