fish.payara.microprofile.config.activation.ConfigSniffer Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) [2020] 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 fish.payara.microprofile.config.activation;

import java.lang.annotation.Annotation;

import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.hk2.api.PerLookup;
import org.jvnet.hk2.annotations.Service;

import fish.payara.microprofile.connector.MicroProfileSniffer;

@Service
@PerLookup
public class ConfigSniffer extends MicroProfileSniffer {

    @Override
    public boolean handles(ReadableArchive archive) {
        // Defer annotation processing to the deployer to make sure the ConfigProvider is started correctly
        return true;
    }

    @Override
    public String[] getIncompatibleSnifferTypes() {
        // This sniffer is always active, so don't throw errors for any other sniffers
        return new String[0];
    }

    @Override
    public boolean isUserVisible() {
        // Always active, so don't clutter the user with this information
        return false;
    }

    @Override
    public Class[] getAnnotationTypes() {
        return null;
    }

    @Override
    protected Class getContainersClass() {
        return ConfigContainer.class;
    }

    @Override
    public String getModuleType() {
        return "config";
    }
    
}