LegacyArgumentsParser.java
/*
** Module : LegacyArgumentsParser.java
** Abstract : An implementation of argument parser of a legacy REST API call.
**
** 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 java.lang.reflect.*;
import javax.servlet.http.*;
import com.goldencode.p2j.directory.*;
import com.goldencode.p2j.persist.*;
import com.goldencode.p2j.util.*;
/**
* A parser for legacy service arguments. This is used for legacy REST, SOAP and WebHandler services.
*/
public class LegacyArgumentsParser
extends ArgumentsParser
{
/**
* Create a new instance.
*
* @param serviceParser
* The main parser used to interpret the arguments for this service call, from the REST request.
*/
public LegacyArgumentsParser(ServiceArgumentsParser serviceParser)
{
super(serviceParser);
}
/**
* Initialize this argument.
*
* @param lsp
* The parameter as it appears at the method's signature.
* @param serviceParameters
* The method's service parameters.
* @param i
* The parameter's index, at the method's definition.
*
* @return The initialized argument.
*/
@Override
public Object initArgument(LegacyServiceParameter lsp,
LegacyServiceParameter[] serviceParameters,
int i)
{
Object arg = null;
String ptype = lsp.type();
Class<?> cls = BaseDataType.fromTypeName(ptype);
if (cls == memptr.class)
{
arg = new MemoryBuffer();
}
else if ("TABLE".equalsIgnoreCase(ptype))
{
if (lsp.output() && !lsp.input())
{
String tname = lsp.name();
for (LegacyServiceParameter param : serviceParameters)
{
if (param.ordinal() - 1 == i)
{
tname = param.name();
break;
}
}
TableWrapper wrapper = serviceParser.createTable(tname, lsp.input(), lsp.output(), false);
arg = wrapper != null ? wrapper : new TableWrapper();
}
}
else if ("DATASET".equalsIgnoreCase(ptype))
{
if (lsp.output() && !lsp.input())
{
String dsname = lsp.name();
for (LegacyServiceParameter param : serviceParameters)
{
if (param.ordinal() - 1 == i)
{
dsname = param.name();
break;
}
}
DatasetWrapper wrapper = serviceParser.createDataset(dsname, lsp.input(), lsp.output(), false);
arg = wrapper != null ? wrapper : new DataSetContainer();
}
}
else
{
if ("HANDLE".equalsIgnoreCase(ptype))
{
boolean isDataSetHandle = false;
boolean isTableHandle = false;
for (LegacyServiceParameter param : serviceParameters)
{
if (param.ordinal() - 1 == i)
{
isDataSetHandle = "DATASET-HANDLE".equalsIgnoreCase(param.type());
isTableHandle = "TABLE-HANDLE".equalsIgnoreCase(param.type());
break;
}
}
if (isDataSetHandle)
{
if (lsp.output() && !lsp.input())
{
DatasetWrapper wrapper = serviceParser.createDataset(lsp.name(), lsp.input(), lsp.output(), true);
arg = wrapper != null ? wrapper : new DataSetContainer();
}
return arg;
}
if (isTableHandle)
{
if (lsp.output() && !lsp.input())
{
TableWrapper wrapper = serviceParser.createTable(lsp.name(), lsp.input(), lsp.output(), true);
arg = wrapper != null ? wrapper : new TableWrapper();
}
return arg;
}
}
BaseDataType bdt = serviceParser.unknownInstance(ptype);
arg = bdt;
if (lsp.output() && lsp.extent() != SourceNameMapper.NO_EXTENT)
{
int length = lsp.extent() == SourceNameMapper.DYNAMIC_EXTENT ? 0 : lsp.extent();
arg = Array.newInstance(bdt.getClass(), length);
for (int j = 0; j < length; j++)
{
Array.set(arg, j, bdt.duplicate());
}
}
}
return arg;
}
/**
* Parse the argument's value from the request.
*
* @param lsp
* The parameter as it appears at the method's service signature.
* @param original
* The original method's parameters.
* @param arg
* The initialized argument.
* @param i
* The parameter's index at the method's service signature.
* @param body
* The request body.
* @param request
* The request payload.
*
* @return The parsed argument.
*/
@Override
public Object parseArgument(LegacyServiceParameter lsp,
LegacyServiceParameter[] original,
Object arg,
int i,
String body,
HttpServletRequest request)
throws IOException,
RequestArgumentError
{
String ptype = lsp.type();
int idx = lsp.ordinal() - 1;
LegacyServiceParameter olsp = original[idx];
if (olsp.extent() != SourceNameMapper.NO_EXTENT)
{
return serviceParser.parseExtentArgument(body, request, idx, lsp.source(), olsp.type(), olsp.extent());
}
String sval = serviceParser.parseArgumentInt(body, lsp.source(), request);
if ("TABLE".equalsIgnoreCase(ptype))
{
return serviceParser.loadTable(sval);
}
if ("TABLE-HANDLE".equalsIgnoreCase(ptype))
{
TableWrapper wrapper = serviceParser.loadTable(sval);
wrapper.setTableHandle(true);
return wrapper;
}
if ("DATASET".equalsIgnoreCase(ptype))
{
return serviceParser.loadDataSet(sval);
}
if ("DATASET-HANDLE".equalsIgnoreCase(ptype))
{
DatasetWrapper wrapper = serviceParser.loadDataSet(sval);
wrapper.setDatasetHandle(true);
return wrapper;
}
if (arg instanceof MemoryBuffer)
{
((MemoryBuffer) arg).setValue(Base64.safeBase64ToByteArray(sval));
return arg;
}
BaseDataType bdt = (BaseDataType) arg;
if (sval == null)
{
bdt.setUnknown();
}
else
{
try
{
serviceParser.assignArgument(i, bdt, sval);
}
catch (RequestArgumentError e)
{
throw e;
}
catch (Throwable t)
{
serviceParser.notAValue(bdt, sval);
// don't return anything, notAValue will throw RequestArgumentError
}
}
return arg;
}
}