# ComOleDaemon.java

    /*
    ** Module   : ComOleDaemon.java
    ** Abstract : Helper methods to handle COM Automation processing.
    **
    ** Copyright (c) 2017-2024, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description----------------------------------
    ** 001 CA  20171025 Created initial version.
    ** 002 CA  20171116 Added support for COM property setter with indices.
    ** 003 OM  20190223 Added support for indexed properties.
    ** 004 GBB 20240826 Removing single client and renaming relevant args.
    */

    /*
    ** 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.comauto;

    import com.goldencode.p2j.net.*;
    import com.goldencode.p2j.util.*;

    /**
     * Helper methods to handle COM Automation processing.  Delegates the calls to
     * {@link ComOleHelper}.  Exposes these APIs to the server-side via a {@link ComOleOps} network
     * server.
     */
    public class ComOleDaemon
    implements ComOleOps
    {
       /** Token used to authenticate with the dispatcher when registering APIs. */
       private static Object modToken = null;

       /**
        * Create an instance and export its API to the network.
        *
        * @param    local
        *           <code>true</code> to register purely on a local basis (no remote/network access to these
        *           methods).
        */
       public ComOleDaemon(boolean local)
       {
          Class<?>[] ifaces = new Class<?>[]
          {
             ComOleOps.class
          };

          synchronized (ComOleDaemon.class)
          {
             modToken = RemoteObject.registerServer(ifaces, this, modToken, local);
          }
       }

       /**
        * Release and destroy the COM object with the specified ID.
        *
        * @param    comId
        *           The COM object ID.
        */
       @Override
       public void release(long comId)
       {
          ComOleHelper.release(comId);
       }

       /**
        * Obtain a reference to an automation. It can be a new instance or a reference to an
        * already existing top-level automation.
        *
        * @param   comObjectType
        *          The name of the automation.
        * @param   topLevel
        *          Only return top-level. If the requested {@code comObjectType} is not a top-level,
        *          return {@code null}.
        * @param   noCreate
        *          Must exist. Do not allow creation of new instances. Only used with {@code topLevel}
        *          requests.
        *
        * @return  The ID of the COM object, or {@code 0} if such automation does not exist
        *          or it does not satisfy the parameter constraints.
        */
       @Override
       public long create(String comObjectType, boolean topLevel, boolean noCreate)
       {
          return ComOleHelper.create(comObjectType, topLevel, noCreate);
       }

       /**
        * Get the specified COM object property.
        *
        * @param    comId
        *           The COM object ID.
        * @param    prop
        *           The COM property name to retrieve.
        * @param    indices
        *           A variable number of indices used to access this property's element.
        *
        * @return   A {@link BaseDataType} instance with the COM property's details.
        */
       @Override
       public BaseDataType getProperty(long comId, String prop, ComParameter[] indices)
       {
          return ComOleHelper.getProperty(comId, prop, indices);
       }

       /**
        * Set the specified COM object property.
        *
        * @param    comId
        *           The COM object ID.
        * @param    prop
        *           The COM property name to set.
        * @param    val
        *           The details about property's new value.
        * @param    indices
        *           A variable number of indices used to access this property's element.
        *
        * @return   <code>true</code> if the property was set successfully.
        */
       @Override
       public boolean setProperty(long comId, String prop, ComParameter val, ComParameter[] indices)
       {
          return ComOleHelper.setProperty(comId, prop, val, indices);
       }

       /**
        * Execute a COM object method call.
        *
        * @param    comId
        *           The COM object ID.
        * @param    methodName
        *           The COM method name to call.
        * @param    aParams
        *           An array with this call's arguments supplied to the COM object method call.
        *
        * @return   An array where on index 0 are details of the returned value, and further indices
        *           correspond with argument's 1-based indices, where there will be a value for each
        *           OUTPUT or INPUT-OUTPUT argument.
        */
       @Override
       public BaseDataType[][] call(long comId, String methodName, ComParameter[] aParams)
       {
          return ComOleHelper.call(comId, methodName, aParams);
       }

       /**
        * Get the COM object name associated with the given COM object ID.
        *
        * @param    comId
        *           The COM object ID.
        *
        * @return   See above.
        */
       @Override
       public String getName(long comId)
       {
          return ComOleHelper.getName(comId);
       }

       /**
        * Gets COM Automation support level for particular OS.  Only Windows system has this
        * functionality.
        *
        * @return  <code>TRUE</code> if COM objects are supported, <code>FALSE</code> otherwise.
        */
       @Override
       public boolean isSupported()
       {
          return ComOleHelper.isSupported();
       }
    }