LegacySocketLibraryBuilder.java
/*
** Module : ABLSocketLibraryBuilder.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 IAS 20190527 Got rid of "abl" in names
** 003 CA 20191024 Added method support levels and updated the class support level.
** 004 MP 20200525 Added constructor and execute method.
** 005 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
** signature.
** ME 20210402 Added annotations, update support levels.
** ME 20210929 Fix return value on createClientSocket, buildSocketConnectionParams.
** 006 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.lib.sockets;
import com.goldencode.p2j.oo.core.Assert;
import com.goldencode.p2j.oo.core.ISupportInitialize;
import com.goldencode.p2j.oo.lang.LegacyClass;
import com.goldencode.p2j.oo.logging.ISupportLogging;
import com.goldencode.p2j.oo.logging.IlogWriter;
import com.goldencode.p2j.oo.net.http.ClientOptions;
import com.goldencode.p2j.oo.net.http.IHttpClientLibrary;
import com.goldencode.p2j.oo.net.http.lib.*;
import com.goldencode.p2j.oo.net.serverconnection.ClientSocket;
import com.goldencode.p2j.oo.net.serverconnection.ClientSocketConnectionParameters;
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.Type;
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;
/**
*
* Build socket library.
*
*/
@LegacyResource(resource = "OpenEdge.Net.HTTP.Lib.ABLSockets.ABLSocketLibraryBuilder")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public class LegacySocketLibraryBuilder extends ClientLibraryBuilder
{
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.IHttpClientLibrary", type = Type.GETTER, name = "Library")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
@Override
public object<? extends IHttpClientLibrary> getLibrary()
{
return function(LegacySocketLibraryBuilder.class, this, "Library", object.class,
new Block((Body) () ->
{
returnNormal(newLibrary());
}));
}
private object<? extends IHttpClientLibrary> newLibrary()
{
object<? extends IHttpClientLibrary> oLib = TypeFactory.object(IHttpClientLibrary.class);
return function(this, "newLibrary", object.class, new Block((Body) () ->
{
object<? extends LegacyClass> oLibType = ObjectOps.newInstance(LegacyClass.class);
object<? extends ClientSocket> oSocket = ObjectOps.newInstance(ClientSocket.class);
object<? extends ClientSocketConnectionParameters> oParams = ObjectOps.newInstance(ClientSocketConnectionParameters.class);
object<? extends ClientOptions> oOptions = ObjectOps.newInstance(ClientOptions.class);
character iLogWrtTypName = new character(ObjectOps.getLegacyName(IlogWriter.class));
oLibType.assign(ClientLibraryBuilder.getRegistry().ref()._get(ObjectOps.getLegacyName(IHttpClientLibrary.class)));
Assert.isType(oLibType, ObjectOps.getLegacyClass(LegacySocketLibrary.class));
oSocket.assign(createClientSocket());
oParams.assign(buildSocketConnectionParams());
if (_hasOption("requestTimeout"))
{
oOptions.ref().setRequestTimeout(getOptionNumericValue(new character("requestTimeout")));
}
oLib.assign(ObjectOps.newInstance(oLibType.ref().getType(),
"IIIII",
new character("Lib-ABLSockets"),
new character("0.5.0"),
oSocket,
oParams,
oOptions));
if (oLib._isValid()) {
if (oLib.ref() instanceof ISupportLogging && hasOption(iLogWrtTypName).booleanValue())
{
object<? extends IlogWriter> logger = (object<? extends IlogWriter>) getOptionObjectValue(iLogWrtTypName);
((ISupportLogging) oLib.ref()).setLogger(logger);
}
if (oLib.ref() instanceof ISupportInitialize)
{
((ISupportInitialize) oLib.ref()).initialize();
}
}
returnNormal(oLib);
}));
}
/**
* Creates socket wrapper/holder class, based on the config
*/
@LegacySignature(type = Type.METHOD, name = "CreateClientSocket", returns = "OBJECT", qualified = "OpenEdge.Net.ServerConnection.ClientSocket")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
protected object<? extends ClientSocket> createClientSocket()
{
object<? extends ClientSocket> clSocket = TypeFactory.object(ClientSocket.class);
return function(this, "CreateClientSocket", object.class, new Block((Body) () ->
{
clSocket.assign(ObjectOps.newInstance(ClientSocket.class));
character clSTypName = new character(ObjectOps.getLegacyName(ClientSocket.class));
character iLogWrtTypName = new character(ObjectOps.getLegacyName(IlogWriter.class));
if (hasOption(clSTypName).booleanValue())
{
clSocket.assign((ClientSocket) getOptionObjectValue(clSTypName).ref());
}
else
{
if ((clSocket.ref() instanceof ISupportLogging) && hasOption(iLogWrtTypName).booleanValue())
{
object<? extends IlogWriter> logger = (object<? extends IlogWriter>) getOptionObjectValue(iLogWrtTypName);
((ISupportLogging) clSocket.ref()).setLogger(logger);
}
if (clSocket.ref() instanceof ISupportInitialize)
{
((ISupportInitialize) clSocket.ref()).initialize();
}
}
returnNormal(clSocket);
}));
}
/**
* Builds the connection parameter from the config options.
*/
@LegacySignature(type = Type.METHOD, name = "BuildSocketConnectionParams", returns = "OBJECT", qualified = "OpenEdge.Net.ServerConnection.ClientSocketConnectionParameters")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
protected object<? extends ClientSocketConnectionParameters> buildSocketConnectionParams()
{
object<? extends ClientSocketConnectionParameters> clSocketConnParam = TypeFactory.object(ClientSocketConnectionParameters.class);
return function(this, "BuildSocketConnectionParams", object.class, new Block((Body) () ->
{
clSocketConnParam.assign(ObjectOps.newInstance(ClientSocketConnectionParameters.class));
character clSockConnParamTypName = new character("OpenEdge.Net.ServerConnection.ClientSocketConnectionParameters");
if (hasOption(clSockConnParamTypName).booleanValue())
{
clSocketConnParam.assign((ClientSocketConnectionParameters) getOptionObjectValue(clSockConnParamTypName).ref());
}
else
{
if (hasOption(getPropSslHostverify()).booleanValue())
{
clSocketConnParam.ref().setVerifyHost(getOptionLogicalValue(getPropSslHostverify()));
}
if (hasOption(getPropReusesession()).booleanValue())
{
clSocketConnParam.ref().setReuseSession(getOptionLogicalValue(getPropReusesession()));
}
if (hasOption(getPropSslProtocols()).booleanValue())
{
clSocketConnParam.ref().setSslProtocols(getOptionStringArrayValue(getPropSslProtocols()));
}
if (hasOption(getPropSslCiphers()).booleanValue())
{
clSocketConnParam.ref().setSslCiphers(getOptionStringArrayValue(getPropSslCiphers()));
}
if (hasOption(getPropServername()).booleanValue())
{
clSocketConnParam.ref().setServerNameIndicator(getOptionStringValue(getPropServername()));
}
if (clSocketConnParam instanceof ISupportInitialize)
{
((ISupportInitialize) clSocketConnParam).initialize();
}
}
returnNormal(clSocketConnParam);
}));
}
/**
* Constructor
*/
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void __net_http_lib_sockets_LegacySocketLibraryBuilder_constructor__()
{
internalProcedure(this, "__net_http_lib_ablsockets_ABLSocketLibraryBuilder_constructor__", new Block((Body) () ->
{
__net_http_lib_ClientLibraryBuilder_constructor__();
}));
}
/**
* Execute method
*/
@LegacySignature(type = Type.EXECUTE)
public void __net_http_lib_sockets_LegacySocketLibraryBuilder_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
}