Tomcat 10.1.19 · org.apache.tomcat.util.buf.UriUtil · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final char[]	HEX
private static final Pattern	PATTERN_ASTERISK
private static final Pattern	PATTERN_CARET
private static final Pattern	PATTERN_CUSTOM
private static final Pattern	PATTERN_EXCLAMATION_MARK
private static final String	REPLACE_CUSTOM
private static final String	WAR_SEPARATOR

Access	Constructor and Description
private	UriUtil()

Method Summary

Modifier and Type	Method and Description
public static URL	buildJarSafeUrl(File file)
public static URL	buildJarUrl(File jarFile)
public static URL	buildJarUrl(File jarFile, String entryPath)
public static URL	buildJarUrl(String fileUrlString)
public static URL	buildJarUrl(String fileUrlString, String entryPath)
public static String	getWarSeparator()
public static boolean	Returns: `true` if a scheme is present, otherwise {code @false} hasScheme(CharSequence The URI to test uri) Determine if a URI string has a `scheme` component.
public static boolean	Returns: `true` if the supplied path starts with once of the recognised sequences. isAbsoluteURI(String The path to test path) Does the provided path start with `file:/` or `<protocol>://`.
private static boolean	Returns: `true` if a the character is allowed, otherwise `false` isSchemeChar(char The character to test c) Determine if the character is allowed in the scheme of a URI.
private static String	makeSafeForJarUrl(String input)
public static URI	Returns: The resulting URI as per `URI#resolve(String)` resolve(URI The base URI to resolve against base, String The path to resolve target) Replicates the behaviour of `URI#resolve(String)` and adds support for URIs of the form `jar:file:/...`
public static URL	Returns: The equivalent JAR URL warToJar(URL The WAR URL to convert warUrl) Convert a URL of the form `war:file:...`

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

HEX	back to summary
private static final char[] HEX

PATTERN_ASTERISK	back to summary
private static final Pattern PATTERN_ASTERISK

PATTERN_CARET	back to summary
private static final Pattern PATTERN_CARET

PATTERN_CUSTOM	back to summary
private static final Pattern PATTERN_CUSTOM

PATTERN_EXCLAMATION_MARK	back to summary
private static final Pattern PATTERN_EXCLAMATION_MARK

REPLACE_CUSTOM	back to summary
private static final String REPLACE_CUSTOM

WAR_SEPARATOR	back to summary
private static final String WAR_SEPARATOR

UriUtil	back to summary
private UriUtil()

Method Detail

buildJarSafeUrl	back to summary
public static URL buildJarSafeUrl(File file) throws MalformedURLException

buildJarUrl	back to summary
public static URL buildJarUrl(File jarFile) throws MalformedURLException

buildJarUrl	back to summary
public static URL buildJarUrl(File jarFile, String entryPath) throws MalformedURLException

buildJarUrl	back to summary
public static URL buildJarUrl(String fileUrlString) throws MalformedURLException

buildJarUrl	back to summary
public static URL buildJarUrl(String fileUrlString, String entryPath) throws MalformedURLException

getWarSeparator	back to summary
public static String getWarSeparator()

hasScheme back to summary

hasScheme	back to summary
public static boolean hasScheme(CharSequence uri) Determine if a URI string has a `scheme` component. Parameters uri:CharSequence The URI to test Returns:boolean `true` if a scheme is present, otherwise {code @false}

public static boolean hasScheme(CharSequence uri)

Determine if a URI string has a scheme component.

Parameters

uri:CharSequence: The URI to test

Returns:boolean

true if a scheme is present, otherwise {code @false}

isAbsoluteURI back to summary

isAbsoluteURI	back to summary
public static boolean isAbsoluteURI(String path) Does the provided path start with `file:/` or `<protocol>://`. Parameters path:String The path to test Returns:boolean `true` if the supplied path starts with once of the recognised sequences.

public static boolean isAbsoluteURI(String path)

Does the provided path start with file:/ or <protocol>://.

Parameters

path:String: The path to test

Returns:boolean

true if the supplied path starts with once of the recognised sequences.

isSchemeChar back to summary

isSchemeChar	back to summary
private static boolean isSchemeChar(char c) Determine if the character is allowed in the scheme of a URI. See RFC 2396, Section 3.1 Parameters c:char The character to test Returns:boolean `true` if a the character is allowed, otherwise `false`

private static boolean isSchemeChar(char c)

Determine if the character is allowed in the scheme of a URI. See RFC 2396, Section 3.1

Parameters

c:char: The character to test

Returns:boolean

true if a the character is allowed, otherwise false

makeSafeForJarUrl	back to summary
private static String makeSafeForJarUrl(String input)

resolve back to summary

resolve	back to summary
public static URI resolve(URI base, String target) throws MalformedURLException, URISyntaxException Replicates the behaviour of `URI#resolve(String)` and adds support for URIs of the form `jar:file:/...` . Parameters base:URI The base URI to resolve against target:String The path to resolve Returns:URI The resulting URI as per `URI#resolve(String)` Exceptions MalformedURLException: If the base URI cannot be converted to a URL URISyntaxException: If the resulting URL cannot be converted to a URI

public static URI resolve(URI base, String target) throws MalformedURLException, URISyntaxException

Replicates the behaviour of URI#resolve(String) and adds support for URIs of the form jar:file:/... .

Parameters

base:URI: The base URI to resolve against
target:String: The path to resolve

Returns:URI

The resulting URI as per URI#resolve(String)

Exceptions

MalformedURLException:: If the base URI cannot be converted to a URL
URISyntaxException:: If the resulting URL cannot be converted to a URI

warToJar back to summary

warToJar	back to summary
public static URL warToJar(URL warUrl) throws MalformedURLException Convert a URL of the form `war:file:...` to `jar:file:...`. Parameters warUrl:URL The WAR URL to convert Returns:URL The equivalent JAR URL Exceptions MalformedURLException: If the conversion fails

public static URL warToJar(URL warUrl) throws MalformedURLException

Convert a URL of the form war:file:... to jar:file:....

Parameters

warUrl:URL: The WAR URL to convert

Returns:URL

The equivalent JAR URL

Exceptions

MalformedURLException:: If the conversion fails

public final Class UriUtil

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail