org.xwiki.classloader.NamespaceURLClassLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-classloader-api Show documentation
XWiki Commons - ClassLoader - API
There is a newer version: 16.10.0-rc-1
Show newest version
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.classloader;

import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.net.URLStreamHandlerFactory;
import java.util.Arrays;
import java.util.stream.Collectors;

/**
 * An {@link ExtendedURLClassLoader} associated with a namespace. The namespace can be anything. For example it's used
 * by the Extension Manager to have one classloader per wiki using a namespace of the type {@code wiki:wikiname}.
 *
 * @version $Id: e4059293f2eda9802ac2b09628796d7ea08e4bfa $
 * @since 4.0M1
 */
public class NamespaceURLClassLoader extends ExtendedURLClassLoader
{
    private static final URL[] EMPTY_URIS = new URL[] {};

    private boolean closed;

    /**
     * @param uris the search path
     * @param parent the parent class loader
     * @param namespace see {@link #getNamespace()}
     * @deprecated since 12.5RC1 prefer using
     *             {@link NamespaceURLClassLoader#NamespaceURLClassLoader(URL[], ClassLoader, String)}.
     */
    @Deprecated
    public NamespaceURLClassLoader(URI[] uris, ClassLoader parent, String namespace)
    {
        this(Arrays.stream(uris).map(uri -> {
            try {
                return uri.toURL();
            } catch (MalformedURLException e) {
                throw new RuntimeException(e);
            }
        }).collect(Collectors.toList()).toArray(new URL[0]), parent, namespace);
    }

    /**
     * @param urls the search path.
     * @param parent the parent class loader
     * @param namespace see {@link #getNamespace()}
     * @since 12.5RC1
     */
    public NamespaceURLClassLoader(URL[] urls, ClassLoader parent, String namespace)
    {
        this(urls, parent, null, namespace);
    }

    /**
     * @param urls the search path.
     * @param parent the parent class loader
     * @param factory the URLStreamHandlerFactory to use when creating URLs
     * @param namespace see {@link #getNamespace()}
     * @since 12.7
     * @since 12.10.10
     * @since 13.4.4
     */
    public NamespaceURLClassLoader(URL[] urls, ClassLoader parent, URLStreamHandlerFactory factory, String namespace)
    {
        super(namespace, urls, parent, factory);
    }

    /**
     * @param parent the parent class loader
     * @param namespace see {@link #getNamespace()}
     * @since 12.5RC1
     */
    public NamespaceURLClassLoader(ClassLoader parent, String namespace)
    {
        this(EMPTY_URIS, parent, namespace);
    }

    /**
     * @param parent the parent class loader
     * @param factory the URLStreamHandlerFactory to use when creating URLs
     * @param namespace see {@link #getNamespace()}
     * @since 12.7
     * @since 12.10.10
     * @since 13.4.4
     */
    public NamespaceURLClassLoader(ClassLoader parent, URLStreamHandlerFactory factory, String namespace)
    {
        this(EMPTY_URIS, parent, factory, namespace);
    }

    /**
     * @return the namespace associated with the classloader
     */
    public String getNamespace()
    {
        return getName();
    }

    /**
     * @return true of the class loader is closed
     * @since 13.7RC1
     */
    public boolean isClosed()
    {
        return this.closed;
    }

    @Override
    public void close() throws IOException
    {
        super.close();

        this.closed = true;
    }
}