org.jitsi.service.packetlogging.PacketLoggingConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * 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 org.jitsi.service.packetlogging;

/**
 * Stores the configuration used by {@code PacketLoggingService}.
 *
 * @author Damian Minkov
 */
public class PacketLoggingConfiguration
{
    /**
     * Configuration property for packet logging enabled/disabled.
     */
    public final static String PACKET_LOGGING_ENABLED_PROPERTY_NAME
        = "net.java.sip.communicator.packetlogging.PACKET_LOGGING_ENABLED";

    /**
     * Configuration property for packet logging for
     * sip protocol enabled/disabled.
     */
    public final static String PACKET_LOGGING_SIP_ENABLED_PROPERTY_NAME
        = "net.java.sip.communicator.packetlogging.PACKET_LOGGING_SIP_ENABLED";

    /**
     * Configuration property for packet logging for
     * jabber protocol enabled/disabled.
     */
    public final static String PACKET_LOGGING_JABBER_ENABLED_PROPERTY_NAME
        = "net.java.sip.communicator.packetlogging.PACKET_LOGGING_JABBER_ENABLED";

    /**
     * Configuration property for packet logging for
     * RTP enabled/disabled.
     */
    public final static String PACKET_LOGGING_RTP_ENABLED_PROPERTY_NAME
        = "net.java.sip.communicator.packetlogging.PACKET_LOGGING_RTP_ENABLED";

    /**
     * Configuration property for packet logging for
     * ICE4J enabled/disabled.
     */
    public final static String PACKET_LOGGING_ICE4J_ENABLED_PROPERTY_NAME
        = "net.java.sip.communicator.packetlogging.PACKET_LOGGING_ICE4J_ENABLED";

    /**
     * Configuration property for enabling/disabling arbitrary packet logging.
     * The default value is {@code false} because the arbitrary packet logging
     * was designed for the purposes of debugging, it dramatically increases the
     * number of logged packets and, thus, noticeably impacts the performance of
     * the library.
     */
    public final static String PACKET_LOGGING_ARBITRARY_ENABLED_PROPERTY_NAME
        = "net.java.sip.communicator.packetlogging." +
            "PACKET_LOGGING_ARBITRARY_ENABLED";

    /**
     * Configuration property for packet logging file count.
     */
    public final static String PACKET_LOGGING_FILE_COUNT_PROPERTY_NAME
        = "net.java.sip.communicator.packetlogging.PACKET_LOGGING_FILE_COUNT";

    /**
     * Configuration property for packet logging file size.
     */
    public final static String PACKET_LOGGING_FILE_SIZE_PROPERTY_NAME
        = "net.java.sip.communicator.packetlogging.PACKET_LOGGING_FILE_SIZE";

    /**
     * Is {@code PacketLoggingService} enabled.
     */
    private boolean globalLoggingEnabled = true;

    /**
     * Is {@code PacketLoggingService} enabled for sip protocol.
     */
    private boolean sipLoggingEnabled = true;

    /**
     * Is {@code PacketLoggingService} enabled for jabber protocol.
     */
    private boolean jabberLoggingEnabled = true;

    /**
     * Is {@code PacketLoggingService} enabled for rtp.
     */
    private boolean rtpLoggingEnabled = true;

    /**
     * Is {@code PacketLoggingService} enabled for ice4j.
     */
    private boolean ice4jLoggingEnabled = true;

    /**
     * Is {@code PacketLoggingService} enabled for arbitrary packets. The
     * arbitrary packet logging was designed for the purposes of debugging. Its
     * use in production environments is discouraged because it dramatically
     * increases the number of logged packets and, thus, noticeably impacts the
     * performance of the library.
     */
    private boolean arbitraryLoggingEnabled = false;

    /**
     * The limit for the file size.
     * 0 means no limit.
     */
    private long limit = 5000000;

     /**
     * The counter for number of files.
     */
    private int logfileCount = 3;

    /**
     * Checks whether packet logging is enabled in the configuration.
     * @return true if packet logging is enabled.
     */
    public boolean isGlobalLoggingEnabled()
    {
        return globalLoggingEnabled;
    }

    /**
     * Checks whether packet logging is enabled in the configuration
     * for sip protocol.
     * @return true if packet logging is enabled for sip protocol.
     */
    public boolean isSipLoggingEnabled()
    {
        return sipLoggingEnabled;
    }

    /**
     * Checks whether packet logging is enabled in the configuration
     * for jabber protocol.
     * @return true if packet logging is enabled for jabber protocol.
     */
    public boolean isJabberLoggingEnabled()
    {
        return jabberLoggingEnabled;
    }

    /**
     * Checks whether packet logging is enabled in the configuration
     * for RTP.
     * @return true if packet logging is enabled for RTP.
     */
    public boolean isRTPLoggingEnabled()
    {
        return rtpLoggingEnabled;
    }

    /**
     * Checks whether packet logging is enabled in the configuration
     * for Ice4J.
     * @return true if packet logging is enabled for Ice4J.
     */
    public boolean isIce4JLoggingEnabled()
    {
        return ice4jLoggingEnabled;
    }

    /**
     * Checks whether packet logging is enabled in this configuration for
     * arbitrary packets.
     *
     * @return true if packet logging is enabled for arbitrary packets.
     */
    public boolean isArbitraryLoggingEnabled()
    {
        return arbitraryLoggingEnabled;
    }

    /**
     * The limit for the file size. 0 means no limit.
     * @return the file size limit.
     */
    public long getLimit()
    {
        return limit;
    }

    /**
     * The counter for number of files.
     * @return the number of file counts.
     */
    public int getLogfileCount()
    {
        return logfileCount;
    }

    /**
     * Change whether packet logging is enabled.
     * @param enabled true if we enable it.
     */
    public void setGlobalLoggingEnabled(boolean enabled)
    {
        if(!enabled)
        {
            // as we are globally off, set it and to services
            arbitraryLoggingEnabled = false;
            ice4jLoggingEnabled = false;
            jabberLoggingEnabled = false;
            rtpLoggingEnabled = false;
            sipLoggingEnabled = false;
        }

        globalLoggingEnabled = enabled;
    }

    /**
     * Change whether packet logging for sip protocol is enabled.
     * @param enabled true if we enable it.
     */
    public void setSipLoggingEnabled(boolean enabled)
    {
        sipLoggingEnabled = enabled;
    }

    /**
     * Change whether packet logging for jabber protocol is enabled.
     * @param enabled true if we enable it.
     */
    public void setJabberLoggingEnabled(boolean enabled)
    {
        jabberLoggingEnabled = enabled;
    }

    /**
     * Change whether packet logging for RTP is enabled.
     * @param enabled true if we enable it.
     */
    public void setRTPLoggingEnabled(boolean enabled)
    {
        rtpLoggingEnabled = enabled;
    }

    /**
     * Change whether packet logging for Ice4J is enabled.
     * @param enabled true if we enable it.
     */
    public void setIce4JLoggingEnabled(boolean enabled)
    {
        ice4jLoggingEnabled = enabled;
    }

    /**
     * Change whether packet logging for arbitrary packets is enabled.
     * @param enabled true if we enable it.
     */
    public void setArbitraryLoggingEnabled(boolean enabled)
    {
        arbitraryLoggingEnabled = enabled;
    }

    /**
     * Changes the file size limit.
     * @param limit the new limit size.
     */
    public void setLimit(long limit)
    {
        this.limit = limit;
    }

    /**
     * Changes file count.
     * @param logfileCount the new file count.
     */
    public void setLogfileCount(int logfileCount)
    {
        this.logfileCount = logfileCount;
    }
}