org.eclipse.jetty.util.ClassVisibilityChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetty-util Show documentation
Utility classes for Jetty
There is a newer version: 12.1.0.alpha0
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.util;

/**
 * Interface to be implemented by classes capable of checking class visibility
 * for a context.
 */
public interface ClassVisibilityChecker
{
    /**
     * Is the class a Protected (System) Class.
     * A System class is a class that is visible to a web application,
     * but that cannot be overridden by the contents of WEB-INF/lib or
     * WEB-INF/classes
     *
     * @param clazz The fully qualified name of the class.
     * @return True if the class is a system class.
     */
    boolean isProtectedClass(Class clazz);

    /**
     * Is the class a Hidden (Server) Class.
     * A Server class is a class that is part of the implementation of
     * the server and is NOT visible to a web application. The web
     * application may provide its own implementation of the class,
     * to be loaded from WEB-INF/lib or WEB-INF/classes
     *
     * @param clazz The fully qualified name of the class.
     * @return True if the class is a server class.
     */
    boolean isHiddenClass(Class clazz);

    /**
     * Is the class a System Class.
     * A System class is a class that is visible to a web application,
     * but that cannot be overridden by the contents of WEB-INF/lib or
     * WEB-INF/classes
     *
     * @param clazz The fully qualified name of the class.
     * @return True if the class is a system class.
     * @deprecated use {@link #isProtectedClass(Class)}
     */
    @Deprecated (forRemoval = true, since = "12.0.9")
    default boolean isSystemClass(Class clazz)
    {
        return isProtectedClass(clazz);
    }

    /**
     * Is the class a Server Class.
     * A Server class is a class that is part of the implementation of
     * the server and is NOT visible to a web application. The web
     * application may provide its own implementation of the class,
     * to be loaded from WEB-INF/lib or WEB-INF/classes
     *
     * @param clazz The fully qualified name of the class.
     * @return True if the class is a server class.
     * @deprecated use {@link #isHiddenClass(Class)}
     */
    @Deprecated (forRemoval = true, since = "12.0.9")
    default boolean isServerClass(Class clazz)
    {
        return isHiddenClass(clazz);
    }
}