ResponseBuilder.java

/*
** Module   : ResponseBuilder.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 missing stubs taken by converting the skeleton using FWD.
** 003 ME  20201029 Implement as per OE12.2.
**         20210208 Fix static registry property initialization.
** 004 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
**     ME  20210310 Add block 'referent' for static methods.
** 005 ME  20210519 Fix registry lazy loading.
**     ME  20210929 Fix return object on build.
** 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 static com.goldencode.p2j.util.BlockManager.externalProcedure;
import static com.goldencode.p2j.util.BlockManager.function;
import static com.goldencode.p2j.report.ReportConstants.*;
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.*;
import com.goldencode.p2j.oo.core.util.ConfigBuilder;
import com.goldencode.p2j.oo.lang.LegacyClass;
import com.goldencode.p2j.security.*;
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.*;

/**
 * Creates an instance of an HttpResponse object.
 *
 */
@LegacyResource(resource = "OpenEdge.Net.HTTP.ResponseBuilder")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public abstract class ResponseBuilder 
extends ConfigBuilder
implements ISupportInitialize
{

   /** Registry */
   @LegacySignature(type = Type.PROPERTY, name = "Registry")
   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);
      }
   };
   
   @LegacySignature(type = Type.EXECUTE)
   public void __net_http_ResponseBuilder_execute__()
   {
      onBlockLevel(Condition.ERROR, Action.THROW);
   }

   /**
    * 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(ResponseBuilder.class, "Registry", object.class, new Block((Body) () -> 
      {
         if (!REGISTRY.get()._isValid()) {
            REGISTRY.get().assign(ObjectOps.newInstance(BuilderRegistry.class));
            
            REGISTRY.get().ref()._put(ObjectOps.getLegacyName(IhttpResponse.class), 
                     ObjectOps.getLegacyClass(HttpResponse.class));
            REGISTRY.get().ref()._put(ObjectOps.getLegacyName(ResponseBuilder.class), 
                  ObjectOps.getLegacyClass(DefaultResponseBuilder.class));
         }
         
         returnNormal(REGISTRY.get());
      }));
   }
   
   @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.IHttpResponse", type = Type.GETTER, name = "Response")
   public abstract object<? extends com.goldencode.p2j.oo.net.http.IhttpResponse> getResponse();
   
   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Build", qualified = "openedge.net.http.responsebuilder")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public static object<? extends ResponseBuilder> build()
   {
      object<? extends ResponseBuilder> builder = TypeFactory.object(ResponseBuilder.class);
      
      return function(ResponseBuilder.class, "Build", object.class, new Block((Body) () -> 
      {
         object<? extends LegacyClass> builderCls = ObjectOps
                  .getLegacyClass(ResponseBuilder.class);
         object<? extends LegacyClass> builderType = getRegistry().ref()
                  .get(builderCls.ref().getTypeName());
         
         Assert.isType(builderType, builderCls);

         builder.assign(ObjectOps.newInstance(builderType.ref().getType()));

         if (builder._isValid() && builder.ref() instanceof ISupportInitialize)
            ((ISupportInitialize) builder.ref()).initialize();

         returnNormal(builder);
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   protected void __net_http_ResponseBuilder_constructor__()
   {
      internalProcedure(ResponseBuilder.class, this, "__net_http_ResponseBuilder_constructor__", new Block((Body) () -> 
      {
         __core_util_ConfigBuilder_constructor__();
      }));
   }
   
   @LegacySignature(type = Type.DESTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __net_http_ResponseBuilder_destructor__()
   {
      internalProcedure(ResponseBuilder.class, this, "__net_http_ResponseBuilder_destructor__", new Block((Body) () -> 
      {
         destroy();
      }));
   }

   @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "HttpVersion", qualified = "openedge.net.http.responsebuilder", parameters = 
   {
      @LegacyParameter(name = "pcVersion", type = "CHARACTER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public object<? extends ResponseBuilder> httpVersion(final character _pcVersion)
   {
      character pcVersion = TypeFactory.initInput(_pcVersion);
      
      return function(ResponseBuilder.class, this, "HttpVersion", object.class, new Block((Body) () -> 
      {
         Assert.notNullOrEmpty(pcVersion, new character("HTTP version"));
         
         setOption(new character("version"), _pcVersion);
         
         returnNormal(new object(this));
      }));
   }   

   /**
    * Destroy.
    */
   @LegacySignature(type = Type.METHOD, name = "Destroy")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   @Override
   public void destroy()
   {
      internalProcedure(ResponseBuilder.class, this, "Destroy", new Block((Body) () -> 
      {
         // looks like no-op
      }));
   }

   /**
    * Initialize.
    */
   @LegacySignature(type = Type.METHOD, name = "Initialize")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   @Override
   public void initialize()
   {
      internalProcedure(ResponseBuilder.class, this, "Initialize", new Block((Body) () -> 
      {
         httpVersion(new character("HTTP/1.1"));
      }));
   }

}