fish.payara.microprofile.openapi.activation.OpenApiSniffer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
There is a newer version: 6.2024.6
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) [2020-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 fish.payara.microprofile.openapi.activation;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.logging.Level;
import java.util.logging.Logger;

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 OpenApiSniffer extends MicroProfileSniffer {

    private static final Logger LOGGER = Logger.getLogger(OpenApiSniffer.class.getName());

    public static final String[] OPENAPI_YAML_FILE_PATHS = {
        "META-INF/openapi.json",
        "WEB-INF/classes/META-INF/openapi.json",
        "META-INF/openapi.yaml",
        "WEB-INF/classes/META-INF/openapi.yaml",
        "META-INF/openapi.yml",
        "WEB-INF/classes/META-INF/openapi.yml",
    };

    @Override
    @SuppressWarnings("unchecked")
    public Class[] getAnnotationTypes() {
        return new Class[] {
            // All JAX-RS applications are valid applications for OpenAPI
            jakarta.ws.rs.Path.class,
            jakarta.ws.rs.ApplicationPath.class,
            // OpenAPI detector classes
            org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition.class
        };
    }

    @Override
    public boolean handles(ReadableArchive archive) {
        
        // Check for metrics.xml files
        try {
            for (String openApiFile : OPENAPI_YAML_FILE_PATHS) {
                if (archive.exists(openApiFile)) {
                    return true;
                }
            }
        } catch (IOException e) {
            LOGGER.log(Level.WARNING, "Error reading archive", e);
            return false;
        }

        return super.handles(archive);
    }

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

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