# MockLegacyJavaAppserverClient.java

    /*
    ** Module   : MockLegacyJavaAppserverClient.java
    ** Abstract : Mock the OpenClient APIs, to allow tests without a FWD server.
    **
    ** Copyright (c) 2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
    ** 001 CA  20230717 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.main.*;

    import commonj.sdo.DataGraph;

    /**
     * Mock the OpenClient APIs used to invoke a remote external program or internal procedure/function.
     * <p>
     * The {@link #mockRunFunction}, {@link #mockRunSingleRunProcedure}, {@link #mockRunSingletonProcedure},
     * {@link #mockRunPersistentProcedure}, {@link #mockRunProcedure} and {@link #mockInvokeWithArgs} APIs can
     * be overridden in a sub-class.
     * <p>
     * Use {@link #setMockParameter} API to explicit set the value of a OUTPUT or INPUT-OUTPUT parameter which,
     * on the OpenClient side, will automatically be available via {@link #getOutputParameter}.
     * <p>
     * For DATASET[-HANDLE] and TABLE[-HANDLE] parameters, the value for {@link #setMockParameter} must be a
     * {@link DataGraph}.
     */
    public class MockLegacyJavaAppserverClient
    extends LegacyJavaAppserverClient
    {
       /**
        * Default constructor.
        */
       public MockLegacyJavaAppserverClient()
       {
          super(new AppServerConnectionPool("mock-fwd-server"));
       }

       /**
        * Set a mock parameter value.
        *
        * @param    param
        *           The parameter.
        * @param    value
        *           The value.
        */
       public final void setMockParameter(LegacyJavaAppserverParameter param, Object value)
       {
          setParameterOrig(param, value);
       }

       /**
        * Get the mock output parameter value.
        *
        * @param    param
        *           The parameter.
        */
       @Override
       public final Object getOutputParameter(LegacyJavaAppserverParameter param)
       {
          return param.getOrig();
       }

       /**
        * Mock of a remote FUNCTION call.
        *
        * @param    proxy
        *           A handle instance which has as value a {@link TransparentWrapper} with the target's name.
        * @param    function
        *           The internal function name.
        * @param    paramArray
        *           The parameters.
        *
        * @return   The function's returned value.
        */
       @Override
       public final Object runFunction(handle proxy, String function, LegacyJavaAppserverParameter... paramArray)
       {
          return mockRunFunction((String) proxy.get(), function, paramArray);
       }

       /**
        * Mock of a remote external program call ran in SINGLE-RUN mode.
        *
        * @param    procedure
        *           The external program name
        * @param    paramArray
        *           The parameters.
        *
        * @return   A mock handle containing the external program name.
        */
       @Override
       public final handle runSingleRunProcedure(String procedure, LegacyJavaAppserverParameter... paramArray)
       {
          mockRunSingleRunProcedure(procedure, paramArray);

          return new handle(new TransparentWrapper(procedure));
       }

       /**
        * Mock of a remote external program call ran in SINGLETON mode.
        *
        * @param    procedure
        *           The external program name
        * @param    paramArray
        *           The parameters.
        *
        * @return   A mock handle containing the external program name.
        */
       @Override
       public final handle runSingletonProcedure(String procedure, LegacyJavaAppserverParameter... paramArray)
       {
          mockRunSingletonProcedure(procedure, paramArray);

          return new handle(new TransparentWrapper(procedure));
       }

       /**
        * Mock of a remote external program call ran in PERSISTENT mode.
        *
        * @param    procedure
        *           The external program name
        * @param    paramArray
        *           The parameters.
        *
        * @return   A mock handle containing the external program name.
        */
       @Override
       public final handle runPersistentProcedure(String procedure, LegacyJavaAppserverParameter... paramArray)
       {
          mockRunPersistentProcedure(procedure, paramArray);

          return new handle(new TransparentWrapper(procedure));
       }

       /**
        * Mock of a remote external program call.
        *
        * @param    procedure
        *           The external program name
        * @param    paramArray
        *           The parameters.
        *
        * @return   The procedure's return value.
        */
       @Override
       public final String runProcedure(String procedure, LegacyJavaAppserverParameter... paramArray)
       {
          return mockRunProcedure(procedure, paramArray);
       }

       /**
        * Mock of a internal procedure call.
        *
        * @param    proxy
        *           The mock proxy for the external program, obtained via {@link #runPersistentProcedure},
        *           {@link #runSingleRunProcedure} or {@link #runSingleRunProcedure}.
        * @param    procedure
        *           The internal procedure name
        * @param    paramArray
        *           The parameters.
        *
        * @return   The procedure's return value.
        */
       @Override
       public final String runProcedure(handle proxy, String procedure, LegacyJavaAppserverParameter... paramArray)
       {
          return mockRunProcedure((String) proxy.get(), procedure, paramArray);
       }

       /**
        * Mock of a pseudo-dynamic call with variable arguments.
        *
        * @param    procedure
        *           The external program name.
        * @param    paramArray
        *           The parameters.
        */
       @Override
       public final void invokeWithArgs(String procedure, LegacyJavaAppserverParameter[] paramArray)
       {
          mockInvokeWithArgs(procedure, paramArray);
       }

       /**
        * Override this method to implement a mock call of a remote FUNCTION.
        *
        * @param    extProg
        *           The external program name.
        * @param    function
        *           The function name.
        * @param    paramArray
        *           The parameters.
        *
        * @return   The function's return value.
        */
       public Object mockRunFunction(String extProg, String function, LegacyJavaAppserverParameter... paramArray)
       {
          return null;
       }

       /**
        * Override this method to implement a mock call of a remote external program as SINGLE-RUN.
        *
        * @param    procedure
        *           The external program name.
        * @param    paramArray
        *           The parameters.
        */
       public void mockRunSingleRunProcedure(String procedure, LegacyJavaAppserverParameter... paramArray)
       {
       }

       /**
        * Override this method to implement a mock call of a remote external program as SINGLETON.
        *
        * @param    procedure
        *           The external program name.
        * @param    paramArray
        *           The parameters.
        */
       public void mockRunSingletonProcedure(String procedure, LegacyJavaAppserverParameter... paramArray)
       {
       }

       /**
        * Override this method to implement a mock call of a remote external program as PERSISTENT.
        *
        * @param    procedure
        *           The external program name.
        * @param    paramArray
        *           The parameters.
        */
       public void mockRunPersistentProcedure(String procedure, LegacyJavaAppserverParameter... paramArray)
       {
       }

       /**
        * Override this method to implement a mock call of an external program.
        *
        * @param    procedure
        *           The procedure name.
        * @param    paramArray
        *           The parameters.
        *
        * @return   The procedure's return value.
        */
       public String mockRunProcedure(String procedure, LegacyJavaAppserverParameter... paramArray)
       {
          return null;
       }

       /**
        * Override this method to implement a mock call of an internal procedure.
        *
        * @param    extProg
        *           The external program name.
        * @param    procedure
        *           The procedure name.
        * @param    paramArray
        *           The parameters.
        *
        * @return   The procedure's return value.
        */
       public String mockRunProcedure(String extProg, String procedure, LegacyJavaAppserverParameter... paramArray)
       {
          return null;
       }

       /**
        * Override this method to implement a mock call of a pseudo-dynamic procedure with variable arguments.
        *
        * @param    procedure
        *           The external program name.
        * @param    paramArray
        *           The parameters.
        */
       public void mockInvokeWithArgs(String procedure, LegacyJavaAppserverParameter[] paramArray)
       {
       }
    }