Class PacketLoggingConfiguration


  • public class PacketLoggingConfiguration
    extends Object
    Stores the configuration used by PacketLoggingService.
    Author:
    Damian Minkov
    • Field Detail

      • PACKET_LOGGING_ENABLED_PROPERTY_NAME

        public static final String PACKET_LOGGING_ENABLED_PROPERTY_NAME
        Configuration property for packet logging enabled/disabled.
        See Also:
        Constant Field Values
      • PACKET_LOGGING_SIP_ENABLED_PROPERTY_NAME

        public static final String PACKET_LOGGING_SIP_ENABLED_PROPERTY_NAME
        Configuration property for packet logging for sip protocol enabled/disabled.
        See Also:
        Constant Field Values
      • PACKET_LOGGING_JABBER_ENABLED_PROPERTY_NAME

        public static final String PACKET_LOGGING_JABBER_ENABLED_PROPERTY_NAME
        Configuration property for packet logging for jabber protocol enabled/disabled.
        See Also:
        Constant Field Values
      • PACKET_LOGGING_RTP_ENABLED_PROPERTY_NAME

        public static final String PACKET_LOGGING_RTP_ENABLED_PROPERTY_NAME
        Configuration property for packet logging for RTP enabled/disabled.
        See Also:
        Constant Field Values
      • PACKET_LOGGING_ICE4J_ENABLED_PROPERTY_NAME

        public static final String PACKET_LOGGING_ICE4J_ENABLED_PROPERTY_NAME
        Configuration property for packet logging for ICE4J enabled/disabled.
        See Also:
        Constant Field Values
      • PACKET_LOGGING_ARBITRARY_ENABLED_PROPERTY_NAME

        public static final String PACKET_LOGGING_ARBITRARY_ENABLED_PROPERTY_NAME
        Configuration property for enabling/disabling arbitrary packet logging. The default value is 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.
        See Also:
        Constant Field Values
      • PACKET_LOGGING_FILE_COUNT_PROPERTY_NAME

        public static final String PACKET_LOGGING_FILE_COUNT_PROPERTY_NAME
        Configuration property for packet logging file count.
        See Also:
        Constant Field Values
      • PACKET_LOGGING_FILE_SIZE_PROPERTY_NAME

        public static final String PACKET_LOGGING_FILE_SIZE_PROPERTY_NAME
        Configuration property for packet logging file size.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PacketLoggingConfiguration

        public PacketLoggingConfiguration()
    • Method Detail

      • isGlobalLoggingEnabled

        public boolean isGlobalLoggingEnabled()
        Checks whether packet logging is enabled in the configuration.
        Returns:
        true if packet logging is enabled.
      • isSipLoggingEnabled

        public boolean isSipLoggingEnabled()
        Checks whether packet logging is enabled in the configuration for sip protocol.
        Returns:
        true if packet logging is enabled for sip protocol.
      • isJabberLoggingEnabled

        public boolean isJabberLoggingEnabled()
        Checks whether packet logging is enabled in the configuration for jabber protocol.
        Returns:
        true if packet logging is enabled for jabber protocol.
      • isRTPLoggingEnabled

        public boolean isRTPLoggingEnabled()
        Checks whether packet logging is enabled in the configuration for RTP.
        Returns:
        true if packet logging is enabled for RTP.
      • isIce4JLoggingEnabled

        public boolean isIce4JLoggingEnabled()
        Checks whether packet logging is enabled in the configuration for Ice4J.
        Returns:
        true if packet logging is enabled for Ice4J.
      • isArbitraryLoggingEnabled

        public boolean isArbitraryLoggingEnabled()
        Checks whether packet logging is enabled in this configuration for arbitrary packets.
        Returns:
        true if packet logging is enabled for arbitrary packets.
      • getLimit

        public long getLimit()
        The limit for the file size. 0 means no limit.
        Returns:
        the file size limit.
      • getLogfileCount

        public int getLogfileCount()
        The counter for number of files.
        Returns:
        the number of file counts.
      • setGlobalLoggingEnabled

        public void setGlobalLoggingEnabled​(boolean enabled)
        Change whether packet logging is enabled.
        Parameters:
        enabled - true if we enable it.
      • setSipLoggingEnabled

        public void setSipLoggingEnabled​(boolean enabled)
        Change whether packet logging for sip protocol is enabled.
        Parameters:
        enabled - true if we enable it.
      • setJabberLoggingEnabled

        public void setJabberLoggingEnabled​(boolean enabled)
        Change whether packet logging for jabber protocol is enabled.
        Parameters:
        enabled - true if we enable it.
      • setRTPLoggingEnabled

        public void setRTPLoggingEnabled​(boolean enabled)
        Change whether packet logging for RTP is enabled.
        Parameters:
        enabled - true if we enable it.
      • setIce4JLoggingEnabled

        public void setIce4JLoggingEnabled​(boolean enabled)
        Change whether packet logging for Ice4J is enabled.
        Parameters:
        enabled - true if we enable it.
      • setArbitraryLoggingEnabled

        public void setArbitraryLoggingEnabled​(boolean enabled)
        Change whether packet logging for arbitrary packets is enabled.
        Parameters:
        enabled - true if we enable it.
      • setLimit

        public void setLimit​(long limit)
        Changes the file size limit.
        Parameters:
        limit - the new limit size.
      • setLogfileCount

        public void setLogfileCount​(int logfileCount)
        Changes file count.
        Parameters:
        logfileCount - the new file count.