Java tutorial
/* * Password Management Servlets (PWM) * http://www.pwm-project.org * * Copyright (c) 2006-2009 Novell, Inc. * Copyright (c) 2009-2017 The PWM Project * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ package password.pwm.util.java; import com.google.gson.Gson; import com.google.gson.GsonBuilder; import com.google.gson.JsonDeserializationContext; import com.google.gson.JsonDeserializer; import com.google.gson.JsonElement; import com.google.gson.JsonParseException; import com.google.gson.JsonPrimitive; import com.google.gson.JsonSerializationContext; import com.google.gson.JsonSerializer; import com.google.gson.reflect.TypeToken; import password.pwm.error.PwmUnrecoverableException; import password.pwm.util.PasswordData; import password.pwm.util.logging.PwmLogger; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.Serializable; import java.lang.reflect.Type; import java.security.cert.CertificateEncodingException; import java.security.cert.CertificateFactory; import java.security.cert.X509Certificate; import java.text.DateFormat; import java.text.ParseException; import java.text.SimpleDateFormat; import java.time.Instant; import java.util.Collection; import java.util.Date; import java.util.List; import java.util.Map; import java.util.TimeZone; public class JsonUtil { private static final PwmLogger LOGGER = PwmLogger.forClass(JsonUtil.class); public enum Flag { PrettyPrint, HtmlEscape, } private static final Gson GENERIC_GSON = registerTypeAdapters(new GsonBuilder()).disableHtmlEscaping().create(); private static Gson getGson(final Flag... flags) { if (flags == null || flags.length == 0) { return GENERIC_GSON; } final GsonBuilder gsonBuilder = registerTypeAdapters(new GsonBuilder()); if (!JavaHelper.enumArrayContainsValue(flags, Flag.HtmlEscape)) { gsonBuilder.disableHtmlEscaping(); } if (JavaHelper.enumArrayContainsValue(flags, Flag.PrettyPrint)) { gsonBuilder.setPrettyPrinting(); } return gsonBuilder.create(); } public static <T> T deserialize(final String jsonString, final TypeToken typeToken) { return JsonUtil.getGson().fromJson(jsonString, typeToken.getType()); } public static <T> T deserialize(final String jsonString, final Type type) { return JsonUtil.getGson().fromJson(jsonString, type); } public static List<String> deserializeStringList(final String jsonString) { return JsonUtil.getGson().fromJson(jsonString, new TypeToken<List<Object>>() { }.getType()); } public static Map<String, String> deserializeStringMap(final String jsonString) { return JsonUtil.getGson().fromJson(jsonString, new TypeToken<Map<String, String>>() { }.getType()); } public static Map<String, Object> deserializeStringObjectMap(final String jsonString) { return JsonUtil.getGson().fromJson(jsonString, new TypeToken<Map<String, Object>>() { }.getType()); } public static Map<String, Object> deserializeMap(final String jsonString) { return JsonUtil.getGson().fromJson(jsonString, new TypeToken<Map<String, Object>>() { }.getType()); } public static <T> T deserialize(final String json, final Class<T> classOfT) { return JsonUtil.getGson().fromJson(json, classOfT); } public static String serialize(final Serializable object, final Flag... flags) { return JsonUtil.getGson(flags).toJson(object); } public static String serializeMap(final Map object, final Flag... flags) { return JsonUtil.getGson(flags).toJson(object); } public static String serializeCollection(final Collection object, final Flag... flags) { return JsonUtil.getGson(flags).toJson(object); } /** * Gson Serializer for {@link java.security.cert.X509Certificate}. Neccessary because sometimes X509Certs have circular refecences * and the default gson serializer will cause a {@code java.lang.StackOverflowError}. Standard Base64 encoding of * the cert is used as the json format. */ private static class X509CertificateAdapter implements JsonSerializer<X509Certificate>, JsonDeserializer<X509Certificate> { private X509CertificateAdapter() { } public synchronized JsonElement serialize(final X509Certificate cert, final Type type, final JsonSerializationContext jsonSerializationContext) { try { return new JsonPrimitive(StringUtil.base64Encode(cert.getEncoded())); } catch (CertificateEncodingException e) { throw new IllegalStateException("unable to json-encode certificate: " + e.getMessage()); } } public X509Certificate deserialize(final JsonElement jsonElement, final Type type, final JsonDeserializationContext jsonDeserializationContext) throws JsonParseException { try { final CertificateFactory certificateFactory = CertificateFactory.getInstance("X.509"); return (X509Certificate) certificateFactory.generateCertificate( new ByteArrayInputStream(StringUtil.base64Decode(jsonElement.getAsString()))); } catch (Exception e) { throw new JsonParseException("unable to parse x509certificate: " + e.getMessage()); } } } /** * GsonSerializer that stores dates in ISO 8601 format, with a deserialier that also reads local-platform format reading. */ private static class DateTypeAdapter implements JsonSerializer<Date>, JsonDeserializer<Date> { private static final DateFormat ISO_DATE_FORMAT; private static final DateFormat GSON_DATE_FORMAT; static { ISO_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'"); ISO_DATE_FORMAT.setTimeZone(TimeZone.getTimeZone("Zulu")); GSON_DATE_FORMAT = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT); GSON_DATE_FORMAT.setTimeZone(TimeZone.getDefault()); } private DateTypeAdapter() { } public synchronized JsonElement serialize(final Date date, final Type type, final JsonSerializationContext jsonSerializationContext) { return new JsonPrimitive(ISO_DATE_FORMAT.format(date)); } public synchronized Date deserialize(final JsonElement jsonElement, final Type type, final JsonDeserializationContext jsonDeserializationContext) { try { return ISO_DATE_FORMAT.parse(jsonElement.getAsString()); } catch (ParseException e) { /* noop */ } // for backwards compatibility try { return GSON_DATE_FORMAT.parse(jsonElement.getAsString()); } catch (ParseException e) { LOGGER.debug("unable to parse stored json Date.class timestamp '" + jsonElement.getAsString() + "' error: " + e.getMessage()); throw new JsonParseException(e); } } } /** * GsonSerializer that stores instants in ISO 8601 format, with a deserialier that also reads local-platform format reading. */ private static class InstantTypeAdapter implements JsonSerializer<Instant>, JsonDeserializer<Instant> { private static final DateFormat ISO_DATE_FORMAT; private static final DateFormat GSON_DATE_FORMAT; static { ISO_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'"); ISO_DATE_FORMAT.setTimeZone(TimeZone.getTimeZone("Zulu")); GSON_DATE_FORMAT = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT); GSON_DATE_FORMAT.setTimeZone(TimeZone.getDefault()); } private InstantTypeAdapter() { } public synchronized JsonElement serialize(final Instant instant, final Type type, final JsonSerializationContext jsonSerializationContext) { return new JsonPrimitive(instant.toString()); } public synchronized Instant deserialize(final JsonElement jsonElement, final Type type, final JsonDeserializationContext jsonDeserializationContext) { try { return Instant.parse(jsonElement.getAsString()); } catch (Exception e) { LOGGER.debug("unable to parse stored json Instant.class timestamp '" + jsonElement.getAsString() + "' error: " + e.getMessage()); throw new JsonParseException(e); } } } private static class ByteArrayToBase64TypeAdapter implements JsonSerializer<byte[]>, JsonDeserializer<byte[]> { public byte[] deserialize(final JsonElement json, final Type typeOfT, final JsonDeserializationContext context) throws JsonParseException { try { return StringUtil.base64Decode(json.getAsString()); } catch (IOException e) { final String errorMsg = "io stream error while de-serializing byte array: " + e.getMessage(); LOGGER.error(errorMsg); throw new JsonParseException(errorMsg, e); } } public JsonElement serialize(final byte[] src, final Type typeOfSrc, final JsonSerializationContext context) { try { return new JsonPrimitive(StringUtil.base64Encode(src, StringUtil.Base64Options.GZIP)); } catch (IOException e) { final String errorMsg = "io stream error while serializing byte array: " + e.getMessage(); LOGGER.error(errorMsg); throw new JsonParseException(errorMsg, e); } } } private static class PasswordDataTypeAdapter implements JsonSerializer<PasswordData>, JsonDeserializer<PasswordData> { public PasswordData deserialize(final JsonElement json, final Type typeOfT, final JsonDeserializationContext context) throws JsonParseException { try { return new PasswordData(json.getAsString()); } catch (PwmUnrecoverableException e) { final String errorMsg = "error while deserializing password data: " + e.getMessage(); LOGGER.error(errorMsg); throw new JsonParseException(errorMsg, e); } } public JsonElement serialize(final PasswordData src, final Type typeOfSrc, final JsonSerializationContext context) { try { return new JsonPrimitive(src.getStringValue()); } catch (PwmUnrecoverableException e) { final String errorMsg = "error while serializing password data: " + e.getMessage(); LOGGER.error(errorMsg); throw new JsonParseException(errorMsg, e); } } } private static GsonBuilder registerTypeAdapters(final GsonBuilder gsonBuilder) { gsonBuilder.registerTypeAdapter(Date.class, new DateTypeAdapter()); gsonBuilder.registerTypeAdapter(Instant.class, new InstantTypeAdapter()); gsonBuilder.registerTypeAdapter(X509Certificate.class, new X509CertificateAdapter()); gsonBuilder.registerTypeAdapter(byte[].class, new ByteArrayToBase64TypeAdapter()); gsonBuilder.registerTypeAdapter(PasswordData.class, new PasswordDataTypeAdapter()); return gsonBuilder; } public static <T> T cloneUsingJson(final Serializable srcObject, final Class<T> classOfT) { final String asJson = JsonUtil.serialize(srcObject); return JsonUtil.deserialize(asJson, classOfT); } }