com.sun.enterprise.server.logging.CommonFormatter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2021 Payara Foundation 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://github.com/payara/Payara/blob/master/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 glassfish/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation 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.
 */
package com.sun.enterprise.server.logging;

import org.glassfish.api.VersionInfo;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.api.Globals;

import java.util.logging.Formatter;

/**
 * A Parent Formatter supporting the Exclude Fields Support
 * and providing the logic for the Product version value.
 */
public abstract class CommonFormatter extends Formatter {

    private final ExcludeFieldsSupport excludeFieldsSupport;

    private final ServiceLocator habitat;
    private String productId = "";

    // Account for instances of (Formatter) Class.forName(formatter).newInstance();
    protected CommonFormatter() {
        this(null);
    }

    protected CommonFormatter(String excludeFields) {
        super();
        habitat = Globals.getDefaultBaseServiceLocator();
        this.excludeFieldsSupport = new ExcludeFieldsSupport(excludeFields);
    }

    protected boolean isFieldExcluded(ExcludeFieldsSupport.SupplementalAttribute excludeField) {
        return excludeFieldsSupport.isSet(excludeField);
    }

    /**
     * Payara can override this to specify product version.
     * @return The string value of the product id.
     */
    protected String getProductId() {
        if (habitat != null) {
            VersionInfo version = habitat.getService(VersionInfo.class);
            if (productId.isEmpty() && version != null) {
                productId = version.getAbbreviatedProductName() +
                        ' ' +
                        version.getVersionPrefix() +
                        version.getMajorVersion() +
                        '.' +
                        version.getMinorVersion() +
                        '.' +
                        version.getUpdateVersion();
            }
        }
        return productId;
    }

}