Keycloak 24.0.0 · org.keycloak.common.util.KeycloakUriBuilder

Modifier and Type	Field and Description
private String	authority
private String	fragment
private static final Pattern	hierarchicalUri
private String	host
private static final Pattern	hostPortPattern
private static final Pattern	opaqueUri
private static final Pattern	PARAM_REPLACEMENT
private String	path
private int	port
private boolean	preserveDefaultPort
private String	query
private String	scheme
private String	ssp
private String	userInfo

Access	Constructor and Description
public	KeycloakUriBuilder()

Method Summary

Modifier and Type	Method and Description
private void	addToPathParamList(List<String> params, HashSet<String> set, String string)
public URI	build(Object... values)
public URI	build(Object[] values, boolean encodeSlashInPath)
public String	buildAsString(Object... values)
public URI	buildFromEncodedMap(Map<String, ?> values)
public URI	buildFromMap(Map<String, ?> values)
public URI	buildFromMap(Map<String, ?> values, boolean encodeSlashInPath)
protected URI	buildFromValues(boolean encodeSlash, boolean encoded, Object... values)
protected String	buildFromValuesAsString(boolean encodeSlash, boolean encoded, Object... values)
private String	buildString(Map<String, ?> paramMap, boolean fromEncodedMap, boolean isTemplate, boolean encodeSlash)
protected URI	buildUriFromMap(Map<String, ?> paramMap, boolean fromEncodedMap, boolean encodeSlash)
public KeycloakUriBuilder	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public static boolean	compare(String s1, String s2)
public static Matcher	createUriParamMatcher(String string)
public KeycloakUriBuilder	encodedFragment(String fragment) Set fragment, but not encode it.
public KeycloakUriBuilder	fragment(String fragment)
public KeycloakUriBuilder	fragment(String fragment, boolean template)
public static KeycloakUriBuilder	fromPath(String path)
public static KeycloakUriBuilder	fromTemplate(String uriTemplate) You may put path parameters anywhere within the uriTemplate except port
public static KeycloakUriBuilder	fromUri(URI uri)
public static KeycloakUriBuilder	fromUri(String uriTemplate)
public static KeycloakUriBuilder	fromUri(String uri, boolean template)
public String	getFragment()
public String	getHost()
public String	getPath()
public List<String>	getPathParamNamesInDeclarationOrder() Return a unique order list of path params
public int	getPort()
public String	getQuery()
public String	getScheme()
public String	getUserInfo()
public KeycloakUriBuilder	host(String host)
public KeycloakUriBuilder	matrixParam(String name, Object... values)
protected KeycloakUriBuilder	parseHierarchicalUri(String uri, Matcher match, boolean template)
public KeycloakUriBuilder	path(String segment)
protected static String	paths(boolean encode, String basePath, String... segments)
public KeycloakUriBuilder	port(int port)
public KeycloakUriBuilder	preserveDefaultPort() When this is called, then the port will be preserved in the build URL even if it is default port for the protocol (http, https) For example: - KeycloakUriBuilder.fromUri("https://localhost:443/path").buildAsString() will return "https://localhost/path" (port not preserved) - KeycloakUriBuilder.fromUri("https://localhost:443/path").preserveDefaultPort().buildAsString() will return "https://localhost:443/path" (port is preserved even if default port) - KeycloakUriBuilder.fromUri("https://localhost/path").preserveDefaultPort().buildAsString() will return "https://localhost/path" (port not included even if "preserveDefaultPort" as it was not in the original URL)
public KeycloakUriBuilder	queryParam(String name, Object... values)
public static URI	relativize(URI from, URI to)
public KeycloakUriBuilder	replaceMatrix(String matrix)
protected StringBuffer	replaceParameter(Map<String, ?> paramMap, boolean fromEncodedMap, boolean isTemplate, String string, StringBuffer buffer, boolean encodeSlash)
public KeycloakUriBuilder	replacePath(String path)
public KeycloakUriBuilder	replacePath(String path, boolean template)
protected StringBuffer	replacePathParameter(String name, String value, boolean isEncoded, String string, StringBuffer buffer, boolean encodeSlash)
public KeycloakUriBuilder	replaceQuery(String query)
public KeycloakUriBuilder	replaceQuery(String query, boolean template)
public KeycloakUriBuilder	replaceQueryParam(String name, Object... values)
protected StringBuffer	replaceQueryStringParameter(Map<String, ?> paramMap, boolean fromEncodedMap, boolean isTemplate, String string, StringBuffer buffer)
public KeycloakUriBuilder	resolveTemplate(String name, Object value)
public KeycloakUriBuilder	resolveTemplate(String name, Object value, boolean encodeSlashInPath)
public KeycloakUriBuilder	resolveTemplates(Map<String, Object> templateValues)
public KeycloakUriBuilder	resolveTemplates(Map<String, Object> templateValues, boolean encodeSlashInPath)
public KeycloakUriBuilder	resolveTemplatesFromEncoded(Map<String, Object> templateValues)
public KeycloakUriBuilder	scheme(String scheme)
public KeycloakUriBuilder	schemeSpecificPart(String ssp)
public KeycloakUriBuilder	segment(String... segments)
public KeycloakUriBuilder	substitutePathParam(String name, Object value, boolean isEncoded) Only replace path params in path of URI.
public String	toTemplate()
public KeycloakUriBuilder	uri(String uri)
public KeycloakUriBuilder	uri(String uri, boolean template)
public KeycloakUriBuilder	uri(URI uri)
public KeycloakUriBuilder	uriTemplate(String uriTemplate) You may put path parameters anywhere within the uriTemplate except port
public KeycloakUriBuilder	userInfo(String ui)

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

authority	back to summary
private String authority

fragment	back to summary
private String fragment

hierarchicalUri	back to summary
private static final Pattern hierarchicalUri

host	back to summary
private String host

hostPortPattern	back to summary
private static final Pattern hostPortPattern

opaqueUri	back to summary
private static final Pattern opaqueUri

PARAM_REPLACEMENT	back to summary
private static final Pattern PARAM_REPLACEMENT

path	back to summary
private String path

port	back to summary
private int port

preserveDefaultPort	back to summary
private boolean preserveDefaultPort

query	back to summary
private String query

scheme	back to summary
private String scheme

ssp	back to summary
private String ssp

userInfo	back to summary
private String userInfo

KeycloakUriBuilder	back to summary
public KeycloakUriBuilder()

Method Detail

addToPathParamList	back to summary
private void addToPathParamList(List<String> params, HashSet<String> set, String string)

build	back to summary
public URI build(Object... values) throws IllegalArgumentException

build	back to summary
public URI build(Object[] values, boolean encodeSlashInPath) throws IllegalArgumentException

buildAsString	back to summary
public String buildAsString(Object... values) throws IllegalArgumentException

buildFromEncodedMap	back to summary
public URI buildFromEncodedMap(Map<String, ?> values) throws IllegalArgumentException

buildFromMap	back to summary
public URI buildFromMap(Map<String, ?> values) throws IllegalArgumentException

buildFromMap	back to summary
public URI buildFromMap(Map<String, ?> values, boolean encodeSlashInPath) throws IllegalArgumentException

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

buildFromValuesAsString	back to summary
protected String buildFromValuesAsString(boolean encodeSlash, boolean encoded, Object... values)

buildString	back to summary
private String buildString(Map<String, ?> paramMap, boolean fromEncodedMap, boolean isTemplate, boolean encodeSlash)

buildUriFromMap	back to summary
protected URI buildUriFromMap(Map<String, ?> paramMap, boolean fromEncodedMap, boolean encodeSlash) throws IllegalArgumentException

clone back to summary

clone	back to summary
public KeycloakUriBuilder clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:KeycloakUriBuilder a clone of this instance.

public KeycloakUriBuilder clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:KeycloakUriBuilder: a clone of this instance.

compare	back to summary
public static boolean compare(String s1, String s2)

createUriParamMatcher	back to summary
public static Matcher createUriParamMatcher(String string)

encodedFragment	back to summary
public KeycloakUriBuilder encodedFragment(String fragment) Set fragment, but not encode it. It assumes that given fragment was already properly encoded

fragment	back to summary
public KeycloakUriBuilder fragment(String fragment) throws IllegalArgumentException

fragment	back to summary
public KeycloakUriBuilder fragment(String fragment, boolean template) throws IllegalArgumentException

fromPath	back to summary
public static KeycloakUriBuilder fromPath(String path) throws IllegalArgumentException

fromTemplate	back to summary
public static KeycloakUriBuilder fromTemplate(String uriTemplate) You may put path parameters anywhere within the uriTemplate except port

fromUri	back to summary
public static KeycloakUriBuilder fromUri(URI uri)

fromUri	back to summary
public static KeycloakUriBuilder fromUri(String uriTemplate)

fromUri	back to summary
public static KeycloakUriBuilder fromUri(String uri, boolean template)

getFragment	back to summary
public String getFragment()

getHost	back to summary
public String getHost()

getPath	back to summary
public String getPath()

getPathParamNamesInDeclarationOrder	back to summary
public List<String> getPathParamNamesInDeclarationOrder() Return a unique order list of path params

getPort	back to summary
public int getPort()

getQuery	back to summary
public String getQuery()

getScheme	back to summary
public String getScheme()

getUserInfo	back to summary
public String getUserInfo()

host	back to summary
public KeycloakUriBuilder host(String host) throws IllegalArgumentException

matrixParam	back to summary
public KeycloakUriBuilder matrixParam(String name, Object... values) throws IllegalArgumentException

parseHierarchicalUri	back to summary
protected KeycloakUriBuilder parseHierarchicalUri(String uri, Matcher match, boolean template)

path	back to summary
public KeycloakUriBuilder path(String segment) throws IllegalArgumentException

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

port	back to summary
public KeycloakUriBuilder port(int port) throws IllegalArgumentException

preserveDefaultPort

back to summary

public KeycloakUriBuilder preserveDefaultPort()

When this is called, then the port will be preserved in the build URL even if it is default port for the protocol (http, https) For example: - KeycloakUriBuilder.fromUri("https://localhost:443/path").buildAsString() will return "https://localhost/path" (port not preserved) - KeycloakUriBuilder.fromUri("https://localhost:443/path").preserveDefaultPort().buildAsString() will return "https://localhost:443/path" (port is preserved even if default port) - KeycloakUriBuilder.fromUri("https://localhost/path").preserveDefaultPort().buildAsString() will return "https://localhost/path" (port not included even if "preserveDefaultPort" as it was not in the original URL)

queryParam	back to summary
public KeycloakUriBuilder queryParam(String name, Object... values) throws IllegalArgumentException

relativize	back to summary
public static URI relativize(URI from, URI to)

replaceMatrix	back to summary
public KeycloakUriBuilder replaceMatrix(String matrix) throws IllegalArgumentException

replaceParameter	back to summary
protected StringBuffer replaceParameter(Map<String, ?> paramMap, boolean fromEncodedMap, boolean isTemplate, String string, StringBuffer buffer, boolean encodeSlash)

replacePath	back to summary
public KeycloakUriBuilder replacePath(String path)

replacePath	back to summary
public KeycloakUriBuilder replacePath(String path, boolean template)

replacePathParameter	back to summary
protected StringBuffer replacePathParameter(String name, String value, boolean isEncoded, String string, StringBuffer buffer, boolean encodeSlash)

replaceQuery	back to summary
public KeycloakUriBuilder replaceQuery(String query) throws IllegalArgumentException

replaceQuery	back to summary
public KeycloakUriBuilder replaceQuery(String query, boolean template) throws IllegalArgumentException

replaceQueryParam	back to summary
public KeycloakUriBuilder replaceQueryParam(String name, Object... values) throws IllegalArgumentException

replaceQueryStringParameter	back to summary
protected StringBuffer replaceQueryStringParameter(Map<String, ?> paramMap, boolean fromEncodedMap, boolean isTemplate, String string, StringBuffer buffer)

resolveTemplate	back to summary
public KeycloakUriBuilder resolveTemplate(String name, Object value) throws IllegalArgumentException

resolveTemplate	back to summary
public KeycloakUriBuilder resolveTemplate(String name, Object value, boolean encodeSlashInPath) throws IllegalArgumentException

resolveTemplates	back to summary
public KeycloakUriBuilder resolveTemplates(Map<String, Object> templateValues) throws IllegalArgumentException

resolveTemplates	back to summary
public KeycloakUriBuilder resolveTemplates(Map<String, Object> templateValues, boolean encodeSlashInPath) throws IllegalArgumentException

resolveTemplatesFromEncoded	back to summary
public KeycloakUriBuilder resolveTemplatesFromEncoded(Map<String, Object> templateValues) throws IllegalArgumentException

scheme	back to summary
public KeycloakUriBuilder scheme(String scheme) throws IllegalArgumentException

schemeSpecificPart	back to summary
public KeycloakUriBuilder schemeSpecificPart(String ssp) throws IllegalArgumentException

segment	back to summary
public KeycloakUriBuilder segment(String... segments) throws IllegalArgumentException

substitutePathParam	back to summary
public KeycloakUriBuilder substitutePathParam(String name, Object value, boolean isEncoded) Only replace path params in path of URI. This changes state of URIBuilder.

toTemplate	back to summary
public String toTemplate()

uri	back to summary
public KeycloakUriBuilder uri(String uri) throws IllegalArgumentException

uri	back to summary
public KeycloakUriBuilder uri(String uri, boolean template) throws IllegalArgumentException

uri	back to summary
public KeycloakUriBuilder uri(URI uri) throws IllegalArgumentException

uriTemplate	back to summary
public KeycloakUriBuilder uriTemplate(String uriTemplate) You may put path parameters anywhere within the uriTemplate except port

userInfo	back to summary
public KeycloakUriBuilder userInfo(String ui)

public Class KeycloakUriBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail