com.swirlds.logging.api.extensions.handler.LogHandlerFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-logging Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.5

Show newest version

/*
 * Copyright (C) 2023-2024 Hedera Hashgraph, LLC
 *
 * Licensed 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 com.swirlds.logging.api.extensions.handler;

import com.swirlds.config.api.Configuration;
import edu.umd.cs.findbugs.annotations.NonNull;

/**
 * A factory that creates {@link LogHandler}s. The factory is used by the Java SPI to create log handlers.
 *
 * @see LogHandler
 * @see java.util.ServiceLoader
 */
public interface LogHandlerFactory {

    /**
     * Creates a new log handler.
     *
     * @param handlerName the configuration key for the log handler
     * @param configuration the configuration
     * @return the log handler
     */
    @NonNull
    LogHandler create(@NonNull String handlerName, @NonNull Configuration configuration);

    /**
     * Name used to reference a handler type in the configuration. If the name is "console", then the configuration
     * would look like:
     *      *     logging.handler.NAME.type=console
     * 
     *
     * @return name
     */
    @NonNull
    String getTypeName();
}