HttpClientDecorator.java
/*
** Module : HttpClientDecorator.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 20200603 add constructors and methods like originar class.
** 003 ME 20201023 Implement all methods as pass-through for decorated client.
** 20201103 Fix execute method with only the request parameter.
** CA 20210219 OO input parameter definitions for functions/procedures must not register with ObjectOps
** - TypeFactory.initInput will take care of this.
** 004 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
** 005 ME 20210520 Fixed local variable scope for return parameter.
** 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;
import com.goldencode.p2j.oo.core.Assert;
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.*;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.externalProcedure;
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;
/**
*
* Decorator class for decorating/customizing Http Clients
* without requiring inheritance.
*
*/
@LegacyResource(resource = "OpenEdge.Net.HTTP.HttpClientDecorator")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public abstract class HttpClientDecorator
extends BaseObject
implements IhttpClient
{
@LegacySignature(type = Type.PROPERTY, name = "DecoratedHttpClient")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
private object<? extends com.goldencode.p2j.oo.net.http.IhttpClient> decoratedHttpClient =
TypeFactory.object(com.goldencode.p2j.oo.net.http.IhttpClient.class);
@LegacySignature(type = Type.EXECUTE)
public void __net_http_HttpClientDecorator_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.IHttpClient", type = Type.GETTER, name = "DecoratedHttpClient")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
protected object<? extends com.goldencode.p2j.oo.net.http.IhttpClient> getDecoratedHttpClient()
{
return function(HttpClientDecorator.class, this, "DecoratedHttpClient", object.class, new Block((Body) () ->
{
returnNormal(decoratedHttpClient);
}));
}
@LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "ClientName")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public character getClientName()
{
return function(HttpClientDecorator.class, this, "ClientName", character.class, new Block((Body) () ->
{
returnNormal(decoratedHttpClient.ref().getClientName());
}));
}
@LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "ClientVersion")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public character getClientVersion()
{
return function(HttpClientDecorator.class, this, "ClientVersion", character.class, new Block((Body) () ->
{
returnNormal(decoratedHttpClient.ref().getClientVersion());
}));
}
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.ClientOptions", type = Type.GETTER, name = "Options")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public object<? extends com.goldencode.p2j.oo.net.http.ClientOptions> getOptions()
{
return function(HttpClientDecorator.class, this, "Options", object.class, new Block((Body) () ->
{
returnNormal(decoratedHttpClient.ref().getOptions());
}));
}
@LegacySignature(type = Type.CONSTRUCTOR, parameters =
{
@LegacyParameter(name = "poHttpClient", type = "OBJECT", qualified = "openedge.net.http.ihttpclient", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public void __net_http_HttpClientDecorator_constructor__(final object<? extends com.goldencode.p2j.oo.net.http.IhttpClient> _poHttpClient)
{
object<? extends com.goldencode.p2j.oo.net.http.IhttpClient> poHttpClient = TypeFactory.initInput(_poHttpClient);
internalProcedure(HttpClientDecorator.class, this, "__net_http_HttpClientDecorator_constructor__", new Block((Body) () ->
{
__lang_BaseObject_constructor__();
Assert.notNull(poHttpClient, new character("Http client"));
decoratedHttpClient.assign(poHttpClient);
}));
}
@LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Execute", qualified = "openedge.net.http.ihttpresponse", parameters =
{
@LegacyParameter(name = "poRequest", type = "OBJECT", qualified = "openedge.net.http.ihttprequest", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public object<? extends com.goldencode.p2j.oo.net.http.IhttpResponse> execute(
final object<? extends com.goldencode.p2j.oo.net.http.IhttpRequest> _poRequest)
{
object<? extends IhttpResponse> poResponse = TypeFactory.object(IhttpResponse.class);
return function(HttpClientDecorator.class, this, "Execute", object.class, new Block((Body) () ->
{
poResponse.assign(ResponseBuilder.build().ref().getResponse());
execute(_poRequest, poResponse);
returnNormal(poResponse);
}));
}
@LegacySignature(type = Type.METHOD, name = "Execute", parameters =
{
@LegacyParameter(name = "poRequest", type = "OBJECT", qualified = "openedge.net.http.ihttprequest", mode = "INPUT"),
@LegacyParameter(name = "poResponse", type = "OBJECT", qualified = "openedge.net.http.ihttpresponse", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public void execute(
final object<? extends com.goldencode.p2j.oo.net.http.IhttpRequest> _poRequest,
final object<? extends com.goldencode.p2j.oo.net.http.IhttpResponse> _poResponse)
{
decoratedHttpClient.ref().execute(_poRequest, _poResponse);
}
}