com.nimbusds.oauth2.sdk.util.URLUtils Maven / Gradle / Ivy
Show all versions of oauth2-oidc-sdk Show documentation
/*
* oauth2-oidc-sdk
*
* Copyright 2012-2016, Connect2id Ltd and contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed
* under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package com.nimbusds.oauth2.sdk.util;
import java.io.UnsupportedEncodingException;
import java.net.*;
import java.util.*;
/**
* URL operations.
*/
public final class URLUtils {
/**
* The default UTF-8 character set.
*/
public static final String CHARSET = "utf-8";
/**
* Gets the base part (protocol, host, port and path) of the specified
* URL.
*
* @param url The URL. May be {@code null}.
*
* @return The base part of the URL, {@code null} if the original URL
* is {@code null} or doesn't specify a protocol.
*/
public static URL getBaseURL(final URL url) {
if (url == null)
return null;
try {
return new URL(url.getProtocol(), url.getHost(), url.getPort(), url.getPath());
} catch (MalformedURLException e) {
return null;
}
}
/**
* Sets the encoded query of the specified URL.
*
* @param url The URL. May be {@code null}.
* @param query The encoded query, {@code null} if not specified.
*
* @return The new URL.
*/
public static URL setEncodedQuery(final URL url, final String query) {
if (url == null) {
return null;
}
try {
URI uri = url.toURI();
StringBuilder sb = new StringBuilder(URIUtils.getBaseURI(uri).toString());
if (query != null && ! query.isEmpty()) {
sb.append('?');
sb.append(query);
}
if (uri.getRawFragment() != null) {
sb.append('#');
sb.append(uri.getRawFragment());
}
return new URL(sb.toString());
} catch (MalformedURLException | URISyntaxException e) {
throw new IllegalArgumentException(e);
}
}
/**
* Sets the encoded fragment of the specified URL.
*
* @param url The URL. May be {@code null}.
* @param fragment The encoded fragment, {@code null} if not specified.
*
* @return The new URL.
*/
public static URL setEncodedFragment(final URL url, final String fragment) {
if (url == null) {
return null;
}
try {
URI uri = url.toURI();
StringBuilder sb = new StringBuilder(URIUtils.getBaseURI(uri).toString());
if (uri.getRawQuery() != null) {
sb.append('?');
sb.append(uri.getRawQuery());
}
if (fragment != null && ! fragment.isEmpty()) {
sb.append('#');
sb.append(fragment);
}
return new URL(sb.toString());
} catch (MalformedURLException | URISyntaxException e) {
throw new IllegalArgumentException(e);
}
}
/**
* Performs {@code application/x-www-form-urlencoded} encoding on the
* specified parameter keys and values.
*
* @param params A map of the parameters. May be empty or {@code null}.
*
* @return The encoded parameters, {@code null} if not specified.
*/
public static Map> urlEncodeParameters(final Map> params) {
if (MapUtils.isEmpty(params)) {
return params;
}
Map> out = new LinkedHashMap<>(); // preserve order
for (Map.Entry> entry: params.entrySet()) {
try {
String newKey = entry.getKey() != null ? URLEncoder.encode(entry.getKey(), CHARSET) : null;
List newValues;
if (entry.getValue() != null) {
newValues = new LinkedList<>();
for (String value : entry.getValue()) {
if (value != null) {
newValues.add(URLEncoder.encode(value, CHARSET));
} else {
newValues.add(null); // preserve null values
}
}
} else {
newValues = null;
}
out.put(newKey, newValues);
} catch (UnsupportedEncodingException e) {
// UTF-8 must always be supported
throw new RuntimeException(e);
}
}
return out;
}
/**
* Serialises the specified map of parameters into a URL query string.
* The parameter keys and values are
* {@code application/x-www-form-urlencoded} encoded.
*
* Parameters with {@code null} keys or values are ignored and not
* serialised.
*
*
Note that the '?' character preceding the query string in GET
* requests is not included in the returned string.
*
*
Example query string:
*
*
* response_type=code
* &client_id=s6BhdRkqt3
* &state=xyz
* &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb
*
*
* The opposite method is {@link #parseParameters}.
*
* @param params A map of the URL query parameters. May be empty or
* {@code null}.
*
* @return The serialised URL query string, empty if no parameters.
*/
public static String serializeParameters(final Map> params) {
if (params == null || params.isEmpty())
return "";
Map> encodedParams = urlEncodeParameters(params);
StringBuilder sb = new StringBuilder();
for (Map.Entry> entry: encodedParams.entrySet()) {
if (entry.getKey() == null || entry.getValue() == null)
continue;
for (String value: entry.getValue()) {
if (value == null) {
value = "";
}
if (sb.length() > 0)
sb.append('&');
sb.append(entry.getKey());
sb.append('=');
sb.append(value);
}
}
return sb.toString();
}
/**
* Serialises the specified map of parameters into a URL query string.
* Supports multiple key / value pairs that have the same key. The
* parameter keys and values are
* {@code application/x-www-form-urlencoded} encoded.
*
* Parameters with {@code null} keys or values are ignored and not
* serialised.
*
*
Note that the '?' character preceding the query string in GET
* requests is not included in the returned string.
*
*
Example query string:
*
*
* response_type=code
* &client_id=s6BhdRkqt3
* &state=xyz
* &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb
*
*
* The opposite method is {@link #parseParameters}.
*
* @param params A map of the URL query parameters. May be empty or
* {@code null}.
*
* @return The serialised URL query string, empty if no parameters.
*/
public static String serializeParametersAlt(final Map params) {
if (params == null) {
return serializeParameters(null);
}
Map> out = new HashMap<>();
for (Map.Entry entry: params.entrySet()) {
if (entry.getValue() == null) {
out.put(entry.getKey(), null);
} else {
out.put(entry.getKey(), Arrays.asList(entry.getValue()));
}
}
return serializeParameters(out);
}
/**
* Parses the specified URL query string into a parameter map. If a
* parameter has multiple values only the first one will be saved. The
* parameter keys and values are
* {@code application/x-www-form-urlencoded} decoded.
*
* Note that the '?' character preceding the query string in GET
* requests must not be included.
*
*
Example query string:
*
*
* response_type=code
* &client_id=s6BhdRkqt3
* &state=xyz
* &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb
*
*
* The opposite method {@link #serializeParameters}.
*
* @param query The URL query string to parse. May be {@code null}.
*
* @return A map of the URL query parameters, empty if none are found.
*/
public static Map> parseParameters(final String query) {
Map> params = new LinkedHashMap<>();
if (StringUtils.isBlank(query)) {
return params; // empty map
}
StringTokenizer st = new StringTokenizer(query.trim(), "&");
while(st.hasMoreTokens()) {
String param = st.nextToken();
String[] pair = param.split("=", 2); // Split around the first '=', see issue #169
String key, value;
try {
key = URLDecoder.decode(pair[0], CHARSET);
value = pair.length > 1 ? URLDecoder.decode(pair[1], CHARSET) : "";
} catch (UnsupportedEncodingException e) {
// UTF-8 should always be supported
continue;
} catch (Exception e) {
// Handle "IllegalArgumentException: URLDecoder: Incomplete trailing escape (%) pattern", etc
continue;
}
if (params.containsKey(key)) {
// Append value
List updatedValueList = new LinkedList<>(params.get(key));
updatedValueList.add(value);
params.put(key, Collections.unmodifiableList(updatedValueList));
} else {
params.put(key, Collections.singletonList(value));
}
}
return params;
}
/**
* Prevents public instantiation.
*/
private URLUtils() {}
}