DefaultHttpClientBuilder.java

/*
** Module   : DefaultHttpClientBuilder.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   20200410 Implement methods as in OE (11.7.4)
**          20201022 Add new protected method newClient (OE 12.2)
** 003 CA   20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
**                   signature.
**     ME   20210929 Fix return object on newClient.
** 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.Assert;
import com.goldencode.p2j.oo.core.ISupportInitialize;
import com.goldencode.p2j.oo.lang.LegacyClass;
import com.goldencode.p2j.oo.logging.*;
import com.goldencode.p2j.oo.net.*;
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.*;

/**
 * 
 * HTTP Client builder
 *
 */
@LegacyResource(resource = "OpenEdge.Net.HTTP.DefaultHttpClientBuilder")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public class DefaultHttpClientBuilder extends ClientBuilder implements ISupportInitialize
{

   /**
    * Destroy.
    */
   @LegacySignature(type = Type.METHOD, name = "Destroy")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   @Override
   public void destroy()
   {
      // NOP
   }

   /**
    * Initialize.
    */
   @LegacySignature(type = Type.METHOD, name = "Initialize")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   @Override
   public void initialize()
   {
      named(new character("OpenEdge-HttpClient"), new character("0.4.0"));
   }

   /**
    * Return a configured client
    * 
    * @return a configured client.
    */
   @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.IHttpClient", type = Type.GETTER, name = "Client")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   @Override
   public object<? extends IhttpClient> getClient()
   {
      return newClient();
   }

   /**
    * NewClient.
    */
   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "NewClient", qualified = "OpenEdge.Net.HTTP.IHttpClient")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   protected object<? extends IhttpClient> newClient()
   {
      object<? extends IhttpClient> client = TypeFactory.object(IhttpClient.class);

      return function(this, "NewClient", object.class, new Block((Body) () -> {
         Assert.isTrue(hasOption(getPropClientName()));
         Assert.isTrue(hasOption(getPropClientVersion()));

         object<? extends LegacyClass> clientType = ClientBuilder.getRegistry().ref()
                  .get(new character(ObjectOps.getLegacyName(IhttpClient.class)));

         Assert.isType(clientType, ObjectOps.getLegacyClass(HttpClient.class));

         client.assign(ObjectOps.newInstance(clientType.ref().getType(), "III",
                  getOptionStringValue(this.getPropClientName()),
                  getOptionStringValue(this.getPropClientVersion()), buildLibrary()));

         if (!client.isUnknown())
         {
            IhttpClient httpClient = client.ref();

            // set options
            character option = new character("numRetries");
            ClientOptions clientOptions = httpClient.getOptions().ref();

            if (hasOption(option).booleanValue())
               clientOptions.setNumRetries(getOptionNumericValue(option).integerValue());

            option.assign("pauseBetweenRetry");
            if (hasOption(option).booleanValue())
               clientOptions.setPauseBetweenRetry(getOptionNumericValue(option));

            option.assign("requestTimeout");
            if (hasOption(option).booleanValue())
               clientOptions.setRequestTimeout(getOptionNumericValue(option));

            // logger
            if (httpClient instanceof ISupportLogging)
            {
               option.assign(ObjectOps.getLegacyName(IlogWriter.class));
               if (hasOption(option).booleanValue())
               {
                  ((ISupportLogging) httpClient).setLogger(
                           (object<? extends IlogWriter>) getOptionObjectValue(option));
               }
            }

            // initialize
            if (httpClient instanceof ISupportInitialize)
               ((ISupportInitialize) httpClient).initialize();

            // cookies
            option.assign(ObjectOps.getLegacyName(ICookieJar.class));
            if (hasOption(option).booleanValue())
            {
               client.assign(ClientBuilder
                        .decorateClient(ObjectOps.getLegacyClass(ISupportCookies.class), client));
               ((ISupportCookies) client.ref()).setCookieJar(
                        (object<? extends ICookieJar>) getOptionObjectValue(option));
            }

            // proxy
            option.assign(ObjectOps.getLegacyName(ISupportProxy.class));
            if (hasOption(option).booleanValue())
            {
               client.assign(ClientBuilder
                        .decorateClient(ObjectOps.getLegacyClass(ISupportProxy.class), client));
               ((ISupportProxy) client.ref())
                        .setProxyUri((object<? extends Uri>) getOptionObjectValue(option));
            }
         }
         returnNormal(client);
      }));
   }
   
   /**
    * Constructor.
    */
   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public void __net_http_DefaultHttpClientBuilder_constructor__()
   {
      internalProcedure(this, "__net_http_DefaultHttpClientBuilder_constructor__",
               new Block((Body) () ->
               {
                  __net_http_ClientBuilder_constructor__();
               }));
   }

   /**
    * Destructor for this class.  Cleanup/delete any created resources.
    */
   @LegacySignature(type = Type.DESTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public void __net_http_DefaultHttpClientBuilder_destructor__()
   {
      internalProcedure(this, "__net_http_DefaultHttpClientBuilder_destructor__",
               new Block((Body) () ->
               {
                  destroy();
               }));
   }

   /**
    * Execute method.
    */
   @LegacySignature(type = Type.EXECUTE)
   public void __net_http_DefaultHttpClientBuilder_execute__()
   {
      onBlockLevel(Condition.ERROR, Action.THROW);
   }

}