org.jboss.resteasy.microprofile.client.impl

Class MpUriBuilder

java.lang.Object

javax.ws.rs.core.UriBuilder

org.jboss.resteasy.spi.ResteasyUriBuilder

org.jboss.resteasy.specimpl.ResteasyUriBuilderImpl

org.jboss.resteasy.microprofile.client.impl.MpUriBuilder

public class MpUriBuilder
extends ResteasyUriBuilderImpl

Field Summary

Fields inherited from class org.jboss.resteasy.spi.ResteasyUriBuilder

hierarchicalUri, opaqueUri

Constructor Summary

Constructors

Constructor and Description
MpUriBuilder()
MpUriBuilder(String host, String scheme, int port, String userInfo, String path, String query, String fragment, String ssp, String authority)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.UriBuilder	clientQueryParam(String name, Object... values) Called by ClientRequest.getUri() to add a query parameter for @QueryParam parameters.
javax.ws.rs.core.UriBuilder	clone()
void	setQueryParamStyle(org.eclipse.microprofile.rest.client.ext.QueryParamStyle queryParamStyle)
javax.ws.rs.core.UriBuilder	uri(String uriTemplate, org.eclipse.microprofile.rest.client.ext.QueryParamStyle queryParamStyle)
javax.ws.rs.core.UriBuilder	uri(URI uri, org.eclipse.microprofile.rest.client.ext.QueryParamStyle queryParamStyle)

Methods inherited from class org.jboss.resteasy.specimpl.ResteasyUriBuilderImpl

build, build, buildFromEncoded, buildFromEncodedMap, buildFromMap, buildFromMap, buildFromValues, buildUriFromMap, createUriParamMatcher, fragment, getAuthority, getFragment, getHost, getPath, getPathParamNamesInDeclarationOrder, getPort, getQuery, getScheme, getSsp, getUserInfo, host, matrixParam, parseHierarchicalUri, path, path, path, path, paths, port, queryParam, replaceMatrix, replaceMatrixParam, replaceParameter, replacePath, replacePathParameter, replaceQuery, replaceQueryNoEncoding, replaceQueryParam, replaceQueryStringParameter, resolveTemplate, resolveTemplate, resolveTemplateFromEncoded, resolveTemplates, resolveTemplates, resolveTemplatesFromEncoded, scheme, schemeSpecificPart, segment, substitutePathParam, toTemplate, uri, uri, uriFromCharSequence, uriTemplate, userInfo

Methods inherited from class org.jboss.resteasy.spi.ResteasyUriBuilder

compare, fromTemplate, relativize

Methods inherited from class javax.ws.rs.core.UriBuilder

fromLink, fromMethod, fromPath, fromResource, fromUri, fromUri, newInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

MpUriBuilder

public MpUriBuilder()

MpUriBuilder

public MpUriBuilder(String host,
                    String scheme,
                    int port,
                    String userInfo,
                    String path,
                    String query,
                    String fragment,
                    String ssp,
                    String authority)

Method Detail

setQueryParamStyle

public void setQueryParamStyle(org.eclipse.microprofile.rest.client.ext.QueryParamStyle queryParamStyle)

clone

public javax.ws.rs.core.UriBuilder clone()

Overrides:

clone in class ResteasyUriBuilderImpl

clientQueryParam

public javax.ws.rs.core.UriBuilder clientQueryParam(String name,
                                                    Object... values)
                                             throws IllegalArgumentException

Description copied from class: ResteasyUriBuilderImpl

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).

Overrides:

clientQueryParam in class ResteasyUriBuilderImpl

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

uri

public javax.ws.rs.core.UriBuilder uri(String uriTemplate,
                                       org.eclipse.microprofile.rest.client.ext.QueryParamStyle queryParamStyle)
                                throws IllegalArgumentException

Throws:

IllegalArgumentException

uri

public javax.ws.rs.core.UriBuilder uri(URI uri,
                                       org.eclipse.microprofile.rest.client.ext.QueryParamStyle queryParamStyle)
                                throws IllegalArgumentException

Throws:

IllegalArgumentException