org.apache.tomcat.util.buf

## Class UriUtil

- java.lang.Object
- - org.apache.tomcat.util.buf.UriUtil

-     public final class UriUtil
      extends Object

  Utility class for working with URIs and URLs.

- - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static URL` | `buildJarSafeUrl(File file)`
    `static URL` | `buildJarUrl(File jarFile)`
    `static URL` | `buildJarUrl(File jarFile, String entryPath)`
    `static URL` | `buildJarUrl(String fileUrlString)`
    `static URL` | `buildJarUrl(String fileUrlString, String entryPath)`
    `static String` | `getWarSeparator()`
    `static boolean` | `hasScheme(CharSequence uri)` Determine if a URI string has a `scheme` component.
    `static boolean` | `isAbsoluteURI(String path)` Does the provided path start with `file:/` or `<protocol>://`.
    `static URL` | `warToJar(URL warUrl)` Convert a URL of the form `war:file:...`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### hasScheme

          public static boolean hasScheme(CharSequence uri)

      Determine if a URI string has a `scheme` component.
      Parameters:
        `uri` - The URI to test
      Returns:
        `true` if a scheme is present, otherwise {code @false}

    - #### buildJarUrl

          public static URL buildJarUrl(File jarFile)
                                 throws MalformedURLException

      Throws:
        `MalformedURLException`

    - #### buildJarUrl

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

      Throws:
        `MalformedURLException`

    - #### buildJarUrl

          public static URL buildJarUrl(String fileUrlString)
                                 throws MalformedURLException

      Throws:
        `MalformedURLException`

    - #### buildJarUrl

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

      Throws:
        `MalformedURLException`

    - #### buildJarSafeUrl

          public static URL buildJarSafeUrl(File file)
                                     throws MalformedURLException

      Throws:
        `MalformedURLException`

    - #### warToJar

          public static URL warToJar(URL warUrl)
                              throws MalformedURLException

      Convert a URL of the form `war:file:...` to `jar:file:...`.
      Parameters:
        `warUrl` - The WAR URL to convert
      Returns:
        The equivalent JAR URL
      Throws:
        `MalformedURLException` - If the conversion fails

    - #### getWarSeparator

          public static String getWarSeparator()

    - #### isAbsoluteURI

          public static boolean isAbsoluteURI(String path)

      Does the provided path start with `file:/` or `<protocol>://`.
      Parameters:
        `path` - The path to test
      Returns:
        `true` if the supplied path starts with once of the recognised sequences.

Copyright © 2000-2022 Apache Software Foundation. All Rights Reserved.