RequestWriterBuilder.java

/*
** Module   : RequestWriterBuilder.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2020-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 MP  20200603 First version, stubs taken by converting the skeleton using FWD.
** 002 MP  20210105 Add code in Registry and GetWriter methods
**     ME  20210208 Fix static registry property initialization.
**     CA  20210219 OO input parameter definitions for functions/procedures must not register with  ObjectOps 
**                  - TypeFactory.initInput will take care of this.
** 003 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
**     ME  20210301 Added class 'referent' for static methods, always use registry getter.
**         20210310 Added missing implementation (OE12.2).
** 004 ME  20210519 Fix registry lazy loading.
** 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.filter.writer;

import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.BlockManager.Action;
import com.goldencode.p2j.util.BlockManager.Condition;
import com.goldencode.p2j.security.*;

import static com.goldencode.p2j.report.ReportConstants.CVT_LVL_FULL;
import static com.goldencode.p2j.report.ReportConstants.RT_LVL_FULL;
import static com.goldencode.p2j.util.BlockManager.*;
import static com.goldencode.p2j.util.InternalEntry.Type;

import com.goldencode.p2j.oo.core.Assert;
import com.goldencode.p2j.oo.core.ByteBucket;
import com.goldencode.p2j.oo.core.ISupportInitialize;
import com.goldencode.p2j.oo.lang.LegacyClass;
import com.goldencode.p2j.oo.net.http.BuilderRegistry;
import com.goldencode.p2j.oo.net.http.IhttpRequest;
import com.goldencode.p2j.oo.net.http.filter.payload.ConnectRequestFilter;
import com.goldencode.p2j.oo.net.http.filter.payload.DefaultRequestFilter;
import com.goldencode.p2j.oo.net.http.filter.payload.MessageWriter;

/**
 * Business logic (converted to Java from the 4GL source code
 * in OpenEdge/Net/HTTP/Filter/Writer/RequestWriterBuilder.cls).
 */
@LegacyResource(resource = "OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class RequestWriterBuilder
extends com.goldencode.p2j.oo.net.http.ConfigBuilder
{
   @LegacySignature(type = Type.PROPERTY, name = "Request")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   private object<? extends IhttpRequest> request = 
      TypeFactory.object(IhttpRequest.class);

   @LegacySignature(type = Type.PROPERTY, name = "Writer")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   private object<? extends MessageWriter> writer = 
      TypeFactory.object(MessageWriter.class);

   /** Registry */
   @LegacySignature(type = Type.PROPERTY, name = "Registry")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   private static ContextLocal<object<? extends BuilderRegistry>> REGISTRY = 
      new ContextLocal<object<? extends BuilderRegistry>>()
   {
      /**
       * Initial value.
       */
      @Override
      protected object<? extends BuilderRegistry> initialValue()
      {
         return TypeFactory.object(BuilderRegistry.class);
      }
   };
   
   /**
    * Execute method.
    */
   @LegacySignature(type = Type.EXECUTE)
   public void __net_http_filter_writer_RequestWriterBuilder_execute__()
   {
      onBlockLevel(Condition.ERROR, Action.THROW);
   }
   
   /**
    * Get request object.
    * 
    * @return request.
    */
   @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.IHttpRequest", type = Type.GETTER, name = "Request")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public object<? extends IhttpRequest> getRequest()
   {
      return function(RequestWriterBuilder.class, this, "Request", object.class, new Block((Body) () -> 
      {
         returnNormal(request);
      }));
   }

   /**
    * Get writer object.
    * 
    * @return writer.
    */
   @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.Filter.Payload.MessageWriter", type = Type.GETTER, name = "Writer")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public object<? extends MessageWriter> getWriter()
   {
      return function(RequestWriterBuilder.class, this, "Writer", object.class, new Block((Body) () -> 
      {
         returnNormal(this.newRequestWriter());
      }));
   }

   /**
    * Get registry.
    * 
    * @return registry.
    */
   @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.BuilderRegistry", type = Type.GETTER, name = "Registry")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public static object<? extends BuilderRegistry> getRegistry()
   {
      return function(RequestWriterBuilder.class, "Registry", object.class, new Block((Body) () -> 
      {
         if (!REGISTRY.get()._isValid())
         {
            REGISTRY.get().assign(ObjectOps.newInstance(BuilderRegistry.class, "I",
                     ObjectOps.getLegacyClass(MessageWriter.class)));
            initializeRegistry(REGISTRY.get());
         }
         
         returnNormal(REGISTRY.get());
      }));
   }
   
   /**
    * Initialize registry.
    * 
    * @param _poRegistry to be initialized.
    */
   @LegacySignature(type = Type.METHOD, name = "InitializeRegistry", parameters = 
   {
      @LegacyParameter(name = "poRegistry", type = "OBJECT", qualified = "openedge.net.http.builderregistry", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   private static void initializeRegistry(final object<? extends BuilderRegistry> _poRegistry)
   {
      internalProcedure(RequestWriterBuilder.class, "InitializeRegistry", new Block((Body) () -> 
      {
         _poRegistry.ref().put(new character("HTTP/1.1"), 
                  ObjectOps.getLegacyClass(DefaultRequestFilter.class));
         _poRegistry.ref().put(new character("HTTP/1.1+CONNECT"), 
                  ObjectOps.getLegacyClass(ConnectRequestFilter.class));
      }));
   }

   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Build", qualified = "openedge.net.http.filter.writer.requestwriterbuilder", parameters = 
   {
      @LegacyParameter(name = "pRequest", type = "OBJECT", qualified = "openedge.net.http.ihttprequest", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public static object<? extends com.goldencode.p2j.oo.net.http.filter.writer.RequestWriterBuilder> build(
            final object<? extends com.goldencode.p2j.oo.net.http.IhttpRequest> _pRequest)
   {
      object<? extends com.goldencode.p2j.oo.net.http.IhttpRequest> pRequest = TypeFactory.initInput(_pRequest);
      
      return function(RequestWriterBuilder.class, "Build", object.class, new Block((Body) () -> 
      {
         returnNormal(ObjectOps.newInstance(RequestWriterBuilder.class, "I", pRequest));
      }));
   }

   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Build", qualified = "openedge.net.http.filter.writer.requestwriterbuilder")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public static object<? extends com.goldencode.p2j.oo.net.http.filter.writer.RequestWriterBuilder> build()
   {
      return function(RequestWriterBuilder.class, "Build", object.class, new Block((Body) () -> 
      {
         returnNormal(ObjectOps.newInstance(RequestWriterBuilder.class));
      }));
   }
   
   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public static void __net_http_filter_writer_RequestWriterBuilder__static__()
   {
      externalProcedure(RequestWriterBuilder.class, new Block((Body) () ->
      {
         onBlockLevel(Condition.ERROR, Action.THROW);
      }));
   }

   /**
    * Constructor
    */
   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __net_http_filter_writer_RequestWriterBuilder_constructor__()
   {
      internalProcedure(RequestWriterBuilder.class, this, "__net_http_filter_writer_RequestWriterBuilder_constructor__", new Block((Body) () -> 
      {
         __net_http_ConfigBuilder_constructor__();
      }));
   }
   
   /**
    * Constructor
    * 
    * @param _pRequest IHttpRequest.
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "pRequest", type = "OBJECT", qualified = "openedge.net.http.ihttprequest", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __net_http_filter_writer_RequestWriterBuilder_constructor__(
            final object<? extends com.goldencode.p2j.oo.net.http.IhttpRequest> _pRequest)
   {
      object<? extends com.goldencode.p2j.oo.net.http.IhttpRequest> pRequest = TypeFactory.initInput(_pRequest);
      
      internalProcedure(RequestWriterBuilder.class, this, "__net_http_filter_writer_RequestWriterBuilder_constructor__", new Block((Body) () -> 
      {
         __net_http_ConfigBuilder_constructor__();
         request.assign(pRequest);
      }));
   }

   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Request", qualified = "openedge.net.http.filter.writer.requestwriterbuilder", parameters = 
   {
      @LegacyParameter(name = "poMessage", 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.filter.writer.RequestWriterBuilder> request(
            final object<? extends com.goldencode.p2j.oo.net.http.IhttpRequest> _poMessage)
   {
      object<? extends com.goldencode.p2j.oo.net.http.IhttpRequest> poMessage = TypeFactory.initInput(_poMessage);
      
      return function(RequestWriterBuilder.class, this, "Request", object.class, new Block((Body) () -> 
      {
         Assert.notNull(poMessage, new character("HTTP Message"));
         setOption(new character(ObjectOps.getLegacyName(IhttpRequest.class)), poMessage);
         returnNormal(ObjectOps.thisObject());
      }));
   }

   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "WriteTo", qualified = "openedge.net.http.filter.writer.requestwriterbuilder", parameters = 
   {
      @LegacyParameter(name = "poMessageBody", type = "OBJECT", qualified = "openedge.core.bytebucket", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public object<? extends com.goldencode.p2j.oo.net.http.filter.writer.RequestWriterBuilder> writeTo(
            final object<? extends com.goldencode.p2j.oo.core.ByteBucket> _poMessageBody)
   {
      object<? extends com.goldencode.p2j.oo.core.ByteBucket> poMessageBody = TypeFactory.initInput(_poMessageBody);
      
      return function(RequestWriterBuilder.class, this, "WriteTo", object.class, new Block((Body) () -> 
      {
         Assert.notNull(poMessageBody, new character("Message Body"));
         setOption(new character(ObjectOps.getLegacyName(ByteBucket.class)), poMessageBody);
         returnNormal(ObjectOps.thisObject());
      }));
   }
   
   /**
    * Adds or overwrites writer property
    *     
    * @return the message writer object
    */
   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "NewRequestWriter", qualified = "openedge.net.http.filter.payload.messagewriter")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   protected object<? extends MessageWriter> newRequestWriter()
   {
      object<? extends MessageWriter> wObj = TypeFactory.object(MessageWriter.class);
      
      return function(RequestWriterBuilder.class, this, "NewRequestWriter", object.class, new Block((Body) () -> 
      {
         object<? extends LegacyClass> wCls = getWriter(request, getRegistry());
         
         if (wCls._isValid()) 
         {
            Assert.isType(wCls, ObjectOps.getLegacyClass(MessageWriter.class));
            
            wObj.assign(ObjectOps.newDynamicInstance(wCls.ref().getTypeName()));
            
            String bbClsName = ObjectOps.getLegacyName(ByteBucket.class);
            
            if (_hasOption(bbClsName))
            {
               wObj.ref().setEntity(ObjectOps.cast(getOptionObjectValue(new character(bbClsName)), ByteBucket.class));
            }
            else 
            {
               wObj.ref().setEntity(ByteBucket.instance());
            }
            
            if (ObjectOps.typeOf(wObj, ISupportInitialize.class).booleanValue())
            {
               ObjectOps.cast(wObj, ISupportInitialize.class).ref().initialize();
            }
         }
         
         returnNormal(wObj);
      }));
   }

   /**
    * get writer type
    *     
    * @return class type of writer
    */
   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "GetWriter", qualified = "progress.lang.class", parameters = 
   {
      @LegacyParameter(name = "pRequest", type = "OBJECT", qualified = "openedge.net.http.ihttprequest", mode = "INPUT"),
      @LegacyParameter(name = "pRegistry", type = "OBJECT", qualified = "openedge.net.http.builderregistry", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   protected object<? extends com.goldencode.p2j.oo.lang.LegacyClass> getWriter(
            final object<? extends IhttpRequest> _pRequest, 
            final object<? extends BuilderRegistry> _pRegistry)
   {
      object<? extends IhttpRequest> pRequest = TypeFactory.initInput(_pRequest);
      object<? extends BuilderRegistry> pRegistry = TypeFactory.initInput(_pRegistry);
      object<? extends LegacyClass> oCls = TypeFactory.object(LegacyClass.class);
      
      return function(RequestWriterBuilder.class, this, "GetWriter", object.class, new Block((Body) () -> 
      {
         Assert.notNull(pRegistry, new character("Request writer registry"));
         
         if (pRequest._isValid()) 
         {
            oCls.assign(pRegistry.ref().get(TextOps.trim(TextOps.substitute("&1+&2", pRequest.ref().getVersion(), pRequest.ref().getMethod()))));

            if (!oCls._isValid())
            {
               oCls.assign(pRegistry.ref().get(pRequest.ref().getVersion()));
            }
         }
         
         if (!oCls._isValid())
         {
            oCls.assign(pRegistry.ref().get(new character("HTTP/1.1")));
         }
                  
         returnNormal(oCls);
      }));
   }
}