Package org.eclipse.jetty.http

Class HttpURI.Immutable

java.lang.Object

org.eclipse.jetty.http.HttpURI.Immutable

All Implemented Interfaces:

Serializable, HttpURI

Direct Known Subclasses:

HttpURI.Unsafe

Enclosing interface:

HttpURI

public static class HttpURI.Immutable
extends Object
implements HttpURI, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.http.HttpURI

HttpURI.Immutable, HttpURI.Mutable, HttpURI.Unsafe

Method Summary

Modifier and Type	Method	Description
HttpURI.Immutable	asImmutable()
String	asString()
boolean	equals(Object o)
String	getAuthority()
String	getCanonicalPath()
String	getDecodedPath()
String	getFragment()
String	getHost()
String	getParam()	Get a URI path parameter.
String	getPath()
String	getPathQuery()
int	getPort()
String	getQuery()
String	getScheme()
String	getUser()
Collection<UriCompliance.Violation>	getViolations()
boolean	hasAuthority()
int	hashCode()
boolean	hasViolation(UriCompliance.Violation violation)
boolean	hasViolations()	Checks if the URI has any compliance violations against the URI specification or best practices.
boolean	isAbsolute()
boolean	isAmbiguous()	Checks if the URI contains any ambiguous path violations that could be interpreted differently by different URI parsers.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.http.HttpURI

hasAmbiguousEmptySegment, hasAmbiguousEncoding, hasAmbiguousParameter, hasAmbiguousSegment, hasAmbiguousSeparator, hasUtf16Encoding, toURI

Method Details

asImmutable

public HttpURI.Immutable asImmutable()

Specified by:

asImmutable in interface HttpURI

Returns:

An immutable copy of this HttpURI.

asString

public String asString()

Specified by:

asString in interface HttpURI

Returns:

The URI as a string.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getAuthority

public String getAuthority()

Specified by:

getAuthority in interface HttpURI

Returns:

The authority component of the URI in the form host:port, or just host if the port is not set, or null if no host is set.

getDecodedPath

public String getDecodedPath()

Specified by:

getDecodedPath in interface HttpURI

Returns:

The decoded path with percent-encoded characters decoded, or null if no path is set.

See Also:

• HttpURI.getCanonicalPath()

getCanonicalPath

public String getCanonicalPath()

Specified by:

getCanonicalPath in interface HttpURI

Returns:

The canonical path with path parameters removed and percent-encoded characters decoded, or null if no path is set.

See Also:

• HttpURI.getDecodedPath()
• HttpURI.getPath()

getFragment

public String getFragment()

Specified by:

getFragment in interface HttpURI

Returns:

The fragment component of the URI (after the # character), or null if not set.

getHost

public String getHost()

Specified by:

getHost in interface HttpURI

Returns:

The host component of the URI, or null if not set.

getParam

public String getParam()

Description copied from interface: HttpURI

Get a URI path parameter.

Path parameters were defined in RFC 2068 and appear after a semicolon in the path, such as /path;param. This is distinct from query parameters which appear after the ? character.

Specified by:

getParam in interface HttpURI

Returns:

The last path parameter, or null if no path parameter is present. If there are multiple path parameters, only the last one is returned.

See Also:

• HttpURI.getQuery()

getPath

public String getPath()

Specified by:

getPath in interface HttpURI

Returns:

The raw, undecoded, path component of the URI including path parameters, or null if not set.

See Also:

• HttpURI.getCanonicalPath()
• HttpURI.getDecodedPath()

getPathQuery

public String getPathQuery()

Specified by:

getPathQuery in interface HttpURI

Returns:

The raw, undecoded, path and query components combined as path?query, or just the path if no query is present, or null if no path is set.

getPort

public int getPort()

Specified by:

getPort in interface HttpURI

Returns:

The port number of the URI, or -1 if not set.

getQuery

public String getQuery()

Specified by:

getQuery in interface HttpURI

Returns:

The query string component of the URI (after the ? character but before any # fragment), or null if not set.

See Also:

• HttpURI.getParam()

getScheme

public String getScheme()

Specified by:

getScheme in interface HttpURI

Returns:

The URI scheme such as http or https, or null if not set.

getUser

public String getUser()

Specified by:

getUser in interface HttpURI

Returns:

The user info component of the URI authority (before the @ character), or null if not set.

hasAuthority

public boolean hasAuthority()

Specified by:

hasAuthority in interface HttpURI

Returns:

true if the URI has an authority component.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface HttpURI

Returns:

true if the URI has a scheme component.

isAmbiguous

public boolean isAmbiguous()

Description copied from interface: HttpURI

Checks if the URI contains any ambiguous path violations that could be interpreted differently by different URI parsers.

Specified by:

isAmbiguous in interface HttpURI

Returns:

true if the URI has any ambiguous UriCompliance.Violations.

See Also:

• HttpURI.hasViolations()
• UriCompliance.isAmbiguous(Set)

hasViolations

public boolean hasViolations()

Description copied from interface: HttpURI

Checks if the URI has any compliance violations against the URI specification or best practices.

Specified by:

hasViolations in interface HttpURI

Returns:

true if the URI has any UriCompliance.Violations.

See Also:

• HttpURI.getViolations()
• HttpURI.isAmbiguous()

hasViolation

public boolean hasViolation(UriCompliance.Violation violation)

Specified by:

hasViolation in interface HttpURI

Parameters:

violation - The violation to check.

Returns:

true if the URI has the specified violation.

See Also:

• HttpURI.getViolations()

getViolations

public Collection<UriCompliance.Violation> getViolations()

Specified by:

getViolations in interface HttpURI

Returns:

The set of UriCompliance.Violations detected in the URI, or an empty set if none.

See Also:

• HttpURI.hasViolations()
• HttpURI.hasViolation(Violation)

toString

public String toString()

Overrides:

toString in class Object