org.eclipse.ditto.connectivity.service.messaging.monitoring.logs.MuteableConnectionLogger Maven / Gradle / Ivy

/*
 * Copyright (c) 2019 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */

package org.eclipse.ditto.connectivity.service.messaging.monitoring.logs;

/**
 * A connection logger that can be muted, i.e. messages log messages won't be stored.
 */
interface MuteableConnectionLogger extends ConnectionLogger {

    /**
     * Mutes the logger. No messages will be stored after muting.
     */
    void mute();

    /**
     * Unmutes the logger. Messages will be stored after unmuting.
     */
    void unmute();

    /**
     * Check if the logger is currently muted.
     * @return {@code true} if the logger is currently muted.
     */
    boolean isMuted();

}