Package ca.uhn.fhir.util

Class UrlUtil

java.lang.Object
ca.uhn.fhir.util.UrlUtil
public class UrlUtil extends Object

  • Method Details

    • sanitizeHeaderValue

      public static String sanitizeHeaderValue(String theHeader)
      Cleans up a value that will be serialized as an HTTP header. This method:

      - Strips any newline (\r or \n) characters

      Since:
      6.2.0

    • sanitizeBaseUrl

      public static String sanitizeBaseUrl(String theBaseUrl)

    • constructAbsoluteUrl

      public static String constructAbsoluteUrl(String theBase, String theEndpoint)
      Resolve a relative URL - THIS METHOD WILL NOT FAIL but will log a warning and return theEndpoint if the input is invalid.

    • constructRelativeUrl

      public static String constructRelativeUrl(String theParentExtensionUrl, String theExtensionUrl)

    • determineResourceTypeInResourceUrl

      @Nullable public static String determineResourceTypeInResourceUrl(FhirContext theFhirContext, String theUrl)
      Given a FHIR resource URL, extracts the associated resource type. Supported formats include the following inputs, all of which will return Patient. If no resource type can be determined, null will be returned.
      • Patient
      • Patient?
      • Patient?identifier=foo
      • /Patient
      • /Patient?
      • /Patient?identifier=foo
      • http://foo/base/Patient?identifier=foo
      • http://foo/base/Patient/1
      • http://foo/base/Patient/1/_history/2
      • Patient/1
      • Patient/1/_history/2
      • /Patient/1
      • /Patient/1/_history/2

    • escapeUrlParam

      public static String escapeUrlParam(String theUnescaped)
      URL encode a value according to RFC 3986, except for the following characters: -_.*.

      This method is intended to be applied to an individual parameter name or value. For example, if you are creating the URL http://example.com/fhir/Patient?key=føø it would be appropriate to pass the string "føø" to this method, but not appropriate to pass the entire URL since characters such as "/" and "?" would also be escaped.

      See Also:

    • escapeUrlParam

      public static String escapeUrlParam(String theUnescaped, boolean theEscapeSlash)
      URL encode a value according to RFC 3986, except for the following characters: -_.*, and optionally /.

      This method is intended to be applied to an individual parameter name or value. For example, if you are creating the URL http://example.com/fhir/Patient?key=føø it would be appropriate to pass the string "føø" to this method, but not appropriate to pass the entire URL since characters such as "?" and possibly "/" would also be escaped.

      Parameters:
      theEscapeSlash - If true, the slash character will be percent-escaped. Set this to false if you are escaping a query parameter value, since slashes will be more readable in the URL than the percent-encoded version. If you aren't sure where the escaped version will appear, always set this to false, or just call escapeUrlParam(String) instead.
      Since:
      8.6.0

    • escapeUrlParams

      public static List<String> escapeUrlParams(@Nonnull Collection<String> theUnescaped)
      Applies the same encodong as escapeUrlParam(String) but against all values in a collection

    • isAbsolute

      public static boolean isAbsolute(String theValue)

    • isNeedsSanitization

      public static boolean isNeedsSanitization(CharSequence theString)

    • isValid

      public static boolean isValid(String theUrl)

    • parseUrlResourceType

      public static RuntimeResourceDefinition parseUrlResourceType(FhirContext theCtx, String theUrl) throws DataFormatException
      Throws:
      DataFormatException

    • parseQueryString

      @Nonnull public static Map<String,String[]> parseQueryString(String theQueryString)

    • parseQueryStrings

      public static Map<String,String[]> parseQueryStrings(String... theQueryString)

    • normalizeCanonicalUrlForComparison

      public static String normalizeCanonicalUrlForComparison(String theUrl)
      Normalizes canonical URLs for comparison. Trailing "/" is stripped, and any version identifiers or fragment hash is removed

    • parseUrl

      public static UrlUtil.UrlParts parseUrl(String theUrl)
      Parse a URL in one of the following forms:
      • [Resource Type]?[Search Params]
      • [Resource Type]/[Resource ID]
      • [Resource Type]/[Resource ID]/_history/[Version ID]

    • sanitizeUrlPart

      public static String sanitizeUrlPart(IPrimitiveType<?> theString)
      This method specifically HTML-encodes the " and < characters in order to prevent injection attacks

    • sanitizeUrlPart

      public static String sanitizeUrlPart(CharSequence theString)
      This method specifically HTML-encodes the " and < characters in order to prevent injection attacks.

      The following characters are escaped:

      • '
      • "
      • <
      • >
      • \n (newline)

    • sanitizeUrlPart

      public static String[] sanitizeUrlPart(String[] theParameterValues)
      Applies the same logic as sanitizeUrlPart(CharSequence) but against an array, returning an array with the same strings as the input but with sanitization applied

    • unescape

      public static String unescape(String theString)

    • getAboveUriCandidates

      public static List<String> getAboveUriCandidates(String theUri)
      Creates list of sub URIs candidates for search with :above modifier Example input: http://[host]/[pathPart1]/[pathPart2] Example output: http://[host], http://[host]/[pathPart1], http://[host]/[pathPart1]/[pathPart2]
      Parameters:
      theUri - String URI parameter
      Returns:
      List of URI candidates