Package org.apache.cxf.jaxrs.impl

Class UriBuilderImpl

java.lang.Object

jakarta.ws.rs.core.UriBuilder

org.apache.cxf.jaxrs.impl.UriBuilderImpl

All Implemented Interfaces:

Cloneable

public class UriBuilderImpl
extends jakarta.ws.rs.core.UriBuilder
implements Cloneable

Implements the UriBuilder abstract class. A few notes with respect to CXF specifics:

• it uses standard URI internally, so it does not conform to RFC-3986 which UriBuilder mandates
• it encodes URI components if it encounters '%XX' pattern within name (if applicable) or value (those are treated as partially encoded)
</ul

Constructor Summary

Constructors

Constructor	Description
UriBuilderImpl()	Creates builder with empty URI.
UriBuilderImpl(URI uri)	Creates builder initialized with given URI.
UriBuilderImpl(Map<String,Object> properties)	Creates builder with empty URI and properties

Method Summary

Modifier and Type	Method	Description
URI	build(Object... values)
URI	build(Object[] vars, boolean encodePathSlash)
URI	buildFromEncoded(Object... values)
URI	buildFromEncodedMap(Map<String,?> map)
URI	buildFromMap(Map<String,?> map)
URI	buildFromMap(Map<String,?> map, boolean encodePathSlash)
jakarta.ws.rs.core.UriBuilder	clone()
jakarta.ws.rs.core.UriBuilder	fragment(String theFragment)
jakarta.ws.rs.core.UriBuilder	host(String theHost)
jakarta.ws.rs.core.UriBuilder	matrixParam(String name, Object... values)
jakarta.ws.rs.core.UriBuilder	path(Class resource)
jakarta.ws.rs.core.UriBuilder	path(Class resource, String method)
jakarta.ws.rs.core.UriBuilder	path(Method method)
jakarta.ws.rs.core.UriBuilder	path(String path)
jakarta.ws.rs.core.UriBuilder	port(int thePort)
jakarta.ws.rs.core.UriBuilder	queryParam(String name, Object... values)
jakarta.ws.rs.core.UriBuilder	replaceMatrix(String matrixValues)
jakarta.ws.rs.core.UriBuilder	replaceMatrixParam(String name, Object... values)
jakarta.ws.rs.core.UriBuilder	replacePath(String path)
jakarta.ws.rs.core.UriBuilder	replaceQuery(String queryValue)
jakarta.ws.rs.core.UriBuilder	replaceQueryParam(String name, Object... values)
jakarta.ws.rs.core.UriBuilder	resolveTemplate(String name, Object value)
jakarta.ws.rs.core.UriBuilder	resolveTemplate(String name, Object value, boolean encodePathSlash)
jakarta.ws.rs.core.UriBuilder	resolveTemplateFromEncoded(String name, Object value)
jakarta.ws.rs.core.UriBuilder	resolveTemplates(Map<String,Object> values)
jakarta.ws.rs.core.UriBuilder	resolveTemplates(Map<String,Object> values, boolean encodePathSlash)
jakarta.ws.rs.core.UriBuilder	resolveTemplatesFromEncoded(Map<String,Object> values)
jakarta.ws.rs.core.UriBuilder	scheme(String s)
jakarta.ws.rs.core.UriBuilder	schemeSpecificPart(String ssp)
jakarta.ws.rs.core.UriBuilder	segment(String... segments)
String	toTemplate()
jakarta.ws.rs.core.UriBuilder	uri(String uriTemplate)
jakarta.ws.rs.core.UriBuilder	uri(URI uri)
jakarta.ws.rs.core.UriBuilder	uriAsTemplate(String uri)
jakarta.ws.rs.core.UriBuilder	userInfo(String ui)

Methods inherited from class jakarta.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 Details

UriBuilderImpl

public UriBuilderImpl()

Creates builder with empty URI.

UriBuilderImpl

public UriBuilderImpl(Map<String,Object> properties)

Creates builder with empty URI and properties

UriBuilderImpl

public UriBuilderImpl(URI uri)
               throws IllegalArgumentException

Creates builder initialized with given URI.

Parameters:

uri - initial value for builder

Throws:

IllegalArgumentException - when uri is null

Method Details

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

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

buildFromMap

public URI buildFromMap(Map<String,?> map)
                 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,?> map)
                        throws IllegalArgumentException,
jakarta.ws.rs.core.UriBuilderException

Specified by:

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

Throws:

IllegalArgumentException

jakarta.ws.rs.core.UriBuilderException

clone

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

Specified by:

clone in class jakarta.ws.rs.core.UriBuilder

fragment

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

Specified by:

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

Throws:

IllegalArgumentException

host

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

Specified by:

host 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

path

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

Specified by:

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

Throws:

IllegalArgumentException

port

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

Specified by:

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

Throws:

IllegalArgumentException

scheme

public jakarta.ws.rs.core.UriBuilder scheme(String s)
                                     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

uri

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

Specified by:

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

Throws:

IllegalArgumentException

userInfo

public jakarta.ws.rs.core.UriBuilder userInfo(String ui)
                                       throws IllegalArgumentException

Specified by:

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

Throws:

IllegalArgumentException

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

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

replaceMatrix

public jakarta.ws.rs.core.UriBuilder replaceMatrix(String matrixValues)
                                            throws IllegalArgumentException

Specified by:

replaceMatrix 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

replacePath

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

Specified by:

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

replaceQuery

public jakarta.ws.rs.core.UriBuilder replaceQuery(String queryValue)
                                           throws IllegalArgumentException

Specified by:

replaceQuery 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

segment

public jakarta.ws.rs.core.UriBuilder segment(String... segments)
                                      throws IllegalArgumentException

Specified by:

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

Throws:

IllegalArgumentException

uri

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

Specified by:

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

Throws:

IllegalArgumentException

uriAsTemplate

public jakarta.ws.rs.core.UriBuilder uriAsTemplate(String uri)

build

public URI build(Object[] vars,
 boolean encodePathSlash)
          throws IllegalArgumentException,
jakarta.ws.rs.core.UriBuilderException

Specified by:

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

Throws:

IllegalArgumentException

jakarta.ws.rs.core.UriBuilderException

buildFromMap

public URI buildFromMap(Map<String,?> map,
 boolean encodePathSlash)
                 throws IllegalArgumentException,
jakarta.ws.rs.core.UriBuilderException

Specified by:

buildFromMap 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

resolveTemplate

public jakarta.ws.rs.core.UriBuilder resolveTemplate(String name,
 Object value,
 boolean encodePathSlash)
                                              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> values)
                                               throws IllegalArgumentException

Specified by:

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

Throws:

IllegalArgumentException

resolveTemplates

public jakarta.ws.rs.core.UriBuilder resolveTemplates(Map<String,Object> values,
 boolean encodePathSlash)
                                               throws IllegalArgumentException

Specified by:

resolveTemplates 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

resolveTemplatesFromEncoded

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

Specified by:

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

Throws:

IllegalArgumentException