Package org.jboss.resteasy.reactive.common.jaxrs

Class UriBuilderImpl

java.lang.Object
jakarta.ws.rs.core.UriBuilder
org.jboss.resteasy.reactive.common.jaxrs.UriBuilderImpl
public class UriBuilderImpl extends jakarta.ws.rs.core.UriBuilder
Author:
Bill Burke

  • Field Details

    • opaqueUri

      public static final Pattern opaqueUri

    • hierarchicalUri

      public static final Pattern hierarchicalUri

  • Constructor Details

    • UriBuilderImpl

      public UriBuilderImpl()

  • Method Details

    • clone

      public jakarta.ws.rs.core.UriBuilder clone()
      Specified by:
      clone in class jakarta.ws.rs.core.UriBuilder

    • compare

      public static boolean compare(String s1, String s2)

    • relativize

      public static URI relativize(URI from, URI to)

    • fromTemplate

      public static UriBuilderImpl fromTemplate(String uriTemplate)
      You may put path parameters anywhere within the uriTemplate except port.
      Parameters:
      uriTemplate - uri template
      Returns:
      uri builder

    • uriTemplate

      public jakarta.ws.rs.core.UriBuilder uriTemplate(CharSequence uriTemplate)
      You may put path parameters anywhere within the uriTemplate except port.
      Parameters:
      uriTemplate - uri template
      Returns:
      uri builder

    • parseHierarchicalUri

      protected jakarta.ws.rs.core.UriBuilder parseHierarchicalUri(CharSequence uriTemplate, Matcher match)

    • uri

      public jakarta.ws.rs.core.UriBuilder uri(String uriTemplate) throws IllegalArgumentException
      Specified by:
      uri in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • uriFromCharSequence

      public jakarta.ws.rs.core.UriBuilder uriFromCharSequence(CharSequence uriTemplate) throws IllegalArgumentException
      Throws:
      IllegalArgumentException

    • uri

      public jakarta.ws.rs.core.UriBuilder uri(URI uri) throws IllegalArgumentException
      Specified by:
      uri in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • scheme

      public jakarta.ws.rs.core.UriBuilder scheme(String scheme) throws IllegalArgumentException
      Specified by:
      scheme in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • schemeSpecificPart

      public jakarta.ws.rs.core.UriBuilder schemeSpecificPart(String ssp) throws IllegalArgumentException
      Specified by:
      schemeSpecificPart in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • userInfo

      public jakarta.ws.rs.core.UriBuilder userInfo(String ui)
      Specified by:
      userInfo in class jakarta.ws.rs.core.UriBuilder

    • host

      public jakarta.ws.rs.core.UriBuilder host(String host) throws IllegalArgumentException
      Specified by:
      host in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • port

      public jakarta.ws.rs.core.UriBuilder port(int port) throws IllegalArgumentException
      Specified by:
      port in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • encode

      public jakarta.ws.rs.core.UriBuilder encode(boolean encode)

    • paths

      protected static String paths(boolean encode, String basePath, String... segments)

    • path

      public jakarta.ws.rs.core.UriBuilder path(String segment) throws IllegalArgumentException
      Specified by:
      path in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • path

      public jakarta.ws.rs.core.UriBuilder path(Class resource) throws IllegalArgumentException
      Specified by:
      path in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • path

      public jakarta.ws.rs.core.UriBuilder path(Class resource, String method) throws IllegalArgumentException
      Specified by:
      path in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • path

      public jakarta.ws.rs.core.UriBuilder path(Method method) throws IllegalArgumentException
      Specified by:
      path in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • replaceMatrix

      public jakarta.ws.rs.core.UriBuilder replaceMatrix(String matrix) throws IllegalArgumentException
      Specified by:
      replaceMatrix in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • replaceQuery

      public jakarta.ws.rs.core.UriBuilder replaceQuery(String query) throws IllegalArgumentException
      Specified by:
      replaceQuery in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • fragment

      public jakarta.ws.rs.core.UriBuilder fragment(String fragment) throws IllegalArgumentException
      Specified by:
      fragment in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • substitutePathParam

      public jakarta.ws.rs.core.UriBuilder substitutePathParam(String name, Object value, boolean isEncoded)
      Only replace path params in path of URI. This changes state of URIBuilder.
      Parameters:
      name - parameter name
      value - parameter value
      isEncoded - encoded flag
      Returns:
      uri builder

    • buildFromMap

      public URI buildFromMap(Map<String,? extends Object> values) throws IllegalArgumentException, jakarta.ws.rs.core.UriBuilderException
      Specified by:
      buildFromMap in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException
      jakarta.ws.rs.core.UriBuilderException

    • buildFromEncodedMap

      public URI buildFromEncodedMap(Map<String,? extends Object> values) throws IllegalArgumentException, jakarta.ws.rs.core.UriBuilderException
      Specified by:
      buildFromEncodedMap in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException
      jakarta.ws.rs.core.UriBuilderException

    • buildFromMap

      public URI buildFromMap(Map<String,?> values, boolean encodeSlashInPath) throws IllegalArgumentException, jakarta.ws.rs.core.UriBuilderException
      Specified by:
      buildFromMap in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException
      jakarta.ws.rs.core.UriBuilderException

    • buildUriFromMap

      protected URI buildUriFromMap(Map<String,? extends Object> paramMap, boolean fromEncodedMap, boolean encodeSlash) throws IllegalArgumentException, jakarta.ws.rs.core.UriBuilderException
      Throws:
      IllegalArgumentException
      jakarta.ws.rs.core.UriBuilderException

    • replacePathParameter

      protected StringBuilder replacePathParameter(String name, String value, boolean isEncoded, String string, StringBuilder builder, boolean encodeSlash)

    • createUriParamMatcher

      public static Matcher createUriParamMatcher(String string)

    • replaceParameter

      protected StringBuilder replaceParameter(Map<String,? extends Object> paramMap, boolean fromEncodedMap, boolean isTemplate, String string, StringBuilder builder, boolean encodeSlash)

    • replaceParameter

      protected StringBuilder replaceParameter(Map<String,? extends Object> paramMap, boolean fromEncodedMap, boolean isTemplate, String string, StringBuilder builder, boolean encode, boolean encodeSlash)

    • replaceQueryStringParameter

      protected StringBuilder replaceQueryStringParameter(Map<String,? extends Object> paramMap, boolean fromEncodedMap, boolean isTemplate, String string, StringBuilder builder)

    • getPathParamNamesInDeclarationOrder

      public List<String> getPathParamNamesInDeclarationOrder()
      Return a unique order list of path params.
      Returns:
      list of path parameters

    • build

      public URI build(Object... values) throws IllegalArgumentException, jakarta.ws.rs.core.UriBuilderException
      Specified by:
      build in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException
      jakarta.ws.rs.core.UriBuilderException

    • buildFromValues

      protected URI buildFromValues(boolean encodeSlash, boolean encoded, Object... values)

    • matrixParam

      public jakarta.ws.rs.core.UriBuilder matrixParam(String name, Object... values) throws IllegalArgumentException
      Specified by:
      matrixParam in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • replaceMatrixParam

      public jakarta.ws.rs.core.UriBuilder replaceMatrixParam(String name, Object... values) throws IllegalArgumentException
      Specified by:
      replaceMatrixParam in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • clientQueryParam

      public jakarta.ws.rs.core.UriBuilder clientQueryParam(String name, Object... values) throws IllegalArgumentException
      Called by ClientRequest.getUri() to add a query parameter for @QueryParam parameters. We do not use UriBuilder.queryParam() because
      • queryParam() supports URI template processing and this method must always encode braces (for parameter substitution is not possible for @QueryParam parameters).
      • queryParam() supports "contextual URI encoding" (i.e., it does not encode % characters that are followed by two hex characters). The JavaDoc for @QueryParam.value() explicitly states that the value is specified in decoded format and that "any percent encoded literals within the value will not be decoded and will instead be treated as literal text". This means that it is an explicit bug to perform contextual URI encoding of this method's name parameter; hence, we must always encode said parameter. This method also foregoes contextual URI encoding on this method's values parameter because it represents arbitrary data passed to a QueryParam parameter of a client proxy (since the client proxy is nothing more than a transport layer, it should not be "interpreting" such data; instead, it should faithfully transmit this data over the wire).
      Parameters:
      name - the name of the query parameter.
      values - the value(s) of the query parameter.
      Returns:
      Returns this instance to allow call chaining.
      Throws:
      IllegalArgumentException

    • queryParam

      public jakarta.ws.rs.core.UriBuilder queryParam(String name, Object... values) throws IllegalArgumentException
      Specified by:
      queryParam in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • replaceQueryParam

      public jakarta.ws.rs.core.UriBuilder replaceQueryParam(String name, Object... values) throws IllegalArgumentException
      Specified by:
      replaceQueryParam in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • getHost

      public String getHost()

    • getScheme

      public String getScheme()

    • getPort

      public int getPort()

    • getUserInfo

      public String getUserInfo()

    • getPath

      public String getPath()

    • getQuery

      public String getQuery()

    • getFragment

      public String getFragment()

    • segment

      public jakarta.ws.rs.core.UriBuilder segment(String... segments) throws IllegalArgumentException
      Specified by:
      segment in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • buildFromEncoded

      public URI buildFromEncoded(Object... values) throws IllegalArgumentException, jakarta.ws.rs.core.UriBuilderException
      Specified by:
      buildFromEncoded in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException
      jakarta.ws.rs.core.UriBuilderException

    • replacePath

      public jakarta.ws.rs.core.UriBuilder replacePath(String path)
      Specified by:
      replacePath in class jakarta.ws.rs.core.UriBuilder

    • build

      public URI build(Object[] values, boolean encodeSlashInPath) throws IllegalArgumentException, jakarta.ws.rs.core.UriBuilderException
      Specified by:
      build in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException
      jakarta.ws.rs.core.UriBuilderException

    • toTemplate

      public String toTemplate()
      Specified by:
      toTemplate in class jakarta.ws.rs.core.UriBuilder

    • resolveTemplate

      public jakarta.ws.rs.core.UriBuilder resolveTemplate(String name, Object value) throws IllegalArgumentException
      Specified by:
      resolveTemplate in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • resolveTemplates

      public jakarta.ws.rs.core.UriBuilder resolveTemplates(Map<String,Object> templateValues) throws IllegalArgumentException
      Specified by:
      resolveTemplates in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • resolveTemplate

      public jakarta.ws.rs.core.UriBuilder resolveTemplate(String name, Object value, boolean encodeSlashInPath) throws IllegalArgumentException
      Specified by:
      resolveTemplate in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • resolveTemplateFromEncoded

      public jakarta.ws.rs.core.UriBuilder resolveTemplateFromEncoded(String name, Object value) throws IllegalArgumentException
      Specified by:
      resolveTemplateFromEncoded in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • resolveTemplates

      public jakarta.ws.rs.core.UriBuilder resolveTemplates(Map<String,Object> templateValues, boolean encodeSlashInPath) throws IllegalArgumentException
      Specified by:
      resolveTemplates in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • resolveTemplatesFromEncoded

      public jakarta.ws.rs.core.UriBuilder resolveTemplatesFromEncoded(Map<String,Object> templateValues) throws IllegalArgumentException
      Specified by:
      resolveTemplatesFromEncoded in class jakarta.ws.rs.core.UriBuilder
      Throws:
      IllegalArgumentException

    • multiQueryParamMode

      public jakarta.ws.rs.core.UriBuilder multiQueryParamMode(MultiQueryParamMode mode)