JdbcRAConstants.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
// Portions Copyright [2016] [Payara Foundation and/or its affiliates]

package com.sun.gjc.monitoring;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * Interface that contains all the constants used in the jdbc-ra module.
 *
 * @author Shalini M
 */
public interface JdbcRAConstants {

    /**
     * Represents the statement cache hit monitoring event.
     */
    public static final String STATEMENT_CACHE_HIT = "statementCacheHitEvent";

    /**
     * Represents the statement cache miss monitoring event.
     */
    public static final String STATEMENT_CACHE_MISS = "statementCacheMissEvent";

    /**
     * Represents caching of sql query event.
     */
    public static final String TRACE_SQL = "traceSQLEvent";

    public static final String POTENTIAL_STATEMENT_LEAK = "potentialStatementLeakEvent";
    
    /**
     * Represents module provider name.
     */
    public static final String GLASSFISH = "glassfish";

    /**
     * Represents the module name
     */
    public static final String JDBCRA = "jdbcra";

    /**
     * Represents probe provider name
     */
    public static final String STATEMENT_CACHE_PROBE = "statementcache";

    /**
     * Represents probe provider name for sql tracing.
     */
    public static final String SQL_TRACING_PROBE = "sqltracing";

    public static final String STATEMENT_LEAK_PROBE = "statementleak";

    /**
     * Dotted name used in monitoring for Statement caching.
     */
    public static final String STATEMENT_CACHE_DOTTED_NAME = GLASSFISH + ":" +
            JDBCRA + ":" + STATEMENT_CACHE_PROBE + ":";

    /**
     * Dotted name used in monitoring for Sql Tracing.
     */
    public static final String SQL_TRACING_DOTTED_NAME = GLASSFISH + ":" +
            JDBCRA + ":" + SQL_TRACING_PROBE + ":";

    public static final String STATEMENT_LEAK_DOTTED_NAME = GLASSFISH + ":" +
            JDBCRA + ":" + STATEMENT_LEAK_PROBE + ":";
    
    /**
     * Represents top queries to report.
     */
    public static final String REPORT_QUERIES = "reportQueriesEvent";

    /**
     * List of valid method names that can be used for sql trace monitoring.
     */
    public static final Set<String> validSqlTracingMethodNames =
            Collections.unmodifiableSet(
            new HashSet(Arrays.asList(
                "nativeSQL",
                "prepareCall",
                "prepareStatement",
                "addBatch",
                "execute",
                "executeQuery",
                "executeUpdate"
            )));
}