com.nimbusds.jose.util.JSONObjectUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nimbus-jose-jwt Show documentation
Show all versions of nimbus-jose-jwt Show documentation
Java library for Javascript Object Signing and Encryption (JOSE) and
JSON Web Tokens (JWT)
/*
* nimbus-jose-jwt
*
* Copyright 2012-2016, Connect2id Ltd.
*
* 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.jose.util;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.ToNumberPolicy;
import com.google.gson.reflect.TypeToken;
import com.nimbusds.jwt.util.DateUtils;
import java.lang.reflect.Type;
import java.net.URI;
import java.net.URISyntaxException;
import java.text.ParseException;
import java.util.*;
/**
* JSON object helper methods.
*
* @author Vladimir Dzhuvinov
* @version 2024-05-10
*/
public class JSONObjectUtils {
/**
* The GSon instance for serialisation and parsing.
*/
private static final Gson GSON = new GsonBuilder()
.serializeNulls()
.setObjectToNumberStrategy(ToNumberPolicy.LONG_OR_DOUBLE)
.disableHtmlEscaping()
.create();
/**
* Parses a JSON object.
*
* Specific JSON to Java entity mapping (as per JSON Smart):
*
*
* - JSON true|false map to {@code java.lang.Boolean}.
*
- JSON numbers map to {@code java.lang.Number}.
*
* - JSON integer numbers map to {@code long}.
*
- JSON fraction numbers map to {@code double}.
*
* - JSON strings map to {@code java.lang.String}.
*
- JSON arrays map to {@code java.util.List
*
* @param s The JSON object string to parse. Must not be {@code null}.
*
* @return The JSON object.
*
* @throws ParseException If the string cannot be parsed to a valid JSON
* object.
*/
public static Map parse(final String s)
throws ParseException {
return parse(s, -1);
}
/**
* Parses a JSON object with the option to limit the input string size.
*
* Specific JSON to Java entity mapping (as per JSON Smart):
*
*
* - JSON true|false map to {@code java.lang.Boolean}.
*
- JSON numbers map to {@code java.lang.Number}.
*
* - JSON integer numbers map to {@code long}.
*
- JSON fraction numbers map to {@code double}.
*
* - JSON strings map to {@code java.lang.String}.
*
- JSON arrays map to {@code java.util.List
*
* @param s The JSON object string to parse. Must not be
* {@code null}.
* @param sizeLimit The max allowed size of the string to parse. A
* negative integer means no limit.
*
* @return The JSON object.
*
* @throws ParseException If the string cannot be parsed to a valid JSON
* object.
*/
public static Map parse(final String s, final int sizeLimit)
throws ParseException {
if (s == null) {
throw new ParseException("The JSON object string must not be null", 0);
}
if (s.trim().isEmpty()) {
throw new ParseException("Invalid JSON object", 0);
}
if (sizeLimit >= 0 && s.length() > sizeLimit) {
throw new ParseException("The parsed string is longer than the max accepted size of " + sizeLimit + " characters", 0);
}
Type mapType = TypeToken.getParameterized(Map.class, String.class, Object.class).getType();
try {
return GSON.fromJson(s, mapType);
} catch (Exception e) {
throw new ParseException("Invalid JSON: " + e.getMessage(), 0);
} catch (StackOverflowError e) {
throw new ParseException("Excessive JSON object and / or array nesting", 0);
}
}
/**
* Use {@link #parse(String)} instead.
*
* @param s The JSON object string to parse. Must not be {@code null}.
*
* @return The JSON object.
*
* @throws ParseException If the string cannot be parsed to a valid JSON
* object.
*/
@Deprecated
public static Map parseJSONObject(final String s)
throws ParseException {
return parse(s);
}
/**
* Gets a generic member of a JSON object.
*
* @param o The JSON object. Must not be {@code null}.
* @param name The JSON object member name. Must not be {@code null}.
* @param clazz The expected class of the JSON object member value.
* Must not be {@code null}.
*
* @return The JSON object member value, may be {@code null}.
*
* @throws ParseException If the value is not of the expected type.
*/
private static T getGeneric(final Map o, final String name, final Class clazz)
throws ParseException {
if (o.get(name) == null) {
return null;
}
Object value = o.get(name);
if (! clazz.isAssignableFrom(value.getClass())) {
throw new ParseException("Unexpected type of JSON object member " + name + "", 0);
}
@SuppressWarnings("unchecked")
T castValue = (T)value;
return castValue;
}
/**
* Gets a boolean member of a JSON object.
*
* @param o The JSON object. Must not be {@code null}.
* @param name The JSON object member name. Must not be {@code null}.
*
* @return The JSON object member value.
*
* @throws ParseException If the member is missing, the value is
* {@code null} or not of the expected type.
*/
public static boolean getBoolean(final Map o, final String name)
throws ParseException {
Boolean value = getGeneric(o, name, Boolean.class);
if (value == null) {
throw new ParseException("JSON object member " + name + " is missing or null", 0);
}
return value;
}
/**
* Gets a number member of a JSON object as {@code int}.
*
* @param o The JSON object. Must not be {@code null}.
* @param name The JSON object member name. Must not be {@code null}.
*
* @return The JSON object member value.
*
* @throws ParseException If the member is missing, the value is
* {@code null} or not of the expected type.
*/
public static int getInt(final Map o, final String name)
throws ParseException {
Number value = getGeneric(o, name, Number.class);
if (value == null) {
throw new ParseException("JSON object member " + name + " is missing or null", 0);
}
return value.intValue();
}
/**
* Gets a number member of a JSON object as {@code long}.
*
* @param o The JSON object. Must not be {@code null}.
* @param name The JSON object member name. Must not be {@code null}.
*
* @return The JSON object member value.
*
* @throws ParseException If the member is missing, the value is
* {@code null} or not of the expected type.
*/
public static long getLong(final Map o, final String name)
throws ParseException {
Number value = getGeneric(o, name, Number.class);
if (value == null) {
throw new ParseException("JSON object member " + name + " is missing or null", 0);
}
return value.longValue();
}
/**
* Gets a number member of a JSON object {@code float}.
*
* @param o The JSON object. Must not be {@code null}.
* @param name The JSON object member name. Must not be {@code null}.
*
* @return The JSON object member value, may be {@code null}.
*
* @throws ParseException If the member is missing, the value is
* {@code null} or not of the expected type.
*/
public static float getFloat(final Map o, final String name)
throws ParseException {
Number value = getGeneric(o, name, Number.class);
if (value == null) {
throw new ParseException("JSON object member " + name + " is missing or null", 0);
}
return value.floatValue();
}
/**
* Gets a number member of a JSON object as {@code double}.
*
* @param o The JSON object. Must not be {@code null}.
* @param name The JSON object member name. Must not be {@code null}.
*
* @return The JSON object member value, may be {@code null}.
*
* @throws ParseException If the member is missing, the value is
* {@code null} or not of the expected type.
*/
public static double getDouble(final Map o, final String name)
throws ParseException {
Number value = getGeneric(o, name, Number.class);
if (value == null) {
throw new ParseException("JSON object member " + name + " is missing or null", 0);
}
return value.doubleValue();
}
/**
* Gets a string member of a JSON object.
*
* @param o The JSON object. Must not be {@code null}.
* @param name The JSON object member name. Must not be {@code null}.
*
* @return The JSON object member value, may be {@code null}.
*
* @throws ParseException If the value is not of the expected type.
*/
public static String getString(final Map o, final String name)
throws ParseException {
return getGeneric(o, name, String.class);
}
/**
* Gets a string member of a JSON object as {@code java.net.URI}.
*
* @param o The JSON object. Must not be {@code null}.
* @param name The JSON object member name. Must not be {@code null}.
*
* @return The JSON object member value, may be {@code null}.
*
* @throws ParseException If the value is not of the expected type.
*/
public static URI getURI(final Map o, final String name)
throws ParseException {
String value = getString(o, name);
if (value == null) {
return null;
}
try {
return new URI(value);
} catch (URISyntaxException e) {
throw new ParseException(e.getMessage(), 0);
}
}
/**
* Gets a JSON array member of a JSON object.
*
* @param o The JSON object. Must not be {@code null}.
* @param name The JSON object member name. Must not be {@code null}.
*
* @return The JSON object member value, may be {@code null}.
*
* @throws ParseException If the value is not of the expected type.
*/
public static List © 2015 - 2024 Weber Informatics LLC | Privacy Policy