org.jboss.resteasy.specimpl

Class ResteasyUriBuilder

java.lang.Object

javax.ws.rs.core.UriBuilder

org.jboss.resteasy.specimpl.ResteasyUriBuilder

public class ResteasyUriBuilder
extends javax.ws.rs.core.UriBuilder

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	hierarchicalUri
static Pattern	opaqueUri

Constructor Summary

Constructors

Constructor and Description
ResteasyUriBuilder()

Method Summary

Modifier and Type	Method and Description
URI	build(Object... values)
URI	build(Object[] values, boolean encodeSlashInPath)
URI	buildFromEncoded(Object... values)
URI	buildFromEncodedMap(Map<String,? extends Object> values)
URI	buildFromMap(Map<String,?> values, boolean encodeSlashInPath)
URI	buildFromMap(Map<String,? extends Object> values)
protected URI	buildFromValues(boolean encodeSlash, boolean encoded, Object... values)
protected URI	buildUriFromMap(Map<String,? extends Object> paramMap, boolean fromEncodedMap, boolean encodeSlash)
javax.ws.rs.core.UriBuilder	clientQueryParam(String name, Object value) Called by ClientRequest.getUri() to add a query parameter for @QueryParam parameters.
javax.ws.rs.core.UriBuilder	clone()
static boolean	compare(String s1, String s2)
static Matcher	createUriParamMatcher(String string)
javax.ws.rs.core.UriBuilder	fragment(String fragment)
static javax.ws.rs.core.UriBuilder	fromTemplate(String uriTemplate) You may put path parameters anywhere within the uriTemplate except port.
String	getFragment()
String	getHost()
String	getPath()
List<String>	getPathParamNamesInDeclarationOrder() Return a unique order list of path params.
int	getPort()
String	getQuery()
String	getScheme()
String	getUserInfo()
javax.ws.rs.core.UriBuilder	host(String host)
javax.ws.rs.core.UriBuilder	matrixParam(String name, Object... values)
protected javax.ws.rs.core.UriBuilder	parseHierarchicalUri(String uriTemplate, Matcher match)
javax.ws.rs.core.UriBuilder	path(Class resource)
javax.ws.rs.core.UriBuilder	path(Class resource, String method)
javax.ws.rs.core.UriBuilder	path(Method method)
javax.ws.rs.core.UriBuilder	path(String segment)
protected static String	paths(boolean encode, String basePath, String... segments)
javax.ws.rs.core.UriBuilder	port(int port)
javax.ws.rs.core.UriBuilder	queryParam(String name, Object... values)
static URI	relativize(URI from, URI to)
javax.ws.rs.core.UriBuilder	replaceMatrix(String matrix)
javax.ws.rs.core.UriBuilder	replaceMatrixParam(String name, Object... values)
protected StringBuilder	replaceParameter(Map<String,? extends Object> paramMap, boolean fromEncodedMap, boolean isTemplate, String string, StringBuilder builder, boolean encodeSlash)
javax.ws.rs.core.UriBuilder	replacePath(String path)
protected StringBuilder	replacePathParameter(String name, String value, boolean isEncoded, String string, StringBuilder builder, boolean encodeSlash)
javax.ws.rs.core.UriBuilder	replaceQuery(String query)
javax.ws.rs.core.UriBuilder	replaceQueryParam(String name, Object... values)
protected StringBuilder	replaceQueryStringParameter(Map<String,? extends Object> paramMap, boolean fromEncodedMap, boolean isTemplate, String string, StringBuilder builder)
javax.ws.rs.core.UriBuilder	resolveTemplate(String name, Object value)
javax.ws.rs.core.UriBuilder	resolveTemplate(String name, Object value, boolean encodeSlashInPath)
javax.ws.rs.core.UriBuilder	resolveTemplateFromEncoded(String name, Object value)
javax.ws.rs.core.UriBuilder	resolveTemplates(Map<String,Object> templateValues)
javax.ws.rs.core.UriBuilder	resolveTemplates(Map<String,Object> templateValues, boolean encodeSlashInPath)
javax.ws.rs.core.UriBuilder	resolveTemplatesFromEncoded(Map<String,Object> templateValues)
javax.ws.rs.core.UriBuilder	scheme(String scheme)
javax.ws.rs.core.UriBuilder	schemeSpecificPart(String ssp)
javax.ws.rs.core.UriBuilder	segment(String... segments)
javax.ws.rs.core.UriBuilder	substitutePathParam(String name, Object value, boolean isEncoded) Only replace path params in path of URI.
String	toTemplate()
javax.ws.rs.core.UriBuilder	uri(String uriTemplate)
javax.ws.rs.core.UriBuilder	uri(URI uri)
javax.ws.rs.core.UriBuilder	uriTemplate(String uriTemplate) You may put path parameters anywhere within the uriTemplate except port.
javax.ws.rs.core.UriBuilder	userInfo(String ui)

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

Field Detail

opaqueUri

public static final Pattern opaqueUri

hierarchicalUri

public static final Pattern hierarchicalUri

Constructor Detail

ResteasyUriBuilder

public ResteasyUriBuilder()

Method Detail

clone

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

Overrides:

clone in class javax.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 javax.ws.rs.core.UriBuilder fromTemplate(String uriTemplate)

You may put path parameters anywhere within the uriTemplate except port.

Parameters:

uriTemplate - uri template

Returns:

uri builder

uriTemplate

public javax.ws.rs.core.UriBuilder uriTemplate(String uriTemplate)

You may put path parameters anywhere within the uriTemplate except port.

Parameters:

uriTemplate - uri template

Returns:

uri builder

parseHierarchicalUri

protected javax.ws.rs.core.UriBuilder parseHierarchicalUri(String uriTemplate,
                                                           Matcher match)

uri

public javax.ws.rs.core.UriBuilder uri(String uriTemplate)
                                throws IllegalArgumentException

Specified by:

uri in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

uri

public javax.ws.rs.core.UriBuilder uri(URI uri)
                                throws IllegalArgumentException

Specified by:

uri in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

scheme

public javax.ws.rs.core.UriBuilder scheme(String scheme)
                                   throws IllegalArgumentException

Specified by:

scheme in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

schemeSpecificPart

public javax.ws.rs.core.UriBuilder schemeSpecificPart(String ssp)
                                               throws IllegalArgumentException

Specified by:

schemeSpecificPart in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

userInfo

public javax.ws.rs.core.UriBuilder userInfo(String ui)

Specified by:

userInfo in class javax.ws.rs.core.UriBuilder

host

public javax.ws.rs.core.UriBuilder host(String host)
                                 throws IllegalArgumentException

Specified by:

host in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

port

public javax.ws.rs.core.UriBuilder port(int port)
                                 throws IllegalArgumentException

Specified by:

port in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

paths

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

path

public javax.ws.rs.core.UriBuilder path(String segment)
                                 throws IllegalArgumentException

Specified by:

path in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

path

public javax.ws.rs.core.UriBuilder path(Class resource)
                                 throws IllegalArgumentException

Specified by:

path in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

path

public javax.ws.rs.core.UriBuilder path(Class resource,
                                        String method)
                                 throws IllegalArgumentException

Specified by:

path in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

path

public javax.ws.rs.core.UriBuilder path(Method method)
                                 throws IllegalArgumentException

Specified by:

path in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

replaceMatrix

public javax.ws.rs.core.UriBuilder replaceMatrix(String matrix)
                                          throws IllegalArgumentException

Specified by:

replaceMatrix in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

replaceQuery

public javax.ws.rs.core.UriBuilder replaceQuery(String query)
                                         throws IllegalArgumentException

Specified by:

replaceQuery in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

fragment

public javax.ws.rs.core.UriBuilder fragment(String fragment)
                                     throws IllegalArgumentException

Specified by:

fragment in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

substitutePathParam

public javax.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,
                        javax.ws.rs.core.UriBuilderException

Specified by:

buildFromMap in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

javax.ws.rs.core.UriBuilderException

buildFromEncodedMap

public URI buildFromEncodedMap(Map<String,? extends Object> values)
                        throws IllegalArgumentException,
                               javax.ws.rs.core.UriBuilderException

Specified by:

buildFromEncodedMap in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

javax.ws.rs.core.UriBuilderException

buildFromMap

public URI buildFromMap(Map<String,?> values,
                        boolean encodeSlashInPath)
                 throws IllegalArgumentException,
                        javax.ws.rs.core.UriBuilderException

Specified by:

buildFromMap in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

javax.ws.rs.core.UriBuilderException

buildUriFromMap

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

Throws:

IllegalArgumentException

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

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,
                 javax.ws.rs.core.UriBuilderException

Specified by:

build in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

javax.ws.rs.core.UriBuilderException

buildFromValues

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

matrixParam

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

Specified by:

matrixParam in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

replaceMatrixParam

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

Specified by:

replaceMatrixParam in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

clientQueryParam

public javax.ws.rs.core.UriBuilder clientQueryParam(String name,
                                                    Object value)
                                             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 value 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.

value - the value of the query parameter.

Returns:

Returns this instance to allow call chaining.

Throws:

IllegalArgumentException

queryParam

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

Specified by:

queryParam in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

replaceQueryParam

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

Specified by:

replaceQueryParam in class javax.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 javax.ws.rs.core.UriBuilder segment(String... segments)
                                    throws IllegalArgumentException

Specified by:

segment in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

buildFromEncoded

public URI buildFromEncoded(Object... values)
                     throws IllegalArgumentException,
                            javax.ws.rs.core.UriBuilderException

Specified by:

buildFromEncoded in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

javax.ws.rs.core.UriBuilderException

replacePath

public javax.ws.rs.core.UriBuilder replacePath(String path)

Specified by:

replacePath in class javax.ws.rs.core.UriBuilder

build

public URI build(Object[] values,
                 boolean encodeSlashInPath)
          throws IllegalArgumentException,
                 javax.ws.rs.core.UriBuilderException

Specified by:

build in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

javax.ws.rs.core.UriBuilderException

toTemplate

public String toTemplate()

Specified by:

toTemplate in class javax.ws.rs.core.UriBuilder

resolveTemplate

public javax.ws.rs.core.UriBuilder resolveTemplate(String name,
                                                   Object value)
                                            throws IllegalArgumentException

Specified by:

resolveTemplate in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

resolveTemplates

public javax.ws.rs.core.UriBuilder resolveTemplates(Map<String,Object> templateValues)
                                             throws IllegalArgumentException

Specified by:

resolveTemplates in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

resolveTemplate

public javax.ws.rs.core.UriBuilder resolveTemplate(String name,
                                                   Object value,
                                                   boolean encodeSlashInPath)
                                            throws IllegalArgumentException

Specified by:

resolveTemplate in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

resolveTemplateFromEncoded

public javax.ws.rs.core.UriBuilder resolveTemplateFromEncoded(String name,
                                                              Object value)
                                                       throws IllegalArgumentException

Specified by:

resolveTemplateFromEncoded in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

resolveTemplates

public javax.ws.rs.core.UriBuilder resolveTemplates(Map<String,Object> templateValues,
                                                    boolean encodeSlashInPath)
                                             throws IllegalArgumentException

Specified by:

resolveTemplates in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException

resolveTemplatesFromEncoded

public javax.ws.rs.core.UriBuilder resolveTemplatesFromEncoded(Map<String,Object> templateValues)
                                                        throws IllegalArgumentException

Specified by:

resolveTemplatesFromEncoded in class javax.ws.rs.core.UriBuilder

Throws:

IllegalArgumentException