org.glassfish.internal.deployment.SnifferManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of internal-api Show documentation

There is a newer version: 8.0.0-JDK17-M9

/*
 * Copyright (c) 2022, 2022 Contributors to the Eclipse Foundation.
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.internal.deployment;

import java.net.URI;
import java.util.Collection;
import java.util.List;

import org.glassfish.api.container.Sniffer;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.hk2.classmodel.reflect.Types;
import org.jvnet.hk2.annotations.Contract;

/**
 * Service for easy access to sniffers.
 */
@Contract
public interface SnifferManager {

    /**
     * Return a sniffer instance based on its registered name
     *
     * @param name the sniffer service registration name
     * @return the sniffer instance of null if not found.
     */
    Sniffer getSniffer(String name);

    /**
     * Returns true if no sniffer/container is registered in the service locator.
     *
     * @return true if not sniffer is registered
     */
    boolean hasNoSniffers();

    /**
     * Returns all the presently registered sniffers
     *
     * @return Collection (possibly empty but never null) of Sniffer
     */
    Collection getSniffers();

    /**
     * Returns a collection of sniffers that recognized some parts of the passed archive as components their container
     * handle.
     *
     * If no sniffer recognize the passed archive, an empty collection is returned.
     *
     * @param context the deployment context
     * @return possibly empty collection of sniffers that handle the passed archive.
     */
    Collection getSniffers(DeploymentContext context);

    Collection getSniffers(DeploymentContext context, List uris, Types types);
}