AppserverPackageExports.java

/*
** Module   : AppserverPackageExports.java
** Abstract : Package exports that are used by the appservers.
**
** Copyright (c) 2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 GBB 20250120 Created initial version.
*/
/*
** 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.util;

import com.goldencode.p2j.oo.lang.*;

/** Package exports that are used by the appservers. */
public class AppserverPackageExports
{
   /**
    * Converts a 4GL wrapper object into FWD object of type OerequestInfo.
    * 
    * @param    oeRequestObject
    *           A 4GL wrapper object of type OerequestInfo.
    *
    * @return   The FWD object for the OE request info.
    */
   public static OerequestInfo convertToOeRequest(object<? extends OerequestInfo> oeRequestObject)
   {
      return oeRequestObject.ref;
   }

   /**
    * Converts a Java object to a legacy object.
    * 
    * @param    anObject
    *           A Java object that can be casted to the 4GL wrapper object.
    *
    * @return   The legacy object.
    */
   public static LegacyObject convertToLegacyObject(Object anObject)
   {
      object o = (object) anObject;
      LegacyObject legacyObject = new LegacyObject(o);
      o.decrement();
      return legacyObject;
   }

   /**
    * Check if the given resource is known (has an associated ID).
    *
    * @param    proc
    *           A resource, valid or not.
    *
    * @return   {@code true} if the resource has an associated ID.
    */
   public static boolean isKnownResource(ExternalProgramWrapper proc)
   {
      return handle.knownResource(proc);
   }

   /**
    * Deletes the given object.
    *
    * @param   baseObject
    *          The object to be deleted.
    */
   public static void deleteObject(BaseObject baseObject)
   {
      ObjectOps.delete(baseObject);
   }

   /**
    * For the {@link LegacyJavaAppserverClient#invokeWithArgs} call, initialize the argument state, before the
    * call was performed.
    *
    * @param    argTypes
    *           The argument types.
    * @param    modes
    *           The argument modes.
    * @param    args
    *           The arguments.
    */
   public static void initializeOpenClientArguments(int[] argTypes, String modes, Object[] args)
   {
      LegacyOpenClientCaller.initializeArguments(argTypes, modes, args);
   }

   /**
    * For the {@link LegacyJavaAppserverClient#invokeWithArgs} call, clear the argument state, once the call
    * has finished.
    */
   public static void clearOpenClientArguments()
   {
      LegacyOpenClientCaller.clearArguments();
   }

   /**
    * Translate exception into {@link BlockManager.Condition} code.
    *
    * @param    ce
    *           Source exception.
    *
    * @return   one of the {@link BlockManager.Condition} codes or <code>null</code> if no
    *           match is found.
    */
   public static BlockManager.Condition exceptionToCondition(ConditionException ce)
   {
      return BlockManager.exceptionToCondition(ce);
   }
}