modules/core/src/main/java/org/apache/ignite/cdc/CdcConfiguration.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.ignite.cdc;

import org.apache.ignite.configuration.DataStorageConfiguration;
import org.apache.ignite.internal.cdc.CdcMain;
import org.apache.ignite.lang.IgniteExperimental;
import org.apache.ignite.spi.metric.MetricExporterSpi;
import org.apache.ignite.spi.metric.jmx.JmxMetricExporterSpi;

/**
 * This class defines {@link CdcMain} runtime configuration.
 * Configuration is passed to {@link CdcMain} constructor.
 */
@IgniteExperimental
public class CdcConfiguration {
    /** */
    private static final int DFLT_LOCK_TIMEOUT = 1000;

    /** */
    private static final long DFLT_CHECK_FREQ = 1000L;

    /** */
    private static final boolean DFLT_KEEP_BINARY = true;

    /** Change Data Capture consumer. */
    private CdcConsumer consumer;

    /** Metric exporter SPI. */
    private MetricExporterSpi[] metricExporterSpi;

    /** Keep binary flag.<br>Default value {@code true}. */
    private boolean keepBinary = DFLT_KEEP_BINARY;

    /**
     * {@link CdcMain} acquire file lock on startup to ensure exclusive consumption.
     * This property specifies amount of time to wait for lock acquisition.<br>
     * Default is {@code 1000 ms}.
     */
    private long lockTimeout = DFLT_LOCK_TIMEOUT;

    /**
     * CDC application periodically scans {@link DataStorageConfiguration#getCdcWalPath()} folder to find new WAL segments.
     * This frequency specify amount of time application sleeps between subsequent checks when no new files available.
     * Default is {@code 1000 ms}.
     */
    private long checkFreq = DFLT_CHECK_FREQ;

    /** @return CDC consumer. */
    public CdcConsumer getConsumer() {
        return consumer;
    }

    /** @param consumer CDC consumer. */
    public void setConsumer(CdcConsumer consumer) {
        this.consumer = consumer;
    }

    /**
     * Sets fully configured instances of {@link MetricExporterSpi}. {@link JmxMetricExporterSpi} is used by default.
     *
     * @param metricExporterSpi Fully configured instances of {@link MetricExporterSpi}.
     * @see CdcConfiguration#getMetricExporterSpi()
     * @see JmxMetricExporterSpi
     */
    public void setMetricExporterSpi(MetricExporterSpi... metricExporterSpi) {
        this.metricExporterSpi = metricExporterSpi;
    }

    /**
     * Gets fully configured metric SPI implementations. {@link JmxMetricExporterSpi} is used by default.
     *
     * @return Metric exporter SPI implementations.
     * @see JmxMetricExporterSpi
     */
    public MetricExporterSpi[] getMetricExporterSpi() {
        return metricExporterSpi;
    }

    /** @return keep binary value. */
    public boolean isKeepBinary() {
        return keepBinary;
    }

    /** @param keepBinary keep binary value. */
    public void setKeepBinary(boolean keepBinary) {
        this.keepBinary = keepBinary;
    }

    /** @return Amount of time to wait for lock acquisition. */
    public long getLockTimeout() {
        return lockTimeout;
    }

    /** @param lockTimeout Amount of time to wait for lock acquisition. */
    public void setLockTimeout(long lockTimeout) {
        this.lockTimeout = lockTimeout;
    }

    /** @return Amount of time application sleeps between subsequent checks when no new files available. */
    public long getCheckFrequency() {
        return checkFreq;
    }

    /**
     * @param checkFreq Amount of time application sleeps between subsequent checks when no new
     *                                           files available.
     */
    public void setCheckFrequency(long checkFreq) {
        this.checkFreq = checkFreq;
    }
}