MessageWriter.java
/*
** Module : MessageWriter.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA 20190526 First version, stubs taken by converting the skeleton using FWD.
** 002 CA 20191024 Added method support levels and updated the class support level.
** 003 ME 20200415 Instantiate logger as needed to avoid invalid handle errors, fix error handling/reporting.
** 20201208 Fix entity get/set signature, implement log methods.
** 20210204 Allocate memory when reading from file input stream.
** 004 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
** 005 ME 20210310 Use initInput in setter methods to avoid issue with 'invalid' object when value is
** directly returned by a method.
** VVT 20210917 Javadoc fixed, missing @Override annotations added.
** ME 20210929 Fix function block for some methods.
** 006 CA 20230817 Removed ObjectOps.register, as this registration is handled by runtime.
** 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.core.*;
import com.goldencode.p2j.oo.io.*;
import com.goldencode.p2j.oo.lang.*;
import com.goldencode.p2j.oo.logging.*;
import com.goldencode.p2j.oo.logging.LogLevelEnum;
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.*;
/**
*
* Writes content into an object, like
* a JsonObject or String or Memptr or ByteBucket
*
*/
@LegacyResource(resource = "OpenEdge.Net.HTTP.Filter.Payload.MessageWriter")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public abstract class MessageWriter
extends OutputStream
implements ISupportLogging
{
/** Logger */
protected final object<? extends IlogWriter> logger = TypeFactory.object(IlogWriter.class);
/** Entity type */
protected final object<? extends LegacyClass> entityType = TypeFactory.object(LegacyClass.class);
/** Entity */
protected final object<? extends _BaseObject_> entity = TypeFactory.object(BaseObject.class);
/**
* Get logger.
*
* @return logger.
*/
@Override
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Logging.ILogWriter", type = Type.GETTER, name = "Logger")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public object<? extends IlogWriter> getLogger()
{
return function(this, "Logger", object.class, new Block((Body) () ->
{
// TODO: 4Gl uses the LoggerBuilder, change when available
if (logger.isUnknown())
logger.assign(ObjectOps.newInstance(VoidLogger.class, "I", ObjectOps.getLegacyName(this.getClass())));
returnNormal(logger);
}));
}
/**
* Set logger.
*
* @param _poLogger logger.
*/
@Override
@LegacySignature(type = Type.SETTER, name = "Logger", parameters =
{
@LegacyParameter(name = "poLogger", type = "OBJECT",
qualified = "OpenEdge.Logging.ILogWriter", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void setLogger(object<? extends IlogWriter> _poLogger)
{
object<? extends IlogWriter> poLogger = TypeFactory.initInput(_poLogger);
internalProcedure(this, "Logger", new Block((Body) () ->
{
this.logger.assign(poLogger);
}));
}
/**
* Get entity type.
*
* @return entity type.
*/
@LegacySignature(returns = "OBJECT", qualified = "Progress.Lang.Class", type = Type.GETTER, name = "EntityType")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public object<? extends LegacyClass> getEntityType()
{
return function(this, "EntityType", object.class, new Block((Body) () ->
{
returnNormal(entityType);
}));
}
/**
* Get entity.
*
* @return entity.
*/
@LegacySignature(returns = "OBJECT", qualified = "Progress.Lang.Object", type = Type.GETTER, name = "Entity")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public object<? extends BaseObject> getEntity()
{
return function(this, "Entity", object.class, new Block((Body) () ->
{
returnNormal(entity);
}));
}
/**
* Set entity.
*
* @param _poEntity entity.
*/
@LegacySignature(type = Type.SETTER, name = "Entity", parameters =
{
@LegacyParameter(name = "Entity", type = "OBJECT",
qualified = "Progress.Lang.Object", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void setEntity(object<? extends _BaseObject_> _poEntity)
{
object<? extends _BaseObject_> poEntity = TypeFactory.initInput(_poEntity);
internalProcedure(this, "Entity", new Block((Body) () ->
{
Assert.isType(poEntity, entityType);
this.entity.assign(poEntity);
}));
}
/**
* Execute method
*/
@LegacySignature(type = Type.EXECUTE)
public void __net_http_filter_payload_MessageWriter_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
/**
* Constructor
*
* @param _poType entity type
*/
@LegacySignature(type = Type.CONSTRUCTOR, parameters =
{
@LegacyParameter(name = "poType", type = "OBJECT",
qualified = "progress.lang.class", mode = "INPUT"),
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void __net_http_filter_payload_MessageWriter_constructor__(
object<? extends LegacyClass> _poType)
{
object<? extends LegacyClass> poType = TypeFactory.initInput(_poType);
internalProcedure(this, "__net_http_BuilderRegistry_constructor__", new Block((Body) () ->
{
__io_OutputStream_constructor__();
assertNotNull(poType, "Entity type");
this.entityType.assign(poType);
}));
}
/**
* Constructor.
*
* @param _poType entity type.
* @param _poEntity entity.
*/
@LegacySignature(type = Type.CONSTRUCTOR, parameters =
{
@LegacyParameter(name = "poType", type = "OBJECT",
qualified = "progress.lang.class", mode = "INPUT"),
@LegacyParameter(name = "poEntity", type = "OBJECT",
qualified = "progress.lang.object", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void __net_http_filter_payload_MessageWriter_constructor__(
object<? extends LegacyClass> _poType,
object<? extends _BaseObject_> _poEntity)
{
object<? extends LegacyClass> poType = TypeFactory.initInput(_poType);
object<? extends _BaseObject_> poEntity = TypeFactory.initInput(_poEntity);
internalProcedure(this, "__net_http_BuilderRegistry_constructor__", new Block((Body) () ->
{
__net_http_filter_payload_MessageWriter_constructor__(poType);
assertNotNull(poEntity, "Entity");
setEntity(poEntity);
}));
}
/**
* 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_FULL)
public abstract int64 write(object<? extends _BaseObject_> _poData);
/**
* Opens the writer for output.
*/
@LegacySignature(type = Type.METHOD, name = "Open")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void open()
{
}
/**
* Closes the writer.
*/
@Override
@LegacySignature(type = Type.METHOD, name = "Close")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void close()
{
internalProcedure(this, "Close", new Block((Body)() -> {
flush();
super.close();
}));
}
/**
* Write data to/from the entity
*
* @param _phData data to be written
*
* @return number of bytes written
*/
@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(handle _phData)
{
getLogger().ref().warn(new character("Write(handle) is a no-op"));
return new int64();
}
/**
* 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 = "CHARACTER", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
@Override
public int64 write(character _poData)
{
getLogger().ref().warn(new character("Write(character) is a no-op"));
return new int64();
}
/**
* 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 = "LONGCHAR", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
@Override
public int64 write(longchar _poData)
{
getLogger().ref().warn(new character("Write(longchar) is a no-op"));
return new int64();
}
/**
* Write data to/from the entity.
*
* @param _poData data to be written.
* @param _offset data offset.
* @param _length data length.
*
* @return number of bytes written.
*/
@LegacySignature(returns = "INT64", type = Type.METHOD, name = "Write", parameters =
{
@LegacyParameter(name = "poData", type = "MEMPTR", mode = "INPUT"),
@LegacyParameter(name = "offset", type = "INT64", mode = "INPUT"),
@LegacyParameter(name = "length", type = "INT64", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
@Override
public int64 write(memptr _poData, int64 _offset, int64 _length)
{
getLogger().ref().warn(new character("Write(memptr,int64,int64) is a no-op"));
return new int64();
}
/**
* 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 = "MEMPTR", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
@Override
public int64 write(memptr _poData)
{
return function(this, "Write", int64.class, new Block((Body) () ->
{
returnNormal(super.write(_poData));
}));
}
/**
* Log the message
*
* @param pcMessage message
* @param poLoglevel log level
*/
@LegacySignature(type = Type.METHOD, name = "LogMessage", parameters =
{
@LegacyParameter(name = "pcMessage", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "poLoglevel", type = "OBJECT",
qualified = "OpenEdge.Logging.LogLevelEnum", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
protected void logMessage(character pcMessage, object<? extends LogLevelEnum> poLoglevel)
{
internalProcedure(this, "LogMessage", new Block((Body)() -> {
if (poLoglevel._isValid())
{
logMessage (pcMessage, new integer(poLoglevel.ref()._getValue()));
}
else
{
getLogger().ref().warn(pcMessage);
}
}));
}
/**
* Log the message
*
* @param pcMessage message
* @param piLoglevel log level
*/
@LegacySignature(type = Type.METHOD, name = "LogMessage", parameters =
{
@LegacyParameter(name = "pcMessage", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "piLoglevel", type = "INTEGER", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
protected void logMessage(character pcMessage, integer piLoglevel)
{
internalProcedure(this, "LogMessage", new Block((Body)() -> {
long level = piLoglevel.isUnknown() ? LogLevelEnum.warn.ref()._getValue() : piLoglevel.longValue();
if (level == LogLevelEnum.fatal.ref()._getValue())
{
getLogger().ref().fatal(pcMessage);
}
else if (level == LogLevelEnum.error.ref()._getValue())
{
getLogger().ref().error(pcMessage);
}
else if (level == LogLevelEnum.info.ref()._getValue())
{
getLogger().ref().info(pcMessage);
}
else if (level == LogLevelEnum.debug.ref()._getValue())
{
getLogger().ref().debug(pcMessage);
}
else if (level == LogLevelEnum.trace.ref()._getValue())
{
getLogger().ref().trace(pcMessage);
}
else
{
getLogger().ref().warn(pcMessage);
}
}));
}
@LegacySignature(returns = "INT64", type = Type.METHOD, name = "WriteFileStream", parameters =
{
@LegacyParameter(name = "pStream", type = "OBJECT",
qualified = "Progress.IO.FileInputStream", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
protected int64 writeFileStream(object<? extends FileInputStream> _pStream)
{
object<? extends FileInputStream> pStream = TypeFactory.initInput(_pStream);
memptr mPtr = TypeFactory.memptr();
return function(this, "WriteFileStream", int64.class, new Block((Body)() -> {
Assert.notNull(pStream, new character("File input stream"));
FileSystemOps.initFileInfo(pStream.ref().getFileName());
mPtr.setLength(FileSystemOps.fileInfoGetSize());
pStream.ref().read(mPtr);
returnNormal(write(mPtr));
}, (Fini)() -> {
mPtr.setLength(0);
}));
}
/**
* Return entity as ByteBucket
*
* @return entity as ByteBucket
*/
protected ByteBucket bucket()
{
return (ByteBucket) getEntity().ref();
}
/**
* Report unsupported object type error.
*
* @param poData data to be written.
*/
protected void unsupported(object<? extends _BaseObject_> poData)
{
String msg = TextOps.substitute("Unsupported object type: &1",
poData.ref().getLegacyClass().ref().getTypeName()).getValue();
undoThrow(AppError.newInstance(msg, 0));
}
}