# HttpHeaderCollection.java

    /*
    ** Module   : HttpHeaderCollection.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 MP  20200611 Added missing methods as stubs taken by converting the skeleton using FWD.
    ** 004 ME  20200928 Clean-up private methods.
    ** 005 CA  20210113 Renamed clear() to clear_(), to follow NameConverter's rules.
    ** 006 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
    **                  signature.
    ** 007 ME  20210329 Increment/decrement object references on add/remove.
    **     CA  20210609 Updated INPUT/INPUT-OUTPUT parameters to the new approach, where they are explicitly
    **                  initialized at the method's execution, and not at the caller's arguments.
    ** 008 CA  20230313 Fixed 'getAll', the OUTPUT extent array must use update the object reference and not
    **                  assign the object directly to the array, otherwise the object reference counting will
    **                  decrement the reference.
    ** 009 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 java.util.*;

    import com.goldencode.p2j.oo.core.*;
    import com.goldencode.p2j.oo.lang.*;
    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.*;

    /**
     * Business logic (converted to Java from the 4GL source code
     * in OpenEdge/Net/HTTP/HttpHeaderCollection.cls).
     */
    @LegacyResource(resource = "OpenEdge.Net.HTTP.HttpHeaderCollection")
    @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
    public class HttpHeaderCollection
    extends BaseObject
    {
       /** Header by name map */
       protected final Map<character, object<? extends HttpHeader>> headers = new TreeMap<character, object<? extends HttpHeader>>(character.CASE_INSENSITIVE_ORDER);

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

       /**
        * Constructor.
        */
       @LegacySignature(type = Type.CONSTRUCTOR)
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public void __net_http_HttpHeaderCollection_constructor__()
       {
          internalProcedure(this, "__net_http_HttpHeaderCollection_constructor__", new Block((Body) () ->
          {
             __lang_BaseObject_constructor__();
          }));
       }

       @LegacySignature(returns = "INTEGER", type = Type.GETTER, name = "Size")
       public integer getSize()
       {
          return function(HttpHeaderCollection.class, this, "Size", integer.class, new Block((Body) () ->
          {
             returnNormal(new integer(this.headers.size()));
          }));
       }

       /**
        *  Removes all headers from this message.
        */
       @LegacySignature(type = Type.METHOD, name = "Clear")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public void clear_()
       {
          internalProcedure(this, "Clear", new Block((Body) () ->
          {
             headers.values().forEach(h -> {
                if (h!=null && h._isValid())
                   ObjectOps.decrement(h.ref());
             });
             headers.clear();
          }));
       }

       /**
        * Returns a named header.
        *
        * @param _p1 The name of the header to retrieve.
        *
        * @return The header object. Returns a NullHeader if none exists.
        */
       @LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Get", qualified = "openedge.net.http.httpheader", parameters =
       {
          @LegacyParameter(name = "p1", type = "CHARACTER", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public object<? extends HttpHeader> get(final character _p1)
       {
          character p1 = TypeFactory.initInput(_p1);

          return function(this, "Get", object.class, new Block((Body) () ->
          {
             Assert.notNullOrEmpty(p1, new character("Header name"));
             returnNormal(
                   headers.getOrDefault(p1, HttpHeader.getNullHeader())
             );
          }));
       }

       /**
        * Returns all the headers (Names and values).
        *
        * @param _p1 An array of headers.
        *
        * @return The number of headers returned.
        */
       @LegacySignature(returns = "INTEGER", type = Type.METHOD, name = "GetAll", parameters =
       {
          @LegacyParameter(name = "p1", type = "OBJECT", extent = -1,
                qualified = "openedge.net.http.httpheader", mode = "OUTPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public integer getAll(final OutputExtentParameter<object<? extends HttpHeader>> _p1)
       {
          object[] p1 = TypeFactory.initOutput(_p1, this.headers.size());

          return function(this, "GetAll", integer.class, new Block((Body) () ->
          {
             int i = 0;

             // sorted by header name (probably temp-table index)
             for (object<? extends HttpHeader> h: headers.values())
             {
                p1[i++].assign(h);
             }

             returnNormal(new integer(p1.length));
          }));
       }

       /**
        * Indicates whether a header exists for this message or not.
        *
        * @param _p1 The name of a header to check.
        *
        * @return <code>true</code> if this message contains the header
        */
       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "Has", parameters =
       {
          @LegacyParameter(name = "p1", type = "CHARACTER", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public logical has(final character _p1)
       {
          character p1 = TypeFactory.initInput(_p1);

          return function(this, "Has", logical.class, new Block((Body) () ->
          {
             Assert.notNullOrEmpty(p1, new character("Header name"));
             returnNormal(new logical(headers.containsKey(p1)));
          }));
       }

       /**
        * Adds a header to this collection.
        *
        * @param _p1  The header.
        */
       @LegacySignature(type = Type.METHOD, name = "Put", parameters =
       {
          @LegacyParameter(name = "p1", type = "OBJECT", qualified = "openedge.net.http.httpheader", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public void put(final object<? extends com.goldencode.p2j.oo.net.http.HttpHeader> _p1)
       {
          object<? extends HttpHeader> p1 = TypeFactory.initInput(_p1);

          internalProcedure(this, "Put", new Block((Body) () ->
          {
             Assert.notNull(p1, new character("Http Header"));
             if (!ObjectOps.typeOf(p1, NullHeader.class).booleanValue())
             {
                object<? extends HttpHeader> old = headers.put(p1.ref().getName(), p1);
                ObjectOps.increment(p1.ref());

                if (old != null && old._isValid())
                   ObjectOps.decrement(old.ref());
             }
          }));
       }

       /**
        * Adds a set of headers to this collection. Overwrites any existing headers that appear in
        * this (the target) collection.
        *
        * @param _p1 The headers.
        */
       @LegacySignature(type = Type.METHOD, name = "Put", parameters =
       {
          @LegacyParameter(name = "p1", type = "OBJECT", extent = -1,
                qualified = "openedge.net.http.httpheader", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public void put(final object<? extends HttpHeader>[] _p1)
       {
          object<? extends HttpHeader>[] p1 = TypeFactory.initInput(_p1);

          internalProcedure(this, "Put", new Block((Body) () ->
          {
             Arrays.stream(p1).forEach(this::put);
          }));
       }

       /**
        * Adds a set of headers to this collection. Overwrites any existing headers that appear in
        * this (the target) collection.
        *
        * @param _p1 The header collection.
        */
       @LegacySignature(type = Type.METHOD, name = "Put", parameters =
       {
          @LegacyParameter(name = "p1", type = "OBJECT",
                qualified = "openedge.net.http.httpheadercollection", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public void put_1(final object<? extends HttpHeaderCollection> _p1)
       {
          object<? extends HttpHeaderCollection> p1 = TypeFactory.initInput(_p1);

          internalProcedure(this, "Put", new Block((Body) () ->
          {
             Assert.notNull(p1, new character("Header collection"));
             p1.ref().headers.values().forEach(this::put);
          }));
       }

       /**
        * Removes a header from the collection of message headers. No-op if none exists.
        *
        * @param _p1 The name of the header to remove.
        */
       @LegacySignature(type = Type.METHOD, name = "Remove", parameters =
       {
          @LegacyParameter(name = "p1", type = "CHARACTER", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public void remove(final character _p1)
       {
          character p1 = TypeFactory.initInput(_p1);

          internalProcedure(this, "Remove", new Block((Body) () ->
          {
             Assert.notNullOrEmpty(p1, new character("Header name"));
             object<? extends HttpHeader> old = headers.remove(p1);
             if (old != null && old._isValid())
                ObjectOps.decrement(old.ref());
          }));
       }

    }