QueryCounterJMX.java
/*
** Module : QueryCounterJMX.java
** Abstract : Direct access to the query counting resource.
**
** Copyright (c) 2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 ICP 20241114 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.jmx;
import java.util.List;
import java.util.function.*;
/**
* Direct access to the query profiling resource.
*/
public class QueryCounterJMX
{
/** Publisher for the count configuration of a specific database */
protected final BiConsumer<String, QueryCountConfiguration> publishConfiguration;
/** Publisher for query count of a database */
protected final BiConsumer<String, QueryInfo> publishCount;
/** Consumer for the bootstrap method to register all databases */
protected final Consumer<List<String>> publishBootstrap;
/** Supplier for fetching the query counter configuration. */
private final Consumer<Function<String, QueryCountConfiguration>> publishSupplier;
/**
* Creates instance
*
* @param counter
* Query Counter MBean
*
* @return new <code>QueryCounterJMX</code> instance
*/
public static QueryCounterJMX getInstance(QueryCounter counter)
{
return new QueryCounterJMX(counter::updateConfiguration,
counter::updateCount,
counter::bootstrap,
counter::updateSupplier);
}
/**
* Constructor
*
* @param publishConfiguration
* Publisher for the count configuration of a specific database
* @param publishCount
* Publisher for query count of a database
* @param publishBootstrap
* Publisher for bootstrap configuration of a database
* @param publishSupplier
* Publisher for the supplier.
*/
protected QueryCounterJMX(BiConsumer<String, QueryCountConfiguration> publishConfiguration,
BiConsumer<String, QueryInfo> publishCount,
Consumer<List<String>> publishBootstrap,
Consumer<Function<String, QueryCountConfiguration>> publishSupplier)
{
this.publishConfiguration = publishConfiguration;
this.publishCount = publishCount;
this.publishBootstrap = publishBootstrap;
this.publishSupplier = publishSupplier;
}
/**
* Update the configuration for a database
*
* @param databaseName
* The database name.
* @param config
* The configuration details to be applied to the database.
*/
public void updateConfiguration(String databaseName, QueryCountConfiguration config)
{
publishConfiguration.accept(databaseName, config);
}
/**
* Updates the count for a specific query executed on the specified database.
*
* @param databaseName
* The name of the database on which the query was executed.
* @param sqlInfo
* The object containing SQL query information.
*/
public <T> void updateCount(String databaseName, QueryInfo sqlInfo)
{
publishCount.accept(databaseName, sqlInfo);
}
/**
* Registers all databases using the bootstrap method.
*
* @param databases
* The list of database names to be registered.
*/
public void bootstrap(List<String> databases)
{
publishBootstrap.accept(databases);
}
/**
* Updates the supplier for initial configuration.
*
* @param supplier
* The function to call to get the initial configuration.
*/
public void updateSupplier(Function<String, QueryCountConfiguration> supplier)
{
publishSupplier.accept(supplier);
}
}