ClientOptions.java

/*
** Module   : ClientOptions.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  20201217 Implement as of OE12.2.
** 004 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
**                  signature.
** 005 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.lang.*;

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

/**
 * Business logic (converted to Java from the 4GL source code
 * in OpenEdge/Net/HTTP/ClientOptions.cls).
 */
@LegacyResource(resource = "OpenEdge.Net.HTTP.ClientOptions")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class ClientOptions
extends BaseObject
{
   /** How many retries of the same request should be attempted. */
   private integer numRetries = UndoableFactory.integer(10L);
   /** The number of seconds (incl. fractions of seconds) between retries. */
   private decimal pauseBetweenRetry = UndoableFactory.decimal();
   /** Defines the maximum time a request must take. */
   private decimal requestTimeout = UndoableFactory.decimal();

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

   /**
    * Get the number of retries.
    * 
    * @return the number of retries.
    */
   @LegacySignature(returns = "INTEGER", type = Type.GETTER, name = "NumRetries")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public integer getNumRetries()
   {
      return function(this, "NumRetries", integer.class, new Block((Body) () -> 
      {
         returnNormal(numRetries);
      }));
   }

   /**
    * Set the number of retries.
    * @param _piValue the number of retries.
    */
   @LegacySignature(type = Type.SETTER, name = "NumRetries", parameters = 
   {
         @LegacyParameter(name = "piValue", type = "INTEGER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setNumRetries(final integer _piValue)
   {
      integer piValue = TypeFactory.initInput(_piValue);
      internalProcedure(this, "NumRetries", new Block((Body) () -> 
      {
         this.numRetries.assign(piValue);
      }));
   }

   /**
    * Get the number of seconds between retries.
    *  
    * @return the number of seconds between retries.
    */
   @LegacySignature(returns = "DECIMAL", type = Type.GETTER, name = "PauseBetweenRetry")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public decimal getPauseBetweenRetry()
   {
      return function(this, "PauseBetweenRetry", decimal.class, new Block((Body) () -> 
      {
         returnNormal(pauseBetweenRetry);
      }));
   }

   /**
    * Set the number of seconds between retries.
    * @param _pdValue the number of seconds between retries.
    */
   @LegacySignature(type = Type.SETTER, name = "PauseBetweenRetry", parameters = 
   {
         @LegacyParameter(name = "pdValue", type = "DECIMAL", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setPauseBetweenRetry(final decimal _pdValue)
   {
      decimal pdValue = TypeFactory.initInput(_pdValue);
      internalProcedure(this, "PauseBetweenRetry", new Block((Body) () -> 
      {
         this.pauseBetweenRetry.assign(pdValue);
      }));
   }

   /**
    * Get the maximum time a request must take.
    * 
    * @return the maximum time a request must take.
    */
   @LegacySignature(returns = "DECIMAL", type = Type.GETTER, name = "RequestTimeout")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public decimal getRequestTimeout()
   {
      return function(this, "RequestTimeout", decimal.class, new Block((Body) () -> 
      {
         returnNormal(requestTimeout);
      }));
   }

   /**
    * Set the maximum time a request must take.
    * 
    * @param _pdValue the maximum time a request must take.
    */
   @LegacySignature(type = Type.SETTER, name = "RequestTimeout", parameters = 
   {
         @LegacyParameter(name = "pdValue", type = "DECIMAL", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setRequestTimeout(final decimal _pdValue)
   {
      decimal pdValue = TypeFactory.initInput(_pdValue);
      internalProcedure(this, "RequestTimeout", new Block((Body) () -> 
      {
         this.requestTimeout.assign(pdValue);
      }));
   }

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