OutputTableCopier.java

/*
** Module   : OutputTableCopier.java
** Abstract : Finalizable for copying data in OUTPUT direction in table parameter case.
**
** Copyright (c) 2014-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- -----------------------Description-------------------------------------------
** 001 SVL 20140414 Created initial version.
** 002 CA  20190311 A buffer may be active as the source for multiple output table parameters.
** 003 CA  20190728 This needs to be processed first, before buffer's are closing their scope.
** 004 CA  20221006 Added JMX instrumentation for 'finished'. Refs #6814
** 005 HC  20240222 Enabled JMX on FWD Client.
** 006 CA  20240809 Skip using JMX timers when JMX_DEBUG flag is not set.
*/
/*
** 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.persist;

import com.goldencode.p2j.jmx.*;
import com.goldencode.p2j.security.*;
import com.goldencode.p2j.util.*;

/**
 * Class which is registered as a top-level finalizable and copies data in OUTPUT direction
 * in table parameter case. Normally output copy is performed when multiplex scope is closing,
 * but for persistent procedures the scope can be closed <i>after</i> an external procedure
 * finishes.
 */
public class OutputTableCopier
implements Finalizable
{
   /** Instrumentation for {@link #finished()}. */
   private static final NanoTimer COPIER = NanoTimer.getInstance(FwdServerJMX.TimeStat.OutputTableCopier);

   /** A buffer of the table which should be copied. */
   private final TemporaryBuffer srcBuf;
   
   /** The table parameter where to copy the data. */
   private TableParameter outputParam;

   /**
    * Creates a copier for the table.
    *
    * @param    srcBuf
    *           A buffer of the table which should be copied.
    * @param    outputParam
    *           The table parameter where to copy the data.
    */
   public OutputTableCopier(TemporaryBuffer srcBuf, TableParameter outputParam)
   {
      this.srcBuf = srcBuf;
      this.outputParam = outputParam;
   }

   /** Copies data in OUTPUT direction.*/
   @Override
   public void finished()
   {
      if (FwdServerJMX.JMX_DEBUG)
      {
         COPIER.timer(() -> srcBuf.performOutputCopy(outputParam));
      }
      else
      {
         srcBuf.performOutputCopy(outputParam);
      }
   }

   /** No-op. */
   @Override
   public void deleted()
   {
   }

   /** No-op. */
   @Override
   public void iterate()
   {
   }

   /** No-op. */
   @Override
   public void retry()
   {
   }

   /**
    * Get the weight of this finalizable.  Instances will ordered by their  
    * {@link WeightFactor weight}, before they are processed.
    * 
    * @return   The weight of this finalizable - {@link WeightFactor#FIRST}.
    */
   @Override
   public WeightFactor weight()
   {
      return WeightFactor.FIRST;
   }
}