com.sun.gjc.common.DataSourceSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-client Show documentation
Appclient for Payara Server
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-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-2022 Payara Foundation and/or its affiliates

package com.sun.gjc.common;

import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import org.glassfish.config.support.TranslatedConfigView;

/**
 * Encapsulate the DataSource object details obtained from
 * ManagedConnectionFactory.
 *
 * @author Binod P.G
 * @version 1.0, 02/07/23
 */
public class DataSourceSpec implements java.io.Serializable {

    public static final int USERNAME = 1;
    public static final int PASSWORD = 2;
    public static final int URL = 3;
    public static final int LOGINTIMEOUT = 4;
    public static final int LOGWRITER = 5;
    public static final int DATABASENAME = 6;
    public static final int DATASOURCENAME = 7;
    public static final int DESCRIPTION = 8;
    public static final int NETWORKPROTOCOL = 9;
    public static final int PORTNUMBER = 10;
    public static final int ROLENAME = 11;
    public static final int SERVERNAME = 12;
    public static final int MAXSTATEMENTS = 13;
    public static final int INITIALPOOLSIZE = 14;
    public static final int MINPOOLSIZE = 15;
    public static final int MAXPOOLSIZE = 16;
    public static final int MAXIDLETIME = 17;
    public static final int PROPERTYCYCLE = 18;
    public static final int DRIVERPROPERTIES = 19;
    public static final int CLASSNAME = 20;
    public static final int DELIMITER = 21;

    public static final int XADATASOURCE = 22;
    public static final int DATASOURCE = 23;
    public static final int CONNECTIONPOOLDATASOURCE = 24;

    //GJCINT      
    public static final int CONNECTIONVALIDATIONREQUIRED = 25;
    public static final int VALIDATIONMETHOD = 26;
    public static final int VALIDATIONTABLENAME = 27;

    public static final int TRANSACTIONISOLATION = 28;
    public static final int GUARANTEEISOLATIONLEVEL = 29;

    public static final int STATEMENTTIMEOUT = 30;
    public static final int STATEMENTWRAPPING = 31;

    public static final int ESCAPECHARACTER = 33;
    public static final int STATEMENTCACHESIZE = 34;
    public static final int STATEMENTCACHETYPE = 35;
    public static final int VALIDATIONCLASSNAME = 36;
    public static final int CUSTOMVALIDATION = 37;
    public static final int SQLTRACELISTENERS = 38;
    public static final int INITSQL = 39;
    public static final int POOLMONITORINGSUBTREEROOT = 40;
    public static final int NUMBEROFTOPQUERIESTOREPORT = 41;
    public static final int TIMETOKEEPQUERIESINMINUTES = 42;
    public static final int STATEMENTLEAKTIMEOUTINSECONDS = 43;
    public static final int STATEMENTLEAKRECLAIM = 44;
    public static final int POOLNAME = 45;
    public static final int APPLICATIONNAME = 46;
    public static final int MODULENAME = 47;
    public static final int SLOWSQLLOGTHRESHOLD = 48;
    public static final int LOGJDBCCALLS = 49;
    public static final int MAXCACHESIZE = 50;

    private static final long serialVersionUID = 1L;

    private final ConcurrentHashMap details = new ConcurrentIgnoredHashMap(URL,LOGJDBCCALLS,SLOWSQLLOGTHRESHOLD, STATEMENTCACHESIZE, NUMBEROFTOPQUERIESTOREPORT,TIMETOKEEPQUERIESINMINUTES, STATEMENTTIMEOUT, PASSWORD, MAXCACHESIZE);

    /**
     * Set the property.
     *
     * @param property Property Name to be set.
     * @param value    Value of property to be set.
     */
    public void setDetail(int property, String value) {
        details.put(property, TranslatedConfigView.expandConfigValue(value));
    }

    /**
     * Get the value of property
     *
     * @param property whose value is required
     * @return value of the property.
     */
    public String getDetail(int property) {
        if (details.containsKey(property)) {
            return details.get(property);
        } else {
            return null;
        }
    }

    /**
     * Checks whether two DataSourceSpec objects
     * are equal or not.
     *
     * @param obj Instance of DataSourceSpec object.
     */
    @Override
    public boolean equals(Object obj) {
        if (obj instanceof DataSourceSpec) {
            return this.details.equals(((DataSourceSpec) obj).details);
        }
        return false;
    }

    /**
     * Retrieves the hashCode of this DataSourceSpec object.
     *
     * @return hashCode of this object.
     */
    @Override
    public int hashCode() {
        return this.details.hashCode();
    }


    /**
     * If any keys don't exist from the other side, ignore the differences,
     * as specified by the ignoredList
     */
    private static class ConcurrentIgnoredHashMap extends ConcurrentHashMap
    {
        public ConcurrentIgnoredHashMap(Integer... ignoredList) {
            this.ignoredList = Arrays.asList(ignoredList);
        }

        @Override
        public boolean equals(Object o) {
            if(!(o instanceof ConcurrentIgnoredHashMap)) {
                return false;
            }
            ConcurrentIgnoredHashMap rhs = (ConcurrentIgnoredHashMap)o;
            Containment ignoreVals = checkIgnoredKeys(rhs);
            if( (ignoreVals == Containment.ONE_CONTAINS) ||  (ignoreVals == Containment.BOTH_CONTAIN)) {
                return makeIgnoredMap(this).equals(makeIgnoredMap(rhs));
            } else {
                return super.equals(rhs);
            }
        }

        @Override
        public int hashCode() {
            if(checkIgnoredKeys(null) != Containment.NONE_CONTAIN) {
                return makeIgnoredMap(this).hashCode();
            }
            else {
                return super.hashCode();
            }
        }

        private Map makeIgnoredMap(ConcurrentIgnoredHashMap map) {
            Map rv = new HashMap<>(map);
            for(Integer ignoredValue : ignoredList) {
                rv.remove(ignoredValue);
            }
            return rv;
        }

        private Containment checkIgnoredKeys(ConcurrentIgnoredHashMap rhs) {
            for(Integer ignoredValue : ignoredList) {
                int numContainment = 0;
                if(containsKey(ignoredValue)) {
                    ++numContainment;
                }
                if(rhs != null && rhs.containsKey(ignoredValue)) {
                    ++numContainment;
                }
                if(numContainment > 0) {
                    return numContainment > 1? Containment.BOTH_CONTAIN : Containment.ONE_CONTAINS;
                }
            }
            return Containment.NONE_CONTAIN;
        }


        private enum Containment { NONE_CONTAIN, ONE_CONTAINS, BOTH_CONTAIN }


        private final List ignoredList;
        private static final long serialVersionUID = 1L;
    }
}