# HttpHeaderBuilder.java

    /*
    ** Module   : HttpHeaderBuilder.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 CA  20191024 Added method support levels and updated the class support level.
    ** 003 ME  20200512 Add missing methods as of OE 11.7.4.
    ** 004 CA  20210216 Fixed getRegistry() - the static var must be assigned, and not re-initialized.
    ** 005 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
    **                  signature.
    ** 006 ME  20210519 Fix registry lazy loading.
    ** 007 CA  20231031 Fixed object var def, which requires TypeFactory to have its OO type set.
    ** 008 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.oo.core.*;
    import com.goldencode.p2j.oo.lang.*;
    import com.goldencode.p2j.security.*;

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

    import java.util.Collections;
    import java.util.HashMap;
    import java.util.Map;

    import org.apache.commons.lang3.StringUtils;

    /**
     * Business logic (converted to Java from the 4GL source code
     * in OpenEdge/Net/HTTP/HttpHeaderBuilder.cls).
     */
    @LegacyResource(resource = "OpenEdge.Net.HTTP.HttpHeaderBuilder")
    @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
    public abstract class HttpHeaderBuilder
    extends ConfigBuilder
    {
       private static final String SEMICOLON_PARAM_HEADER_BUILDER = "OpenEdge.Net.HTTP.SemicolonParamHeaderBuilder";
       private static final String CONTENT_TYPE_HEADER_BUILDER = "OpenEdge.Net.HTTP.ContentTypeHeaderBuilder";
       private static final String CONTENT_DISPOSITION_HEADER_BUILDER = "OpenEdge.Net.HTTP.ContentDispositionHeaderBuilder";
       private static final String DEFAULT_HEADER_BUILDER = "OpenEdge.Net.HTTP.DefaultHeaderBuilder";
       private static final String AUTORIZATION_HEADER_BUILDER = "OpenEdge.Net.HTTP.AuthorizationHeaderBuilder";
       protected static final String HTTP_BUILDERREGISTRY = "openedge.net.http.builderregistry";
       protected static final String HTTP_HTTPHEADERBUILDER = "openedge.net.http.httpheaderbuilder";

       /** Header name. */
       private final character headerName = UndoableFactory.character();
       /** Header. */
       protected final object<? extends HttpHeader> header = TypeFactory.object(HttpHeader.class);

       private HashMap<character, character> parameters;

       /** 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);
          }
       };

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

       @LegacySignature(type = Type.CONSTRUCTOR)
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static void __net_http_HttpHeaderBuilder_constructor__static__()
       {
          externalProcedure(HttpHeaderBuilder.class, new Block((Body) () ->
          {
             onBlockLevel(Condition.ERROR, Action.THROW);
          }));
       }

       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "AddParameter", qualified = HTTP_HTTPHEADERBUILDER, parameters = {
                @LegacyParameter(name = "pName", type = "CHARACTER", mode = "INPUT"),
                @LegacyParameter(name = "pValue", type = "CHARACTER", mode = "INPUT") })
       public object<? extends HttpHeaderBuilder> addParameter(final character _pName,
                final character _pValue)
       {
          character pName = TypeFactory.initInput(_pName);
          character pValue = TypeFactory.initInput(_pValue);

          return function(HttpHeaderBuilder.class, this, "AddParameter", object.class, new Block((Body) () -> {
             Assert.notNullOrEmpty(pName, new character("Parameter name"));
             Assert.notNull(pValue, new character("Parameter value"));

             // add this as option just to be OE compliant
             setOption(new character("param+" + pName.getValue()), pValue);

             if (parameters == null)
                parameters = new HashMap<character, character>();

             parameters.put(pName, pValue);

             returnNormal(new object(this));
          }));
       }

       /**
        * Get created header.
        *
        * @return created header.
        */
       @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.HttpHeader", type = Type.GETTER, name = "Header")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public abstract object<? extends HttpHeader> getHeader();

       /**
        * Get header name.
        * @return header name.
        */
       @LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "HeaderName")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       protected character getHeaderName()
       {
          return function(this, "HeaderName", character.class, new Block((Body) () ->
          {
             returnNormal(headerName);
          }));
       }

       /**
        * 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(HttpHeaderBuilder.class, "Registry", object.class, new Block((Body) () ->
          {
             if (!REGISTRY.get()._isValid())
             {
                REGISTRY.get().assign(ObjectOps.newInstance(BuilderRegistry.class, "I",
                         ObjectOps.getLegacyClass(HttpHeaderBuilder.class)));
                initializeRegistry(REGISTRY.get());
             }
             returnNormal(REGISTRY.get());
          }));
       }

       /**
        * Constructor.
        *
        * @param _pcHeaderName header name.
        */
       @LegacySignature(type = Type.CONSTRUCTOR, parameters =
       {
          @LegacyParameter(name = "pcHeaderName", type = "CHARACTER", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       protected void __net_http_HttpHeaderBuilder_constructor__(final character _pcHeaderName)
       {
          character pcHeaderName = TypeFactory.initInput(_pcHeaderName);

          internalProcedure(this, "__net_http_HttpHeaderBuilder_constructor__", new Block((Body) () ->
          {
             __net_http_ConfigBuilder_constructor__();
             Assert.notNullOrEmpty(pcHeaderName, new character("Header name"));

             this.headerName.assign(pcHeaderName);
          }));
       }

       /**
        * Builder director method.
        *
        * @param _hName header name.
        *
        * @return A builder for the requested type.
        */
       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Build", qualified = HTTP_HTTPHEADERBUILDER, parameters = {
                @LegacyParameter(name = "hName", type = "CHARACTER", mode = "INPUT") })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
       public static object<? extends HttpHeaderBuilder> build(final character _hName)
       {
          character hName = TypeFactory.initInput(_hName);
          object<? extends HttpHeaderBuilder> builder = TypeFactory.object(HttpHeaderBuilder.class);
          object<? extends LegacyClass> builderType = TypeFactory.object(LegacyClass.class);

          return function(HttpHeaderBuilder.class, "Build", object.class, new Block((Body) () ->
          {
             Assert.notNullOrEmpty(hName, new character("Header name"));
             builderType.assign(getRegistry().ref().get(hName));
             if (!builderType._isValid())
             {
                builderType.assign(getRegistry().ref().get(new character("*")));
             }
             Assert.isType(builderType, ObjectOps.getLegacyClass(HttpHeaderBuilder.class));
             builder.assign(ObjectOps.newInstance(builderType.ref().getType(), "I", hName));
             if (ObjectOps.typeOf(builder, ISupportInitialize.class).booleanValue())
             {
                ObjectOps.cast(builder, ISupportInitialize.class).ref().initialize();
             }
             returnNormal(builder);
          }));
       }

       private static void initializeRegistry(final object<? extends BuilderRegistry> _poRegistry)
       {
          internalProcedure(HttpHeaderBuilder.class, "InitializeRegistry", new Block((Body) () ->
          {
             _poRegistry.ref().put(new character("*"),
                      ObjectOps.getLegacyClass(DefaultHeaderBuilder.class));
             _poRegistry.ref().put(new character("Content-Disposition"),
                      ObjectOps.getLegacyClass(ContentDispositionHeaderBuilder.class));
             _poRegistry.ref().put(new character("Content-Type"),
                      ObjectOps.getLegacyClass(ContentTypeHeaderBuilder.class));
             _poRegistry.ref().put(new character("Cookie"),
                      ObjectOps.getLegacyClass(SemicolonParamHeaderBuilder.class));
             _poRegistry.ref().put(new character("WWW-Authentication"),
                      ObjectOps.getLegacyClass(AuthorizationHeaderBuilder.class));
             _poRegistry.ref().put(new character("Authorization"),
                      ObjectOps.getLegacyClass(AuthorizationHeaderBuilder.class));
          }));

       }

       /**
        * Sets the header's parameter delimiter.
        *
        * @param _delim The delimter to use between parameter.
        *
        * @return The current builder object.
        */
       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "ParametersDelimitedBy",
             qualified = HTTP_HTTPHEADERBUILDER, parameters =
       {
          @LegacyParameter(name = "delim", type = "CHARACTER", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public object<? extends HttpHeaderBuilder> parametersDelimitedBy(final character _delim)
       {
          character delim = TypeFactory.initInput(_delim);

          return function(this, "ParametersDelimitedBy", object.class, new Block((Body)() ->
          {
             Assert.notNull(delim, new character("Parameter delimiter"));

             if (StringUtils.isEmpty(delim.getValue()))
                undoThrow(ObjectOps.newInstance(AssertionFailedError.class, "II", "Parameter delimiter cannot be empty", 0));

             setOption(new character("paramDelimiter"), delim);
             returnNormal(new object<>(this));
          }));
       }

       /**
        * Sets the header's value.
        *
        * @param _value The complete (unparsed) header value.
        *
        * @return The current builder object.
        */
       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Value",
             qualified = HTTP_HTTPHEADERBUILDER, parameters =
       {
          @LegacyParameter(name = "value", type = "CHARACTER", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public object<? extends HttpHeaderBuilder> value(final character _value)
       {
          character value = TypeFactory.initInput(_value);

          return function(this, "Value", object.class, new Block((Body)() ->
          {
             Assert.notNull(value, new character("Header value"));
             setOption(new character("hdrValue"), value);
             returnNormal(new object<>(this));
          }));
       }

       protected Map<character, character> getParameters()
       {
          return parameters != null ? parameters : Collections.emptyMap();
       }
    }