org.apache.logging.log4j.plugins.model.PluginCache Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.logging.log4j.plugins.model;

import java.io.BufferedInputStream;
import java.io.DataInputStream;
import java.io.IOException;
import java.net.URL;
import java.util.Enumeration;
import java.util.Locale;
import java.util.Map;
import java.util.TreeMap;

public class PluginCache {
    private final Map> namespaces =
        new TreeMap<>();

    /**
     * Returns all namespaces of plugins in this cache.
     *
     * @return all namespaces of plugins in this cache.
     * @since 2.1
     */
    public Map> getAllNamespaces() {
        return namespaces;
    }

    /**
     * Gets or creates a namespace of plugins.
     *
     * @param namespace namespace to look up.
     * @return plugin mapping of names to plugin entries.
     */
    public Map getNamespace(final String namespace) {
        final String key = namespace.toLowerCase(Locale.ROOT);
        return namespaces.computeIfAbsent(key, ignored -> new TreeMap<>());
    }

    /**
     * Loads and merges all the Log4j plugin cache files specified. Usually, this is obtained via a ClassLoader.
     *
     * @param resources URLs to all the desired plugin cache files to load.
     * @throws IOException if an I/O exception occurs.
     */
    public void loadCacheFiles(final Enumeration resources) throws IOException {
        namespaces.clear();
        while (resources.hasMoreElements()) {
            final URL url = resources.nextElement();
            try (final DataInputStream in = new DataInputStream(new BufferedInputStream(url.openStream()))) {
                final int count = in.readInt();
                for (int i = 0; i < count; i++) {
                    final var builder = PluginEntry.builder().setNamespace(in.readUTF());
                    final Map m = getNamespace(builder.getNamespace());
                    final int entries = in.readInt();
                    for (int j = 0; j < entries; j++) {
                        // Must always read all parts of the entry, even if not adding, so that the stream progresses
                        final var entry = builder.setKey(in.readUTF())
                                .setClassName(in.readUTF())
                                .setName(in.readUTF())
                                .setPrintable(in.readBoolean())
                                .setDeferChildren(in.readBoolean())
                                .get();
                        m.putIfAbsent(entry.getKey(), entry);
                    }
                }
            }
        }
    }

    /**
     * Gets the number of plugin namespaces registered.
     *
     * @return number of plugin namespaces in cache.
     */
    public int size() {
        return namespaces.size();
    }
}