JsonBodyWriter.java
/*
** Module : JsonBodyWriter.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 IAS 20190923 First version.
** 002 MP 20200611 Added missing methods as stubs taken by converting the skeleton using FWD.
** 003 CA 20210113 Renamed Iiterator.next to Iiterator.next_, to follow NameConverter's rules.
** Renamed clear() to clear_(), to follow NameConverter's rules.
** 004 ME 20210210 Fix/extend implementation as of OE12.2.
** 005 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
** signature.
** 006 ME 20210324 Moved legacy error serialization in JsonExport.
** VVT 20210917 Javadoc fixed.
** VVT 20221003 CommonHandle.getResourceType() method renamed to resourceType() to prevent conflicts
** with namesakes in DMO. See #6694.
** 007 CA 20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
** dropped if is a no-op.
*/
/*
** 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.oo.net.http.filter.payload;
import static com.goldencode.p2j.util.BlockManager.externalProcedure;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.function;
import static com.goldencode.p2j.util.BlockManager.internalProcedure;
import static com.goldencode.p2j.util.BlockManager.onBlockLevel;
import static com.goldencode.p2j.util.BlockManager.returnNormal;
import static com.goldencode.p2j.util.BlockManager.undoThrow;
import com.goldencode.p2j.oo.common.support.IcharacterHolder;
import com.goldencode.p2j.oo.common.support.IhandleHolder;
import com.goldencode.p2j.oo.common.support.IlongcharHolder;
import com.goldencode.p2j.oo.common.support.ImemptrHolder;
import com.goldencode.p2j.oo.core.*;
import com.goldencode.p2j.oo.core.collections.Icollection;
import com.goldencode.p2j.oo.core.collections.Iiterator;
import com.goldencode.p2j.oo.core.collections.Imap;
import com.goldencode.p2j.oo.core.collections.LegacyMapEntry;
import com.goldencode.p2j.oo.io.*;
import com.goldencode.p2j.oo.json.objectmodel.*;
import com.goldencode.p2j.oo.lang.*;
import com.goldencode.p2j.persist.TargetData;
import com.goldencode.p2j.persist.serial.JsonExport;
import com.goldencode.p2j.persist.serial.Serializator;
import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.BlockManager.Action;
import com.goldencode.p2j.util.BlockManager.Condition;
import com.goldencode.p2j.util.InternalEntry.*;
/**
*
* Write application/json body.
*
*/
@LegacyResource(resource = "OpenEdge.Net.HTTP.Filter.Payload.JsonBodyWriter")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_PARTIAL)
public class JsonBodyWriter
extends com.goldencode.p2j.oo.net.http.filter.payload.MessageWriter
{
/**
* Execute
*/
@LegacySignature(type = Type.EXECUTE)
public void __net_http_filter_payload_JsonBodyWriter_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
/**
* Constructor
*/
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void __net_http_filter_payload_JsonBodyWriter_constructor__()
{
internalProcedure(this, "__net_http_filter_payload_JsonBodyWriter_constructor__",
new Block((Body) () ->
{
__net_http_filter_payload_MessageWriter_constructor__(
ObjectOps.getLegacyClass(ByteBucket.class));
}));
}
/**
* Opens the writer for output.
*/
@LegacySignature(type = Type.METHOD, name = "Open")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
@Override
public void open()
{
internalProcedure(this, "Open", new Block((Body) () ->
{
if (!entity._isValid())
{
entity.assign(ByteBucket.instance());
}
super.open();
}));
}
@LegacySignature(returns = "INT64", type = Type.METHOD, name = "Write", parameters =
{
@LegacyParameter(name = "phData", type = "HANDLE", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
@Override
public int64 write(final handle _phData)
{
handle phData = TypeFactory.initInput(_phData);
memptr mResult = TypeFactory.memptr();
return function(JsonBodyWriter.class, this, "Write", int64.class, new Block((Body) () ->
{
if (phData._isValid())
{
if (phData.isType("TEMP-TABLE") || phData.isType("DATASET") || phData.isType("BUFFER"))
{
long now = System.currentTimeMillis();
phData.unwrapJsonData().writeJson(new TargetData(Serializator.TYPE_MEMPTR, mResult), SessionUtils.isDebugAlert());
getLogger().ref().trace(TextOps.substitute("WRITE-JSON took &1ms", System.currentTimeMillis() - now));
bucket().putBytes(mResult);
returnNormal(mResult.length());
}
else
{
String errMsg = "Unsupported handle type: " + phData.unwrapType().resourceType().getValue();
undoThrow(AppError.newInstance(errMsg, 0));
}
}
else
{
bucket().clear_();
returnNormal(write(new longchar("null")));
}
}, (Fini) () -> {
mResult.setLength(0);
}));
}
/**
* Write data to/from the entity
*
* @param _pData data to be written
*
* @return number of bytes written
*/
@LegacySignature(returns = "INT64", type = Type.METHOD, name = "Write", parameters =
{
@LegacyParameter(name = "pData", type = "LONGCHAR", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
@Override
public int64 write(longchar _pData)
{
longchar pData = TypeFactory.initInput(_pData);
return function(this, "Write", int64.class, new Block((Body) () ->
{
bucket().putString(pData);
returnNormal(TextOps.byteLength(pData));
}));
}
/**
* Write data to/from the entity
*
* @param pData data to be written
*
* @return number of bytes written
*/
@LegacySignature(returns = "INT64", type = Type.METHOD, name = "Write", parameters =
{
@LegacyParameter(name = "pData", type = "MEMPTR", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
@Override
public int64 write(memptr pData)
{
return function(this, "Write", int64.class, new Block((Body) () ->
{
bucket().putBytes(pData.getPointerValue(), pData.length());
returnNormal(pData.length());
}));
}
@LegacySignature(returns = "INT64", type = Type.METHOD, name = "WriteHandle", parameters =
{
@LegacyParameter(name = "phData", type = "HANDLE", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public int64 writeHandle(final handle _phData)
{
handle phData = TypeFactory.initInput(_phData);
return function(JsonBodyWriter.class, this, "WriteHandle", int64.class, new Block((Body) () ->
{
returnNormal(this.write(phData));
}));
}
/**
* Write data to/from the entity
*
* @param poData data to be written
*
* @return number of bytes written
*/
@LegacySignature(returns = "INT64", type = Type.METHOD, name = "Write", parameters =
{
@LegacyParameter(name = "poData", type = "OBJECT",
qualified = "progress.lang.object", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_PARTIAL)
@Override
public int64 write(object<? extends _BaseObject_> poData)
{
memptr mptr = TypeFactory.memptr();
return function(this, "Write", int64.class, new Block((Body) () ->
{
if (!poData._isValid())
{
bucket().clear_();
returnNormal(write(new longchar("Null")));
}
else if (ObjectOps.typeOf(poData, LegacyError.class).booleanValue())
{
returnNormal(write(JsonExport.serializeError(ObjectOps.cast(poData, LegacyError.class))));
}
else if (ObjectOps.typeOf(poData, IcharacterHolder.class).booleanValue())
{
object<? extends IcharacterHolder> oICharHolder = ObjectOps.cast(poData, IcharacterHolder.class);
returnNormal(write(new longchar(oICharHolder.ref().getValue())));
}
else if (ObjectOps.typeOf(poData, IlongcharHolder.class).booleanValue())
{
object<? extends IlongcharHolder> oLongcharH = ObjectOps.cast(poData, IlongcharHolder.class);
returnNormal(write(oLongcharH.ref().getValue()));
}
else if (ObjectOps.typeOf(poData, FileInputStream.class).booleanValue())
{
object<? extends FileInputStream> fis = ObjectOps.cast(poData, FileInputStream.class);
String[] result = TextOps.splitInt(fis.ref().getFileName().getValue(), '.');
if (result[result.length - 1].equalsIgnoreCase("json"))
{
returnNormal(this.writeFileStream(fis));
}
String msg = String.format("Unsupported file extension .%s for JSON", result[result.length - 1]);
undoThrow(AppError.newInstance(msg, 0));
}
else if (ObjectOps.typeOf(poData, IhandleHolder.class).booleanValue())
{
object<? extends IhandleHolder> oHandleHolder = ObjectOps.cast(poData, IhandleHolder.class);
handle hdl = oHandleHolder.ref().getValue();
returnNormal(this.write(hdl));
}
else if (ObjectOps.typeOf(poData, ImemptrHolder.class).booleanValue())
{
object<? extends ImemptrHolder> oIMemptr = ObjectOps.cast(poData, ImemptrHolder.class);
mptr.assign(oIMemptr.ref().getValue());
returnNormal(this.write(mptr));
}
else if (ObjectOps.typeOf(poData, Imap.class).booleanValue())
{
object<? extends JsonObject> oJsonObj = ObjectOps.newInstance(JsonObject.class);
object<? extends Imap> oMap = ObjectOps.cast(poData, Imap.class);
object<? extends Iiterator> oIterator = oMap.ref().getEntrySet().ref().iterator();
while (oIterator.ref().hasNext().booleanValue())
{
object<? extends LegacyMapEntry> oMapEntry = ObjectOps.cast(oIterator.ref().next_(), LegacyMapEntry.class);
object<? extends _BaseObject_> oKey = oMapEntry.ref().getKey();
object<? extends _BaseObject_> oVal = oMapEntry.ref().getValue();
// TODO: value should be converted to something more than strings...
if (oKey._isValid())
{
if (oVal._isValid())
{
oJsonObj.ref().add(oKey.ref().toLegacyString(), oVal.ref().toLegacyString());
}
else
{
oJsonObj.ref().addNull(oKey.ref().toLegacyString());
}
}
}
returnNormal(this.write(oJsonObj));
}
else if (ObjectOps.typeOf(poData, Icollection.class).booleanValue())
{
object<? extends JsonArray> oJson = ObjectOps.newInstance(JsonArray.class);
object<? extends Icollection> oCol = ObjectOps.cast(poData, Icollection.class);
object<? extends Iiterator> oIterator = oCol.ref().iterator();
while (oIterator.ref().hasNext().booleanValue())
{
object<? extends _BaseObject_> item = oIterator.ref().next_();
if (item._isValid())
{
oJson.ref().add(item.ref().toLegacyString());
}
else
{
oJson.ref().addNull();
}
}
returnNormal(this.write(oJson));
}
else if (ObjectOps.typeOf(poData, JsonConstruct.class).booleanValue())
{
object<? extends JsonConstruct> oJsonConstr = ObjectOps.cast(poData, JsonConstruct.class);
oJsonConstr.ref().write(mptr);
returnNormal(write(mptr));
}
else
{
String msg = String.format("JsonBodyWriter cannot convert object type %s to JSON",
poData.ref().getLegacyClass().ref().getTypeName().toStringMessage());
undoThrow(AppError.newInstance(msg, 0));
}
}, (Fini) () -> {
mptr.setLength(0);
}));
}
/**
* Write data to/from the object array
*
* @param poData data to be written
*
* @return number of bytes written
*/
@LegacySignature(returns = "INT64", type = Type.METHOD, name = "Write", parameters =
{
@LegacyParameter(name = "poData", type = "OBJECT",
qualified = "progress.lang.object", extent = -1, mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public int64 write(object<? extends _BaseObject_>[] poData)
{
return function(this, "Write", int64.class, new Block((Body) () -> {
if (poData.length == 0)
{
returnNormal(write(new object()));
}
else
{
object<? extends JsonArray> oJson = ObjectOps.newInstance(JsonArray.class);
for (int i = 0; i < poData.length; i++)
{
if (poData[i]._isValid())
{
oJson.ref().add(poData[i].ref().toLegacyString());
}
else
{
oJson.ref().addNull();
}
}
returnNormal(write(oJson));
}
}));
}
}