Class Uri

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.glib.Uri
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class Uri extends ProxyInstance

The GUri type and related functions can be used to parse URIs into their components, and build valid URIs from individual components.

Since GUri only represents absolute URIs, all GUris will have a URI scheme, so getScheme() will always return a non-NULL answer. Likewise, by definition, all URIs have a path component, so getPath() will always return a non-NULL string (which may be empty).

If the URI string has an ‘authority’ component (that is, if the scheme is followed by :// rather than just :), then the GUri will contain a hostname, and possibly a port and ‘userinfo’. Additionally, depending on how the GUri was constructed/parsed (for example, using the G_URI_FLAGS_HAS_PASSWORD and G_URI_FLAGS_HAS_AUTH_PARAMS flags), the userinfo may be split out into a username, password, and additional authorization-related parameters.

Normally, the components of a GUri will have all %-encoded characters decoded. However, if you construct/parse a GUri with G_URI_FLAGS_ENCODED, then the %-encoding will be preserved instead in the userinfo, path, and query fields (and in the host field if also created with G_URI_FLAGS_NON_DNS). In particular, this is necessary if the URI may contain binary data or non-UTF-8 text, or if decoding the components might change the interpretation of the URI.

For example, with the encoded flag:

g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue", G_URI_FLAGS_ENCODED, &err);
g_assert_cmpstr (g_uri_get_query (uri), ==, "query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue");

While the default %-decoding behaviour would give:

g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue", G_URI_FLAGS_NONE, &err);
g_assert_cmpstr (g_uri_get_query (uri), ==, "query=http://host/path?param=value");

During decoding, if an invalid UTF-8 string is encountered, parsing will fail with an error indicating the bad string location:

g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fbad%3D%00alue", G_URI_FLAGS_NONE, &err);
g_assert_error (err, G_URI_ERROR, G_URI_ERROR_BAD_QUERY);

You should pass G_URI_FLAGS_ENCODED or G_URI_FLAGS_ENCODED_QUERY if you need to handle that case manually. In particular, if the query string contains = characters that are %-encoded, you should let parseParams(String, long, String, Set) do the decoding once of the query.

GUri is immutable once constructed, and can safely be accessed from multiple threads. Its reference counting is atomic.

Note that the scope of GUri is to help manipulate URIs in various applications, following RFC 3986. In particular, it doesn't intend to cover web browser needs, and doesn’t implement the WHATWG URL standard. No APIs are provided to help prevent homograph attacks, so GUri is not suitable for formatting URIs for display to the user for making security-sensitive decisions.

Relative and absolute URIs

As defined in RFC 3986, the hierarchical nature of URIs means that they can either be ‘relative references’ (sometimes referred to as ‘relative URIs’) or ‘URIs’ (for clarity, ‘URIs’ are referred to in this documentation as ‘absolute URIs’ — although in contrast to RFC 3986, fragment identifiers are always allowed).

Relative references have one or more components of the URI missing. In particular, they have no scheme. Any other component, such as hostname, query, etc. may be missing, apart from a path, which has to be specified (but may be empty). The path may be relative, starting with ./ rather than /.

For example, a valid relative reference is ./path?query, /?query#fragment or //example.com.

Absolute URIs have a scheme specified. Any other components of the URI which are missing are specified as explicitly unset in the URI, rather than being resolved relative to a base URI using parseRelative(String, Set).

For example, a valid absolute URI is file:///home/bob or https://search.com?query=string.

A GUri instance is always an absolute URI. A string may be an absolute URI or a relative reference; see the documentation for individual functions as to what forms they accept.

Parsing URIs

The most minimalist APIs for parsing URIs are split(String, Set, Out, Out, Out, Out, Out, Out, Out) and splitWithUser(String, Set, Out, Out, Out, Out, Out, Out, Out, Out, Out). These split a URI into its component parts, and return the parts; the difference between the two is that split(String, Set, Out, Out, Out, Out, Out, Out, Out) treats the ‘userinfo’ component of the URI as a single element, while splitWithUser(String, Set, Out, Out, Out, Out, Out, Out, Out, Out, Out) can (depending on the GLib.UriFlags you pass) treat it as containing a username, password, and authentication parameters. Alternatively, splitNetwork(String, Set, Out, Out, Out) can be used when you are only interested in the components that are needed to initiate a network connection to the service (scheme, host, and port).

parse(String, Set) is similar to split(String, Set, Out, Out, Out, Out, Out, Out, Out), but instead of returning individual strings, it returns a GUri structure (and it requires that the URI be an absolute URI).

resolveRelative(String, String, Set) and parseRelative(String, Set) allow you to resolve a relative URI relative to a base URI. resolveRelative(String, String, Set) takes two strings and returns a string, and parseRelative(String, Set) takes a GUri and a string and returns a GUri.

All of the parsing functions take a GLib.UriFlags argument describing exactly how to parse the URI; see the documentation for that type for more details on the specific flags that you can pass. If you need to choose different flags based on the type of URI, you can use peekScheme(String) on the URI string to check the scheme first, and use that to decide what flags to parse it with.

For example, you might want to use G_URI_PARAMS_WWW_FORM when parsing the params for a web URI, so compare the result of peekScheme(String) against http and https.

Building URIs

join(Set, String, String, String, int, String, String, String) and joinWithUser(Set, String, String, String, String, String, int, String, String, String) can be used to construct valid URI strings from a set of component strings. They are the inverse of split(String, Set, Out, Out, Out, Out, Out, Out, Out) and splitWithUser(String, Set, Out, Out, Out, Out, Out, Out, Out, Out, Out).

Similarly, build(Set, String, String, String, int, String, String, String) and buildWithUser(Set, String, String, String, String, String, int, String, String, String) can be used to construct a GUri from a set of component strings.

As with the parsing functions, the building functions take a GLib.UriFlags argument. In particular, it is important to keep in mind whether the URI components you are using are already %-encoded. If so, you must pass the G_URI_FLAGS_ENCODED flag.

file:// URIs

Note that Windows and Unix both define special rules for parsing file:// URIs (involving non-UTF-8 character sets on Unix, and the interpretation of path separators on Windows). GUri does not implement these rules. Use GLib.filenameFromUri(String, Out) and GLib.filenameToUri(String, String) if you want to properly convert between file:// URIs and local filenames.

URI Equality

Note that there is no g_uri_equal () function, because comparing URIs usefully requires scheme-specific knowledge that GUri does not have. GUri can help with normalization if you use the various encoded GLib.UriFlags as well as G_URI_FLAGS_SCHEME_NORMALIZE however it is not comprehensive. For example, data:,foo and data:;base64,Zm9v resolve to the same thing according to the data: URI specification which GLib does not handle.

Since:
2.66

  • Constructor Details

    • Uri

      public Uri(MemorySegment address)
      Create a Uri proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the Uri class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • build

      public static Uri build(Set<UriFlags> flags, String scheme, @Nullable String userinfo, @Nullable String host, int port, String path, @Nullable String query, @Nullable String fragment)

      Creates a new GUri from the given components according to flags.

      See also g_uri_build_with_user(), which allows specifying the components of the "userinfo" separately.

      Parameters:
      flags - flags describing how to build the GUri
      scheme - the URI scheme
      userinfo - the userinfo component, or null
      host - the host component, or null
      port - the port, or -1
      path - the path component
      query - the query component, or null
      fragment - the fragment, or null
      Returns:
      a new GUri
      Since:
      2.66

    • build

      public static Uri build(UriFlags flags, String scheme, @Nullable String userinfo, @Nullable String host, int port, String path, @Nullable String query, @Nullable String fragment)

      Creates a new GUri from the given components according to flags.

      See also g_uri_build_with_user(), which allows specifying the components of the "userinfo" separately.

      Parameters:
      flags - flags describing how to build the GUri
      scheme - the URI scheme
      userinfo - the userinfo component, or null
      host - the host component, or null
      port - the port, or -1
      path - the path component
      query - the query component, or null
      fragment - the fragment, or null
      Returns:
      a new GUri
      Since:
      2.66

    • buildWithUser

      public static Uri buildWithUser(Set<UriFlags> flags, String scheme, @Nullable String user, @Nullable String password, @Nullable String authParams, @Nullable String host, int port, String path, @Nullable String query, @Nullable String fragment)

      Creates a new GUri from the given components according to flags (UriFlags.HAS_PASSWORD is added unconditionally). The flags must be coherent with the passed values, in particular use %-encoded values with UriFlags.ENCODED.

      In contrast to g_uri_build(), this allows specifying the components of the ‘userinfo’ field separately. Note that user must be non-null if either password or authParams is non-null.

      Parameters:
      flags - flags describing how to build the GUri
      scheme - the URI scheme
      user - the user component of the userinfo, or null
      password - the password component of the userinfo, or null
      authParams - the auth params of the userinfo, or null
      host - the host component, or null
      port - the port, or -1
      path - the path component
      query - the query component, or null
      fragment - the fragment, or null
      Returns:
      a new GUri
      Since:
      2.66

    • buildWithUser

      public static Uri buildWithUser(UriFlags flags, String scheme, @Nullable String user, @Nullable String password, @Nullable String authParams, @Nullable String host, int port, String path, @Nullable String query, @Nullable String fragment)

      Creates a new GUri from the given components according to flags (UriFlags.HAS_PASSWORD is added unconditionally). The flags must be coherent with the passed values, in particular use %-encoded values with UriFlags.ENCODED.

      In contrast to g_uri_build(), this allows specifying the components of the ‘userinfo’ field separately. Note that user must be non-null if either password or authParams is non-null.

      Parameters:
      flags - flags describing how to build the GUri
      scheme - the URI scheme
      user - the user component of the userinfo, or null
      password - the password component of the userinfo, or null
      authParams - the auth params of the userinfo, or null
      host - the host component, or null
      port - the port, or -1
      path - the path component
      query - the query component, or null
      fragment - the fragment, or null
      Returns:
      a new GUri
      Since:
      2.66

    • errorQuark

      public static Quark errorQuark()

    • escapeBytes

      public static String escapeBytes(@Nullable byte @Nullable [] unescaped, @Nullable String reservedCharsAllowed)

      Escapes arbitrary data for use in a URI.

      Normally all characters that are not ‘unreserved’ (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. But if you specify characters in reservedCharsAllowed they are not escaped. This is useful for the ‘reserved’ characters in the URI specification, since those are allowed unescaped in some portions of a URI.

      Though technically incorrect, this will also allow escaping nul bytes as %``00.

      Parameters:
      unescaped - the unescaped input data.
      reservedCharsAllowed - a string of reserved characters that are allowed to be used, or null.
      Returns:
      an escaped version of unescaped. The returned string should be freed when no longer needed.
      Since:
      2.66

    • escapeString

      public static String escapeString(String unescaped, @Nullable String reservedCharsAllowed, boolean allowUtf8)

      Escapes a string for use in a URI.

      Normally all characters that are not "unreserved" (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. But if you specify characters in reservedCharsAllowed they are not escaped. This is useful for the "reserved" characters in the URI specification, since those are allowed unescaped in some portions of a URI.

      Parameters:
      unescaped - the unescaped input string.
      reservedCharsAllowed - a string of reserved characters that are allowed to be used, or null.
      allowUtf8 - true if the result can include UTF-8 characters.
      Returns:
      an escaped version of unescaped. The returned string should be freed when no longer needed.
      Since:
      2.16

    • isValid

      public static boolean isValid(String uriString, Set<UriFlags> flags) throws GErrorException

      Parses uriString according to flags, to determine whether it is a valid absolute URI, i.e. it does not need to be resolved relative to another URI using g_uri_parse_relative().

      If it’s not a valid URI, an error is returned explaining how it’s invalid.

      See g_uri_split(), and the definition of GUriFlags, for more information on the effect of flags.

      Parameters:
      uriString - a string containing an absolute URI
      flags - flags for parsing uriString
      Returns:
      true if uriString is a valid absolute URI, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • isValid

      public static boolean isValid(String uriString, UriFlags... flags) throws GErrorException

      Parses uriString according to flags, to determine whether it is a valid absolute URI, i.e. it does not need to be resolved relative to another URI using g_uri_parse_relative().

      If it’s not a valid URI, an error is returned explaining how it’s invalid.

      See g_uri_split(), and the definition of GUriFlags, for more information on the effect of flags.

      Parameters:
      uriString - a string containing an absolute URI
      flags - flags for parsing uriString
      Returns:
      true if uriString is a valid absolute URI, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • join

      public static String join(Set<UriFlags> flags, @Nullable String scheme, @Nullable String userinfo, @Nullable String host, int port, String path, @Nullable String query, @Nullable String fragment)

      Joins the given components together according to flags to create an absolute URI string. path may not be null (though it may be the empty string).

      When host is present, path must either be empty or begin with a slash (/) character. When host is not present, path cannot begin with two slash characters (//). See RFC 3986, section 3.

      See also g_uri_join_with_user(), which allows specifying the components of the ‘userinfo’ separately.

      UriFlags.HAS_PASSWORD and UriFlags.HAS_AUTH_PARAMS are ignored if set in flags.

      Parameters:
      flags - flags describing how to build the URI string
      scheme - the URI scheme, or null
      userinfo - the userinfo component, or null
      host - the host component, or null
      port - the port, or -1
      path - the path component
      query - the query component, or null
      fragment - the fragment, or null
      Returns:
      an absolute URI string
      Since:
      2.66

    • join

      public static String join(UriFlags flags, @Nullable String scheme, @Nullable String userinfo, @Nullable String host, int port, String path, @Nullable String query, @Nullable String fragment)

      Joins the given components together according to flags to create an absolute URI string. path may not be null (though it may be the empty string).

      When host is present, path must either be empty or begin with a slash (/) character. When host is not present, path cannot begin with two slash characters (//). See RFC 3986, section 3.

      See also g_uri_join_with_user(), which allows specifying the components of the ‘userinfo’ separately.

      UriFlags.HAS_PASSWORD and UriFlags.HAS_AUTH_PARAMS are ignored if set in flags.

      Parameters:
      flags - flags describing how to build the URI string
      scheme - the URI scheme, or null
      userinfo - the userinfo component, or null
      host - the host component, or null
      port - the port, or -1
      path - the path component
      query - the query component, or null
      fragment - the fragment, or null
      Returns:
      an absolute URI string
      Since:
      2.66

    • joinWithUser

      public static String joinWithUser(Set<UriFlags> flags, @Nullable String scheme, @Nullable String user, @Nullable String password, @Nullable String authParams, @Nullable String host, int port, String path, @Nullable String query, @Nullable String fragment)

      Joins the given components together according to flags to create an absolute URI string. path may not be null (though it may be the empty string).

      In contrast to g_uri_join(), this allows specifying the components of the ‘userinfo’ separately. It otherwise behaves the same.

      UriFlags.HAS_PASSWORD and UriFlags.HAS_AUTH_PARAMS are ignored if set in flags.

      Parameters:
      flags - flags describing how to build the URI string
      scheme - the URI scheme, or null
      user - the user component of the userinfo, or null
      password - the password component of the userinfo, or null
      authParams - the auth params of the userinfo, or null
      host - the host component, or null
      port - the port, or -1
      path - the path component
      query - the query component, or null
      fragment - the fragment, or null
      Returns:
      an absolute URI string
      Since:
      2.66

    • joinWithUser

      public static String joinWithUser(UriFlags flags, @Nullable String scheme, @Nullable String user, @Nullable String password, @Nullable String authParams, @Nullable String host, int port, String path, @Nullable String query, @Nullable String fragment)

      Joins the given components together according to flags to create an absolute URI string. path may not be null (though it may be the empty string).

      In contrast to g_uri_join(), this allows specifying the components of the ‘userinfo’ separately. It otherwise behaves the same.

      UriFlags.HAS_PASSWORD and UriFlags.HAS_AUTH_PARAMS are ignored if set in flags.

      Parameters:
      flags - flags describing how to build the URI string
      scheme - the URI scheme, or null
      user - the user component of the userinfo, or null
      password - the password component of the userinfo, or null
      authParams - the auth params of the userinfo, or null
      host - the host component, or null
      port - the port, or -1
      path - the path component
      query - the query component, or null
      fragment - the fragment, or null
      Returns:
      an absolute URI string
      Since:
      2.66

    • listExtractUris

      public static String[] listExtractUris(String uriList)
      Splits an URI list conforming to the text/uri-list mime type defined in RFC 2483 into individual URIs, discarding any comments. The URIs are not validated.
      Parameters:
      uriList - an URI list
      Returns:
      a newly allocated null-terminated list of strings holding the individual URIs. The array should be freed with g_strfreev().
      Since:
      2.6

    • parse

      public static Uri parse(String uriString, Set<UriFlags> flags) throws GErrorException
      Parses uriString according to flags. If the result is not a valid absolute URI, it will be discarded, and an error returned.
      Parameters:
      uriString - a string representing an absolute URI
      flags - flags describing how to parse uriString
      Returns:
      a new GUri, or NULL on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • parse

      public static Uri parse(String uriString, UriFlags... flags) throws GErrorException
      Parses uriString according to flags. If the result is not a valid absolute URI, it will be discarded, and an error returned.
      Parameters:
      uriString - a string representing an absolute URI
      flags - flags describing how to parse uriString
      Returns:
      a new GUri, or NULL on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • parseParams

      public static HashTable<String,String> parseParams(String params, long length, String separators, Set<UriParamsFlags> flags) throws GErrorException

      Many URI schemes include one or more attribute/value pairs as part of the URI value. This method can be used to parse them into a hash table. When an attribute has multiple occurrences, the last value is the final returned value. If you need to handle repeated attributes differently, use GUriParamsIter.

      The params string is assumed to still be %-encoded, but the returned values will be fully decoded. (Thus it is possible that the returned values may contain = or separators, if the value was encoded in the input.) Invalid %-encoding is treated as with the UriFlags.PARSE_RELAXED rules for g_uri_parse(). (However, if params is the path or query string from a GUri that was parsed without UriFlags.PARSE_RELAXED and UriFlags.ENCODED, then you already know that it does not contain any invalid encoding.)

      UriParamsFlags.WWW_FORM is handled as documented for g_uri_params_iter_init().

      If UriParamsFlags.CASE_INSENSITIVE is passed to flags, attributes will be compared case-insensitively, so a params string attr=123&Attr=456 will only return a single attribute–value pair, Attr=456. Case will be preserved in the returned attributes.

      If params cannot be parsed (for example, it contains two separators characters in a row), then error is set and null is returned.

      Parameters:
      params - a %-encoded string containing attribute=value parameters
      length - the length of params, or -1 if it is nul-terminated
      separators - the separator byte character set between parameters. (usually &, but sometimes ; or both &;). Note that this function works on bytes not characters, so it can't be used to delimit UTF-8 strings for anything but ASCII characters. You may pass an empty set, in which case no splitting will occur.
      flags - flags to modify the way the parameters are handled.
      Returns:
      A hash table of attribute/value pairs, with both names and values fully-decoded; or null on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • parseParams

      public static HashTable<String,String> parseParams(String params, long length, String separators, UriParamsFlags... flags) throws GErrorException

      Many URI schemes include one or more attribute/value pairs as part of the URI value. This method can be used to parse them into a hash table. When an attribute has multiple occurrences, the last value is the final returned value. If you need to handle repeated attributes differently, use GUriParamsIter.

      The params string is assumed to still be %-encoded, but the returned values will be fully decoded. (Thus it is possible that the returned values may contain = or separators, if the value was encoded in the input.) Invalid %-encoding is treated as with the UriFlags.PARSE_RELAXED rules for g_uri_parse(). (However, if params is the path or query string from a GUri that was parsed without UriFlags.PARSE_RELAXED and UriFlags.ENCODED, then you already know that it does not contain any invalid encoding.)

      UriParamsFlags.WWW_FORM is handled as documented for g_uri_params_iter_init().

      If UriParamsFlags.CASE_INSENSITIVE is passed to flags, attributes will be compared case-insensitively, so a params string attr=123&Attr=456 will only return a single attribute–value pair, Attr=456. Case will be preserved in the returned attributes.

      If params cannot be parsed (for example, it contains two separators characters in a row), then error is set and null is returned.

      Parameters:
      params - a %-encoded string containing attribute=value parameters
      length - the length of params, or -1 if it is nul-terminated
      separators - the separator byte character set between parameters. (usually &, but sometimes ; or both &;). Note that this function works on bytes not characters, so it can't be used to delimit UTF-8 strings for anything but ASCII characters. You may pass an empty set, in which case no splitting will occur.
      flags - flags to modify the way the parameters are handled.
      Returns:
      A hash table of attribute/value pairs, with both names and values fully-decoded; or null on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • parseScheme

      public static @Nullable String parseScheme(String uri)

      Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as:

      URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

      Common schemes include file, https, svn+ssh, etc.

      Parameters:
      uri - a valid URI.
      Returns:
      The ‘scheme’ component of the URI, or null on error. The returned string should be freed when no longer needed.
      Since:
      2.16

    • peekScheme

      public static @Nullable String peekScheme(String uri)

      Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as:

      URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

      Common schemes include file, https, svn+ssh, etc.

      Unlike g_uri_parse_scheme(), the returned scheme is normalized to all-lowercase and does not need to be freed.

      Parameters:
      uri - a valid URI.
      Returns:
      The ‘scheme’ component of the URI, or null on error. The returned string is normalized to all-lowercase, and interned via g_intern_string(), so it does not need to be freed.
      Since:
      2.66

    • resolveRelative

      public static String resolveRelative(@Nullable String baseUriString, String uriRef, Set<UriFlags> flags) throws GErrorException

      Parses uriRef according to flags and, if it is a relative URI, resolves it relative to baseUriString. If the result is not a valid absolute URI, it will be discarded, and an error returned.

      (If baseUriString is null, this just returns uriRef, or null if uriRef is invalid or not absolute.)

      Parameters:
      baseUriString - a string representing a base URI
      uriRef - a string representing a relative or absolute URI
      flags - flags describing how to parse uriRef
      Returns:
      the resolved URI string, or NULL on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • resolveRelative

      public static String resolveRelative(@Nullable String baseUriString, String uriRef, UriFlags... flags) throws GErrorException

      Parses uriRef according to flags and, if it is a relative URI, resolves it relative to baseUriString. If the result is not a valid absolute URI, it will be discarded, and an error returned.

      (If baseUriString is null, this just returns uriRef, or null if uriRef is invalid or not absolute.)

      Parameters:
      baseUriString - a string representing a base URI
      uriRef - a string representing a relative or absolute URI
      flags - flags describing how to parse uriRef
      Returns:
      the resolved URI string, or NULL on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • split

      public static boolean split(String uriRef, Set<UriFlags> flags, @Nullable Out<String> scheme, @Nullable Out<String> userinfo, @Nullable Out<String> host, @Nullable Out<Integer> port, @Nullable Out<String> path, @Nullable Out<String> query, @Nullable Out<String> fragment) throws GErrorException

      Parses uriRef (which can be an absolute or relative URI) according to flags, and returns the pieces. Any component that doesn't appear in uriRef will be returned as null (but note that all URIs always have a path component, though it may be the empty string).

      If flags contains UriFlags.ENCODED, then %-encoded characters in uriRef will remain encoded in the output strings. (If not, then all such characters will be decoded.) Note that decoding will only work if the URI components are ASCII or UTF-8, so you will need to use UriFlags.ENCODED if they are not.

      Note that the UriFlags.HAS_PASSWORD and UriFlags.HAS_AUTH_PARAMS flags are ignored by g_uri_split(), since it always returns only the full userinfo; use g_uri_split_with_user() if you want it split up.

      Parameters:
      uriRef - a string containing a relative or absolute URI
      flags - flags for parsing uriRef
      scheme - on return, contains the scheme (converted to lowercase), or null
      userinfo - on return, contains the userinfo, or null
      host - on return, contains the host, or null
      port - on return, contains the port, or -1
      path - on return, contains the path
      query - on return, contains the query, or null
      fragment - on return, contains the fragment, or null
      Returns:
      true if uriRef parsed successfully, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • split

      public static boolean split(String uriRef, UriFlags flags, @Nullable Out<String> scheme, @Nullable Out<String> userinfo, @Nullable Out<String> host, @Nullable Out<Integer> port, @Nullable Out<String> path, @Nullable Out<String> query, @Nullable Out<String> fragment) throws GErrorException

      Parses uriRef (which can be an absolute or relative URI) according to flags, and returns the pieces. Any component that doesn't appear in uriRef will be returned as null (but note that all URIs always have a path component, though it may be the empty string).

      If flags contains UriFlags.ENCODED, then %-encoded characters in uriRef will remain encoded in the output strings. (If not, then all such characters will be decoded.) Note that decoding will only work if the URI components are ASCII or UTF-8, so you will need to use UriFlags.ENCODED if they are not.

      Note that the UriFlags.HAS_PASSWORD and UriFlags.HAS_AUTH_PARAMS flags are ignored by g_uri_split(), since it always returns only the full userinfo; use g_uri_split_with_user() if you want it split up.

      Parameters:
      uriRef - a string containing a relative or absolute URI
      flags - flags for parsing uriRef
      scheme - on return, contains the scheme (converted to lowercase), or null
      userinfo - on return, contains the userinfo, or null
      host - on return, contains the host, or null
      port - on return, contains the port, or -1
      path - on return, contains the path
      query - on return, contains the query, or null
      fragment - on return, contains the fragment, or null
      Returns:
      true if uriRef parsed successfully, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • splitNetwork

      public static boolean splitNetwork(String uriString, Set<UriFlags> flags, @Nullable Out<String> scheme, @Nullable Out<String> host, @Nullable Out<Integer> port) throws GErrorException
      Parses uriString (which must be an absolute URI) according to flags, and returns the pieces relevant to connecting to a host. See the documentation for g_uri_split() for more details; this is mostly a wrapper around that function with simpler arguments. However, it will return an error if uriString is a relative URI, or does not contain a hostname component.
      Parameters:
      uriString - a string containing an absolute URI
      flags - flags for parsing uriString
      scheme - on return, contains the scheme (converted to lowercase), or null
      host - on return, contains the host, or null
      port - on return, contains the port, or -1
      Returns:
      true if uriString parsed successfully, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • splitNetwork

      public static boolean splitNetwork(String uriString, UriFlags flags, @Nullable Out<String> scheme, @Nullable Out<String> host, @Nullable Out<Integer> port) throws GErrorException
      Parses uriString (which must be an absolute URI) according to flags, and returns the pieces relevant to connecting to a host. See the documentation for g_uri_split() for more details; this is mostly a wrapper around that function with simpler arguments. However, it will return an error if uriString is a relative URI, or does not contain a hostname component.
      Parameters:
      uriString - a string containing an absolute URI
      flags - flags for parsing uriString
      scheme - on return, contains the scheme (converted to lowercase), or null
      host - on return, contains the host, or null
      port - on return, contains the port, or -1
      Returns:
      true if uriString parsed successfully, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • splitWithUser

      public static boolean splitWithUser(String uriRef, Set<UriFlags> flags, @Nullable Out<String> scheme, @Nullable Out<String> user, @Nullable Out<String> password, @Nullable Out<String> authParams, @Nullable Out<String> host, @Nullable Out<Integer> port, @Nullable Out<String> path, @Nullable Out<String> query, @Nullable Out<String> fragment) throws GErrorException

      Parses uriRef (which can be an absolute or relative URI) according to flags, and returns the pieces. Any component that doesn't appear in uriRef will be returned as null (but note that all URIs always have a path component, though it may be the empty string).

      See g_uri_split(), and the definition of GUriFlags, for more information on the effect of flags. Note that password will only be parsed out if flags contains UriFlags.HAS_PASSWORD, and authParams will only be parsed out if flags contains UriFlags.HAS_AUTH_PARAMS.

      Parameters:
      uriRef - a string containing a relative or absolute URI
      flags - flags for parsing uriRef
      scheme - on return, contains the scheme (converted to lowercase), or null
      user - on return, contains the user, or null
      password - on return, contains the password, or null
      authParams - on return, contains the auth_params, or null
      host - on return, contains the host, or null
      port - on return, contains the port, or -1
      path - on return, contains the path
      query - on return, contains the query, or null
      fragment - on return, contains the fragment, or null
      Returns:
      true if uriRef parsed successfully, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • splitWithUser

      public static boolean splitWithUser(String uriRef, UriFlags flags, @Nullable Out<String> scheme, @Nullable Out<String> user, @Nullable Out<String> password, @Nullable Out<String> authParams, @Nullable Out<String> host, @Nullable Out<Integer> port, @Nullable Out<String> path, @Nullable Out<String> query, @Nullable Out<String> fragment) throws GErrorException

      Parses uriRef (which can be an absolute or relative URI) according to flags, and returns the pieces. Any component that doesn't appear in uriRef will be returned as null (but note that all URIs always have a path component, though it may be the empty string).

      See g_uri_split(), and the definition of GUriFlags, for more information on the effect of flags. Note that password will only be parsed out if flags contains UriFlags.HAS_PASSWORD, and authParams will only be parsed out if flags contains UriFlags.HAS_AUTH_PARAMS.

      Parameters:
      uriRef - a string containing a relative or absolute URI
      flags - flags for parsing uriRef
      scheme - on return, contains the scheme (converted to lowercase), or null
      user - on return, contains the user, or null
      password - on return, contains the password, or null
      authParams - on return, contains the auth_params, or null
      host - on return, contains the host, or null
      port - on return, contains the port, or -1
      path - on return, contains the path
      query - on return, contains the query, or null
      fragment - on return, contains the fragment, or null
      Returns:
      true if uriRef parsed successfully, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • unescapeBytes

      public static byte[] unescapeBytes(String escapedString, long length, @Nullable String illegalCharacters) throws GErrorException

      Unescapes a segment of an escaped string as binary data.

      Note that in contrast to g_uri_unescape_string(), this does allow nul bytes to appear in the output.

      If any of the characters in illegalCharacters appears as an escaped character in escapedString, then that is an error and null will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling.

      Parameters:
      escapedString - A URI-escaped string
      length - the length (in bytes) of escapedString to escape, or -1 if it is nul-terminated.
      illegalCharacters - a string of illegal characters not to be allowed, or null.
      Returns:
      an unescaped version of escapedString or null on error (if decoding failed, using UriError.FAILED error code). The returned GBytes should be unreffed when no longer needed.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • unescapeSegment

      public static @Nullable String unescapeSegment(@Nullable String escapedString, @Nullable String escapedStringEnd, @Nullable String illegalCharacters)

      Unescapes a segment of an escaped string.

      If any of the characters in illegalCharacters or the NUL character appears as an escaped character in escapedString, then that is an error and null will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling.

      Note: NUL byte is not accepted in the output, in contrast to g_uri_unescape_bytes().

      Parameters:
      escapedString - A string, may be null
      escapedStringEnd - Pointer to end of escapedString, may be null
      illegalCharacters - An optional string of illegal characters not to be allowed, may be null
      Returns:
      an unescaped version of escapedString, or null on error. The returned string should be freed when no longer needed. As a special case if null is given for escapedString, this function will return null.
      Since:
      2.16

    • unescapeString

      public static @Nullable String unescapeString(String escapedString, @Nullable String illegalCharacters)

      Unescapes a whole escaped string.

      If any of the characters in illegalCharacters or the NUL character appears as an escaped character in escapedString, then that is an error and null will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling.

      Parameters:
      escapedString - an escaped string to be unescaped.
      illegalCharacters - a string of illegal characters not to be allowed, or null.
      Returns:
      an unescaped version of escapedString. The returned string should be freed when no longer needed.
      Since:
      2.16

    • getAuthParams

      public @Nullable String getAuthParams()

      Gets uri's authentication parameters, which may contain %-encoding, depending on the flags with which this Uri was created. (If this Uri was not created with UriFlags.HAS_AUTH_PARAMS then this will be null.)

      Depending on the URI scheme, g_uri_parse_params() may be useful for further parsing this information.

      Returns:
      uri's authentication parameters.
      Since:
      2.66

    • getFlags

      public Set<UriFlags> getFlags()
      Gets uri's flags set upon construction.
      Returns:
      uri's flags.
      Since:
      2.66

    • getFragment

      public @Nullable String getFragment()
      Gets uri's fragment, which may contain %-encoding, depending on the flags with which this Uri was created.
      Returns:
      uri's fragment.
      Since:
      2.66

    • getHost

      public @Nullable String getHost()

      Gets uri's host. This will never have %-encoded characters, unless it is non-UTF-8 (which can only be the case if this Uri was created with UriFlags.NON_DNS).

      If this Uri contained an IPv6 address literal, this value will be just that address, without the brackets around it that are necessary in the string form of the URI. Note that in this case there may also be a scope ID attached to the address. Eg, fe80::1234%``em1 (or fe80::1234%``25em1 if the string is still encoded).

      Returns:
      uri's host.
      Since:
      2.66

    • getPassword

      public @Nullable String getPassword()
      Gets uri's password, which may contain %-encoding, depending on the flags with which this Uri was created. (If this Uri was not created with UriFlags.HAS_PASSWORD then this will be null.)
      Returns:
      uri's password.
      Since:
      2.66

    • getPath

      public String getPath()
      Gets uri's path, which may contain %-encoding, depending on the flags with which this Uri was created.
      Returns:
      uri's path.
      Since:
      2.66

    • getPort

      public int getPort()
      Gets uri's port.
      Returns:
      uri's port, or -1 if no port was specified.
      Since:
      2.66

    • getQuery

      public @Nullable String getQuery()

      Gets uri's query, which may contain %-encoding, depending on the flags with which this Uri was created.

      For queries consisting of a series of name=value parameters, GUriParamsIter or g_uri_parse_params() may be useful.

      Returns:
      uri's query.
      Since:
      2.66

    • getScheme

      public String getScheme()
      Gets uri's scheme. Note that this will always be all-lowercase, regardless of the string or strings that this Uri was created from.
      Returns:
      uri's scheme.
      Since:
      2.66

    • getUser

      public @Nullable String getUser()
      Gets the ‘username’ component of uri's userinfo, which may contain %-encoding, depending on the flags with which this Uri was created. If this Uri was not created with UriFlags.HAS_PASSWORD or UriFlags.HAS_AUTH_PARAMS, this is the same as g_uri_get_userinfo().
      Returns:
      uri's user.
      Since:
      2.66

    • getUserinfo

      public @Nullable String getUserinfo()
      Gets uri's userinfo, which may contain %-encoding, depending on the flags with which this Uri was created.
      Returns:
      uri's userinfo.
      Since:
      2.66

    • parseRelative

      public Uri parseRelative(String uriRef, Set<UriFlags> flags) throws GErrorException
      Parses uriRef according to flags and, if it is a relative URI, resolves it relative to baseUri. If the result is not a valid absolute URI, it will be discarded, and an error returned.
      Parameters:
      uriRef - a string representing a relative or absolute URI
      flags - flags describing how to parse uriRef
      Returns:
      a new GUri, or NULL on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • parseRelative

      public Uri parseRelative(String uriRef, UriFlags... flags) throws GErrorException
      Parses uriRef according to flags and, if it is a relative URI, resolves it relative to baseUri. If the result is not a valid absolute URI, it will be discarded, and an error returned.
      Parameters:
      uriRef - a string representing a relative or absolute URI
      flags - flags describing how to parse uriRef
      Returns:
      a new GUri, or NULL on error.
      Throws:
      GErrorException - see GError
      Since:
      2.66

    • ref

      public Uri ref()
      Increments the reference count of this Uri by one.
      Returns:
      this Uri
      Since:
      2.66

    • toString

      public String toString()

      Returns a string representing uri.

      This is not guaranteed to return a string which is identical to the string that this Uri was parsed from. However, if the source URI was syntactically correct (according to RFC 3986), and it was parsed with UriFlags.ENCODED, then g_uri_to_string() is guaranteed to return a string which is at least semantically equivalent to the source URI (according to RFC 3986).

      If this Uri might contain sensitive details, such as authentication parameters, or private data in its query string, and the returned string is going to be logged, then consider using g_uri_to_string_partial() to redact parts.

      Overrides:
      toString in class Object
      Returns:
      a string representing uri, which the caller must free.
      Since:
      2.66

    • toStringPartial

      public String toStringPartial(Set<UriHideFlags> flags)
      Returns a string representing uri, subject to the options in flags. See g_uri_to_string() and GUriHideFlags for more details.
      Parameters:
      flags - flags describing what parts of this Uri to hide
      Returns:
      a string representing uri, which the caller must free.
      Since:
      2.66

    • toStringPartial

      public String toStringPartial(UriHideFlags... flags)
      Returns a string representing uri, subject to the options in flags. See g_uri_to_string() and GUriHideFlags for more details.
      Parameters:
      flags - flags describing what parts of this Uri to hide
      Returns:
      a string representing uri, which the caller must free.
      Since:
      2.66

    • unref

      public void unref()

      Atomically decrements the reference count of this Uri by one.

      When the reference count reaches zero, the resources allocated by this Uri are freed

      Since:
      2.66