Package org.eclipse.jetty.util
Class URIUtil
- java.lang.Object
-
- org.eclipse.jetty.util.URIUtil
-
- All Implemented Interfaces:
Cloneable
@Deprecated(since="2021-05-27") public class URIUtil extends Object implements Cloneable
Deprecated.The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.URI Utility methods.This class assists with the decoding and encoding or HTTP URI's. It differs from the java.net.URL class as it does not provide communications ability, but it does assist with query string formatting.
- See Also:
UrlEncoded
-
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static String
addEncodedPaths(String p1, String p2)
Deprecated.Add two encoded URI path segments.static URI
addPath(URI uri, String path)
Deprecated.static String
addPathQuery(String path, String query)
Deprecated.Add a path and a query stringstatic String
addPaths(String p1, String p2)
Deprecated.Add two Decoded URI path segments.static String
addQueries(String query1, String query2)
Deprecated.Combine two query strings into one.static void
appendSchemeHostPort(StringBuffer url, String scheme, String server, int port)
Deprecated.Append scheme, host and port URI prefix, handling IPv6 address encoding and default portsstatic void
appendSchemeHostPort(StringBuilder url, String scheme, String server, int port)
Deprecated.Append scheme, host and port URI prefix, handling IPv6 address encoding and default portsstatic String
canonicalEncodedPath(String path)
Deprecated.static String
canonicalPath(String path)
Deprecated.Convert a decoded URI path to a canonical form.static String
canonicalURI(String uri)
Deprecated.Convert a partial URI to a canonical form.static String
compactPath(String path)
Deprecated.Convert a path to a compact form.static String
decodePath(String path)
Deprecated.static String
decodePath(String path, int offset, int length)
Deprecated.static String
decodeSpecific(String str, String charsToDecode)
Deprecated.Decode a raw String and convert any specific URI encoded sequences into characters.static String
encodePath(String path)
Deprecated.Encode a URI path.static StringBuilder
encodePath(StringBuilder buf, String path)
Deprecated.Encode a URI path.static String
encodeSpaces(String str)
Deprecated.Encode a raw URI String and convert any raw spaces to their "%20" equivalent.static String
encodeSpecific(String str, String charsToEncode)
Deprecated.Encode a raw String and convert any specific characters to their URI encoded equivalent.static StringBuilder
encodeString(StringBuilder buf, String path, String encode)
Deprecated.Encode a URI path.static boolean
equalsIgnoreEncodings(String uriA, String uriB)
Deprecated.static boolean
equalsIgnoreEncodings(URI uriA, URI uriB)
Deprecated.static String
getJarSource(String uri)
Deprecated.static URI
getJarSource(URI uri)
Deprecated.static String
getUriLastPathSegment(URI uri)
Deprecated.Given a URI, attempt to get the last segment.static boolean
hasScheme(String uri)
Deprecated.static String
newURI(String scheme, String server, int port, String path, String query)
Deprecated.Create a new URI from the arguments, handling IPv6 host encoding and default portsstatic StringBuilder
newURIBuilder(String scheme, String server, int port)
Deprecated.Create a new URI StringBuilder from the arguments, handling IPv6 host encoding and default portsstatic String
parentPath(String p)
Deprecated.Return the parent Path.
-
-
-
Field Detail
-
SLASH
public static final String SLASH
Deprecated.- See Also:
- Constant Field Values
-
HTTP
public static final String HTTP
Deprecated.- See Also:
- Constant Field Values
-
HTTPS
public static final String HTTPS
Deprecated.- See Also:
- Constant Field Values
-
__CHARSET
public static final Charset __CHARSET
Deprecated.
-
-
Method Detail
-
encodePath
public static String encodePath(String path)
Deprecated.Encode a URI path. This is the same encoding offered by URLEncoder, except that the '/' character is not encoded.- Parameters:
path
- The path the encode- Returns:
- The encoded path
-
encodePath
public static StringBuilder encodePath(StringBuilder buf, String path)
Deprecated.Encode a URI path.- Parameters:
path
- The path the encodebuf
- StringBuilder to encode path into (or null)- Returns:
- The StringBuilder or null if no substitutions required.
-
encodeSpaces
public static String encodeSpaces(String str)
Deprecated.Encode a raw URI String and convert any raw spaces to their "%20" equivalent.- Parameters:
str
- input raw string- Returns:
- output with spaces converted to "%20"
-
encodeSpecific
public static String encodeSpecific(String str, String charsToEncode)
Deprecated.Encode a raw String and convert any specific characters to their URI encoded equivalent.- Parameters:
str
- input raw stringcharsToEncode
- the list of raw characters that need to be encoded (if encountered)- Returns:
- output with specified characters encoded.
-
decodeSpecific
public static String decodeSpecific(String str, String charsToDecode)
Deprecated.Decode a raw String and convert any specific URI encoded sequences into characters.- Parameters:
str
- input raw stringcharsToDecode
- the list of raw characters that need to be decoded (if encountered), leaving all other encoded sequences alone.- Returns:
- output with specified characters decoded.
-
encodeString
public static StringBuilder encodeString(StringBuilder buf, String path, String encode)
Deprecated.Encode a URI path.- Parameters:
path
- The path the encodebuf
- StringBuilder to encode path into (or null)encode
- String of characters to encode. % is always encoded.- Returns:
- The StringBuilder or null if no substitutions required.
-
addEncodedPaths
public static String addEncodedPaths(String p1, String p2)
Deprecated.Add two encoded URI path segments. Handles null and empty paths, path and query params (eg ?a=b or ;JSESSIONID=xxx) and avoids duplicate '/'- Parameters:
p1
- URI path segment (should be encoded)p2
- URI path segment (should be encoded)- Returns:
- Legally combined path segments.
-
addPaths
public static String addPaths(String p1, String p2)
Deprecated.Add two Decoded URI path segments. Handles null and empty paths. Path and query params (eg ?a=b or ;JSESSIONID=xxx) are not handled- Parameters:
p1
- URI path segment (should be decoded)p2
- URI path segment (should be decoded)- Returns:
- Legally combined path segments.
-
addPathQuery
public static String addPathQuery(String path, String query)
Deprecated.Add a path and a query string- Parameters:
path
- The path which may already contain contain a queryquery
- The query string or null if no query to be added- Returns:
- The path with any non null query added after a '?' or '&' as appropriate.
-
getUriLastPathSegment
public static String getUriLastPathSegment(URI uri)
Deprecated.Given a URI, attempt to get the last segment.If this is a
jar:file://
style URI, then the JAR filename is returned (not the deep!/path
location)- Parameters:
uri
- the URI to look in- Returns:
- the last segment.
-
parentPath
public static String parentPath(String p)
Deprecated.Return the parent Path. Treat a URI like a directory path and return the parent directory.- Parameters:
p
- the path to return a parent reference to- Returns:
- the parent path of the URI
-
canonicalURI
public static String canonicalURI(String uri)
Deprecated.Convert a partial URI to a canonical form.All segments of "." and ".." are factored out. Null is returned if the path tries to .. above its root.
- Parameters:
uri
- the encoded URI from the path onwards, which may contain query strings and/or fragments- Returns:
- the canonical path, or null if path traversal above root.
- See Also:
canonicalPath(String)
-
canonicalEncodedPath
@Deprecated public static String canonicalEncodedPath(String path)
Deprecated.- Parameters:
path
- the encoded URI from the path onwards, which may contain query strings and/or fragments- Returns:
- the canonical path, or null if path traversal above root.
-
canonicalPath
public static String canonicalPath(String path)
Deprecated.Convert a decoded URI path to a canonical form.All segments of "." and ".." are factored out. Null is returned if the path tries to .. above its root.
- Parameters:
path
- the decoded URI path to convert. Any special characters (e.g. '?', "#") are assumed to be part of the path segments.- Returns:
- the canonical path, or null if path traversal above root.
- See Also:
canonicalURI(String)
-
compactPath
public static String compactPath(String path)
Deprecated.Convert a path to a compact form. All instances of "//" and "///" etc. are factored out to single "/"- Parameters:
path
- the path to compact- Returns:
- the compacted path
-
hasScheme
public static boolean hasScheme(String uri)
Deprecated.- Parameters:
uri
- URI- Returns:
- True if the uri has a scheme
-
newURI
public static String newURI(String scheme, String server, int port, String path, String query)
Deprecated.Create a new URI from the arguments, handling IPv6 host encoding and default ports- Parameters:
scheme
- the URI schemeserver
- the URI serverport
- the URI portpath
- the URI pathquery
- the URI query- Returns:
- A String URI
-
newURIBuilder
public static StringBuilder newURIBuilder(String scheme, String server, int port)
Deprecated.Create a new URI StringBuilder from the arguments, handling IPv6 host encoding and default ports- Parameters:
scheme
- the URI schemeserver
- the URI serverport
- the URI port- Returns:
- a StringBuilder containing URI prefix
-
appendSchemeHostPort
public static void appendSchemeHostPort(StringBuilder url, String scheme, String server, int port)
Deprecated.Append scheme, host and port URI prefix, handling IPv6 address encoding and default ports- Parameters:
url
- StringBuilder to append toscheme
- the URI schemeserver
- the URI serverport
- the URI port
-
appendSchemeHostPort
public static void appendSchemeHostPort(StringBuffer url, String scheme, String server, int port)
Deprecated.Append scheme, host and port URI prefix, handling IPv6 address encoding and default ports- Parameters:
url
- StringBuffer to append toscheme
- the URI schemeserver
- the URI serverport
- the URI port
-
equalsIgnoreEncodings
public static boolean equalsIgnoreEncodings(String uriA, String uriB)
Deprecated.
-
addPath
public static URI addPath(URI uri, String path)
Deprecated.- Parameters:
uri
- A URI to add the path topath
- A decoded path element- Returns:
- URI with path added.
-
addQueries
public static String addQueries(String query1, String query2)
Deprecated.Combine two query strings into one. Each query string should not contain the beginning '?' character, but may contain multiple parameters separated by the '&' character.- Parameters:
query1
- the first query string.query2
- the second query string.- Returns:
- the combination of the two query strings.
-
-