DefaultHeaderBuilder.java
/*
** Module : DefaultHeaderBuilder.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 IAS 20190923 First version.
** 002 ME 20200512 Add header parameters.
** 20201204 Fix function block scope for error handling.
** 003 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
** CA 20220120 Do not used TypeFactory.object when the OO reference must not be tracked or registered.
** Do not use TypeFactory.object for internal usages, use ObjectVar if the reference must
** be tracked.
** All TypeFactory.object variable definitions must be done outside of the top-level block.
** 004 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;
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 com.goldencode.p2j.oo.core.*;
import com.goldencode.p2j.oo.lang.*;
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.*;
/**
*
* Simple, general header builder
*
*/
@LegacyResource(resource = "OpenEdge.Net.HTTP.DefaultHeaderBuilder")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class DefaultHeaderBuilder
extends HttpHeaderBuilder
{
protected static final String HTTP_HEADER = "OpenEdge.Net.HTTP.HttpHeader";
/**
* Execute method.
*/
@LegacySignature(type = Type.EXECUTE)
public void __net_http_DefaultHeaderBuilder_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
/**
* Constructor.
*
* @param _pcHeaderName header name.
*/
@LegacySignature(type = Type.CONSTRUCTOR, parameters =
{
@LegacyParameter(name = "pcHeaderName", type = "CHARACTER", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void __net_http_DefaultHeaderBuilder_constructor__(final character _pcHeaderName)
{
character pcHeaderName = TypeFactory.initInput(_pcHeaderName);
internalProcedure(this, "__net_http_DefaultHeaderBuilder_constructor__",
new Block((Body) () ->
{
__net_http_HttpHeaderBuilder_constructor__(pcHeaderName);
}));
}
/**
* Get the created header.
*
* @return the created header.
*/
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.HttpHeader", type = Type.GETTER, name = "Header")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
@Override
public object<? extends HttpHeader> getHeader()
{
return function(DefaultHeaderBuilder.class, this, "Header", object.class, new Block((Body) () ->
{
if (!this.header._isValid())
{
this.header.assign(newHeader());
}
returnNormal(this.header);
}));
}
/**
* Created the new header.
*
* @return the created header.
*/
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.HttpHeader", type = Type.METHOD, name = "NewHeader")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
protected object<? extends HttpHeader> newHeader()
{
object<? extends HttpHeader> hdr = TypeFactory.object(HttpHeader.class);
object<? extends LegacyClass> hdrType = TypeFactory.object(LegacyClass.class);
return function(DefaultHeaderBuilder.class, this, "NewHeader", object.class,
new Block((Body) () ->
{
if (hasOption(new character(HTTP_HEADER)).booleanValue())
{
hdrType.assign(
ObjectOps.cast(getOptionObjectValue(new character(HTTP_HEADER)),
LegacyClass.class));
}
else
{
hdrType.assign(ObjectOps.getLegacyClass(HttpHeader.class));
}
Assert.isType(hdrType, ObjectOps.getLegacyClass(HttpHeader.class));
hdr.assign(
ObjectOps.newInstance(hdrType.ref().getType(), "I", getHeaderName()));
if (ObjectOps.typeOf(hdr, ISupportInitialize.class).booleanValue())
{
ObjectOps.cast(hdr, ISupportInitialize.class).ref().initialize();
}
if (hasOption(new character("paramDelimiter")).booleanValue())
{
hdr.ref().setParamDelimiter(
getOptionStringValue(new character("paramDelimiter")));
}
if (hasOption(new character("hdrValue")).booleanValue())
{
hdr.ref().setValue(getOptionStringValue(new character("hdrValue")));
}
getParameters().forEach((name, value) ->
{
hdr.ref().setParameterValue(name, value);
});
returnNormal(hdr);
}));
}
}