LegacyArgumentsSerializer.java

/*
** Module   : LegacyArgumentsSerializer.java
** Abstract : A serializer for the response of legacy REST services.
**
** Copyright (c) 2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20220323 Created initial version.
*/
/*
** 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;

import java.io.*;

import javax.servlet.http.*;
import javax.xml.bind.*;

import com.goldencode.p2j.persist.*;
import com.goldencode.p2j.util.*;

/**
 * A serializer for legacy service arguments.  This is used for legacy REST, SOAP and WebHandler services.
 */
public class LegacyArgumentsSerializer
extends ArgumentsSerializer
{
   /**
    * Create a new instance.
    * 
    * @param    argumentsSerializer
    *           The main serializer used to write the arguments for this service call, to the REST response.
    */
   public LegacyArgumentsSerializer(ResponseArguments argumentsSerializer)
   {
      super(argumentsSerializer);
   }

   /**
    * Serialize this argument's value, considering the target format.
    * 
    * @param    stream
    *           The response stream.
    * @param    target
    *           The argument's encoded target.
    * @param    val
    *           The argument's value.
    * @param    response
    *           The HTTP response.
    */
   @Override
   protected void writeArgument(OutputStream        stream, 
                                String              target, 
                                Object              val, 
                                HttpServletResponse response)
   throws IOException
   {
      if (val == null)
      {
         if (!argumentsSerializer.ignoreUnknown())
         {
            val = new unknown();
         }
         else
         {
            return;
         }
      }
      
      if (val != null && val.getClass().isArray())
      {
         // we have an array...
         argumentsSerializer.writeExtentArgument(stream, target, val, response);
         return;
      }
      
      String sval = null;
      Object oval = null;
      if (val instanceof MemoryBuffer)
      {
         sval = ((MemoryBuffer) val).getValue() == null 
                  ? null 
                  : DatatypeConverter.printBase64Binary(((MemoryBuffer) val).getValue());
      }
      else if (val instanceof TableWrapper)
      {
         oval = argumentsSerializer.writeTable(target, (TableWrapper) val);
         sval = oval.toString();
      }
      else if (val instanceof DataSetContainer)
      {
         oval = argumentsSerializer.writeDataSet(target, (DataSetContainer) val);
         sval = oval.toString();
      }
      else if (val instanceof DatasetWrapper)
      {
         oval = argumentsSerializer.writeDataSet(target, (DatasetWrapper) val);
         sval = oval.toString();
      }
      else if (val instanceof BaseDataType)
      {
         BaseDataType bdt = (BaseDataType) val;
         if (bdt.isUnknown())
         {
            if (!argumentsSerializer.ignoreUnknown())
            {
               argumentsSerializer.writeArgumentInt(stream, target, null, null, response);
            }
            
            return;
         }

         sval = argumentsSerializer.toString(bdt);
      }
      else
      {
         sval = val.toString();
      }
      
      argumentsSerializer.writeArgumentInt(stream, target, sval, oval == null ? sval : oval, response);
   }
}