ProxyHttpClient.java

/*
** Module   : ProxyHttpClient.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 Fully implement ISupportProxy interface.
** 003 MP  20200603 Add constructors and methods like originar class.
**     ME  20210210 Implement additional ctor's and execute method.
**     CA  20210219 OO input parameter definitions for functions/procedures must not register with  ObjectOps 
**                  - TypeFactory.initInput will take care of this.
**     CA  20210221 Fixed parameters at the LegacySignature annotation.
** 004 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.
** 005 CA  20230817 Removed ObjectOps.register, as this registration is handled by runtime.
** 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;

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;

import com.goldencode.p2j.oo.core.Assert;
import com.goldencode.p2j.oo.lang.LegacyClass;
import com.goldencode.p2j.oo.net.Uri;

/**
 * Http client with support for proxy server, for all requests
 *
 */
@LegacyResource(resource = "OpenEdge.Net.HTTP.ProxyHttpClient")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_PARTIAL)
public class ProxyHttpClient extends HttpClientDecorator implements ISupportProxy
{

   /** Proxy URI **/
   @LegacySignature(type = Type.PROPERTY, name = "ProxyURI")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   private final object<? extends Uri> proxyUri = TypeFactory.object(Uri.class);

   @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_STUB)
   @Override
   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)
   {
      object<? extends com.goldencode.p2j.oo.net.http.IhttpRequest> poRequest = TypeFactory.initInput(_poRequest);
      object<? extends com.goldencode.p2j.oo.net.http.IhttpResponse> poResponse = TypeFactory.initInput(_poResponse);
      object<? extends ISupportProxy> oProxy = TypeFactory.object(ISupportProxy.class);
      
      internalProcedure(ProxyHttpClient.class, this, "Execute", new Block((Body) () -> 
      {
         object<? extends LegacyClass> proxyCls = ObjectOps.getLegacyClass(ISupportProxy.class);
         
         if (ObjectOps.typeOf(poRequest, ISupportProxy.class).booleanValue())
         {
            oProxy.assign(ObjectOps.cast(poRequest, ISupportProxy.class));
         }
         else
         {
            poRequest.assign(RequestBuilder.decorateRequest(proxyCls, poRequest));
            oProxy.assign(ObjectOps.cast(poRequest, ISupportProxy.class));
         }
         
         oProxy.ref().setProxyUri(proxyUri);
         
         super.execute(poRequest, poResponse);
      }));
   }
   
   @LegacySignature(type = Type.EXECUTE)
   public void __net_http_ProxyHttpClient_execute__()
   {
      onBlockLevel(Condition.ERROR, Action.THROW);
   }
   
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "poClient", type = "OBJECT", qualified = "openedge.net.http.ihttpclient", mode = "INPUT"),
      @LegacyParameter(name = "poProxy", type = "OBJECT", qualified = "openedge.net.uri", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public void __net_http_ProxyHttpClient_constructor__(
            final object<? extends com.goldencode.p2j.oo.net.http.IhttpClient> _poClient, 
            final object<? extends com.goldencode.p2j.oo.net.Uri> _poProxy)
   {
      object<? extends com.goldencode.p2j.oo.net.http.IhttpClient> poClient = TypeFactory.initInput(_poClient);
      object<? extends com.goldencode.p2j.oo.net.Uri> poProxy = TypeFactory.initInput(_poProxy);
      
      internalProcedure(ProxyHttpClient.class, this, "__net_http_ProxyHttpClient_constructor__", new Block((Body) () -> 
      {
         __net_http_HttpClientDecorator_constructor__(poClient);
         
         Assert.notNull(poProxy, new character("Proxy server URI"));
         proxyUri.assign(poProxy);
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "poClient", type = "OBJECT", qualified = "openedge.net.http.ihttpclient", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public void __net_http_ProxyHttpClient_constructor__(
            final object<? extends com.goldencode.p2j.oo.net.http.IhttpClient> _poClient)
   {
      object<? extends com.goldencode.p2j.oo.net.http.IhttpClient> poClient = TypeFactory.initInput(_poClient);
      
      internalProcedure(ProxyHttpClient.class, this, "__net_http_ProxyHttpClient_constructor__", new Block((Body) () -> 
      {
         __net_http_HttpClientDecorator_constructor__(poClient);
      }));
   }
   
   /**
    * Get the URI used as proxy.
    * 
    * @return proxy uri.
    */
   @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.URI", type = Type.GETTER, name = "ProxyURI")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   @Override
   public object<? extends com.goldencode.p2j.oo.net.Uri> getProxyURI()
   {
      return function(this, "ProxyURI", object.class, new Block((Body) () ->
      {
         returnNormal(proxyUri);
      }));
   }

   /**
    * Set the URI to use as proxy.
    * 
    * @param _proxyUri The proxy URI.
    */
   @LegacySignature(type = Type.SETTER, name = "ProxyURI", parameters = 
   {
      @LegacyParameter(name = "proxyUri", type = "OBJECT", mode = "INPUT", qualified = "OpenEdge.Net.URI")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   @Override
   public void setProxyUri(object<? extends com.goldencode.p2j.oo.net.Uri> _proxyUri)
   {
      object<? extends Uri> proxyUri = TypeFactory.initInput(_proxyUri);

      internalProcedure(this, "ProxyURI", new Block((Body) () ->
      {
         this.proxyUri.assign(proxyUri);
      }));
   }
   
}