ObjectSerializer.java

/*
** Module   : ObjectSerializer.java
** Abstract : A serializer and parser which always uses the Jackson default object mapper to (de)serialize.
**
** Copyright (c) 2022-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20220420 Created initial version.
**     CA  20220718 Fixed to use jackson as the default serializer.
** 002 TJD 20240123 Java 17 compatibility updates
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.rest.serializers;

import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.node.*;
import com.goldencode.p2j.rest.*;
import java.lang.reflect.InvocationTargetException;

/**
 * A serializer for {@link Object} parameters.
 * <p>
 * At {@link #fromJson parse}, the string representation of this instance is always returned.
 * <p>
 * At {@link #toJson serialization}, the instance's serializer is obtained via {@link #getSerializer}, and
 * the serialization is delegated to it.
 */
public class ObjectSerializer
extends JavaTypeSerializer<Object>
{
   /** The object mapper to (de)serialize the instance. */
   private final ObjectMapper mapper = new ObjectMapper();

   /**
    * Initialize this serializer with the given type.
    */
   public ObjectSerializer()
   {
      super(Object.class);
   }

   /**
    * Create an initial (default) instance for this serializer.
    * <p>
    * For this serializer, it creates a new instance of that type - a default constructor must be available.
    * 
    * @param    definitionType
    *           The type as it appears at the parameter's definition.
    *           
    * @return   A new instance of this type.
    * @throws SecurityException 
    * @throws NoSuchMethodException 
    * @throws InvocationTargetException 
    * @throws IllegalArgumentException 
    */
   @Override
   public Object initialize(Class<? extends Object> definitionType) 
   throws InstantiationException, 
          IllegalAccessException,
          IllegalArgumentException,
          InvocationTargetException,
          NoSuchMethodException, 
          SecurityException 
   {
      return definitionType.getDeclaredConstructor().newInstance();
   }

   /**
    * Deserializes the JSON representation into a new instance of the argument's type.
    *  
    * @param    arg
    *           The argument (obtained via {@link #initialize}.
    * @param    sval
    *           The string JSON representation of this argument.
    *           
    * @return   The argument instance.
    */
   @Override
   public Object fromJson(Object arg, String sval) 
   throws RequestArgumentError
   {
      try
      {
         return mapper.readValue(sval, arg.getClass());
      }
      catch (JsonProcessingException e)
      {
         throw new RequestArgumentError("Could not populate type:" +  arg.getClass(), e);
      }
   }

   /**
    * Serialize the given instance to JSON, using the {@link #mapper}.
    * 
    * @param    val
    *           The instance to serialize.
    *           
    * @return   The JSON representation of this instance.
    */
   @Override
   public JsonNode toJson(Object val)
   {
      if (val == null)
      {
         return JsonNodeFactory.instance.nullNode();
      }

      return mapper.valueToTree(val);
   }
}