org.gudy.azureus2.plugins.logging
Interface LoggerChannel

All Known Implementing Classes:
LoggerChannelImpl

public interface LoggerChannel

Manipulation of a subsection (a channel) of Azureus' logging. A logger channel is created or retrieve via Logger. Typically, a plugin has it's own channel which it can manipulate. All channels are part of Azureus logging as a whole, meaning anything logged here will also be fed to any functionality that operates on logging data (with the exception of Logger.getNullChannel(String)).

Since:
2.0.7.0

Field Summary
static int LT_ERROR
          Error Log Type
static int LT_INFORMATION
          Information Log Type
static int LT_WARNING
          Warning Log Type
 
Method Summary
 void addListener(LoggerChannelListener l)
          Add a LoggerChannelListener to this LoggerChannel
 boolean getForce()
           
 Logger getLogger()
          Retrieve the parent Logger object for this LoggerChannel.
 String getName()
          Returns the name of the Logger Channel
 boolean isEnabled()
          Indicates whether or not logging is enabled - use to optimise calls to the log methods that require resources to construct the message to be logged.
 void log(int log_type, String data)
          Log a message of a specific type to this channel's logger
 void log(Object[] relatedTo, int log_type, String data)
          Log a string against a list of objects
 void log(Object[] relatedTo, String data)
          Log an error against a list of objects with implicit type LT_INFORMATION
 void log(Object[] relatedTo, String data, Throwable error)
          Log an error against a list of objects
 void log(Object relatedTo, int log_type, String data)
          Log an error against an object.
 void log(Object relatedTo, String data)
          Log an error against an object with implicit type LT_INFORMATION
 void log(Object relatedTo, String data, Throwable error)
          Log an error against an object.
 void log(String data)
          log text with implicit type LT_INFORMATION
 void log(String data, Throwable error)
          log an error with implicit type of LT_ERROR
 void log(Throwable error)
          log an error with implicit type of LT_ERROR
 void logAlert(int alert_type, String message)
          raise an alert to the user, if UI present Note that messages shown to the user are filtered on unique message content So if you raise an identical alert the second + subsequent messages will not be shown.
 void logAlert(String message, Throwable e)
          Alert the user of an error
 void logAlertRepeatable(int alert_type, String message)
          Raise an alert to the user, if UI present.
 void logAlertRepeatable(String message, Throwable e)
          Raise an alert to the user, if UI present.
 void removeListener(LoggerChannelListener l)
          Remove a reviously added LoggerChannelListener
 void setDiagnostic()
          This causes the channel to also write to logs/name files in a cyclic fashion (c.f.
 void setDiagnostic(long max_file_size, boolean timestamp)
           
 void setForce(boolean force_to_file)
          logging to file is disabled by default in non-beta builds.
 

Field Detail

LT_INFORMATION

static final int LT_INFORMATION
Information Log Type

See Also:
Constant Field Values

LT_WARNING

static final int LT_WARNING
Warning Log Type

See Also:
Constant Field Values

LT_ERROR

static final int LT_ERROR
Error Log Type

See Also:
Constant Field Values
Method Detail

getName

String getName()
Returns the name of the Logger Channel

Returns:
Logger channel name
Since:
2.0.7.0

isEnabled

boolean isEnabled()
Indicates whether or not logging is enabled - use to optimise calls to the log methods that require resources to construct the message to be logged. Note that this doesn't apply to alerts - these will always be handled

Returns:
Enabled state of logging
Since:
2.3.0.2

setDiagnostic

void setDiagnostic()
This causes the channel to also write to logs/name files in a cyclic fashion (c.f. the debug_1/2._log files)

Since:
2.4.0.2

setDiagnostic

void setDiagnostic(long max_file_size,
                   boolean timestamp)

setForce

void setForce(boolean force_to_file)
logging to file is disabled by default in non-beta builds. This forces writing to file regardless

Parameters:
force_to_file -
Since:
4401

getForce

boolean getForce()
Returns:
Since:
4401

log

void log(int log_type,
         String data)
Log a message of a specific type to this channel's logger

Parameters:
log_type - LT_* constant
data - text to log
Since:
2.0.7.0

log

void log(String data)
log text with implicit type LT_INFORMATION

Parameters:
data - text to log
Since:
2.1.0.0

log

void log(Throwable error)
log an error with implicit type of LT_ERROR

Parameters:
error - Throwable object to log
Since:
2.0.7.0

log

void log(String data,
         Throwable error)
log an error with implicit type of LT_ERROR

Parameters:
data - text to log
error - Throwable object to log
Since:
2.0.7.0

log

void log(Object[] relatedTo,
         int log_type,
         String data)
Log a string against a list of objects

Parameters:
relatedTo - a list of what this log is related to (ex. Peer, Torrent, Download, Object)
log_type - LT_* constant
data - text to log
Since:
2.3.0.7

log

void log(Object relatedTo,
         int log_type,
         String data)
Log an error against an object.

Parameters:
relatedTo - What this log is related to (ex. Peer, Torrent, Download, Object, etc)
log_type - LT_* constant
data - text to log
Since:
2.3.0.7

log

void log(Object relatedTo,
         String data,
         Throwable error)
Log an error against an object.

Parameters:
relatedTo - What this log is related to (ex. Peer, Torrent, Download, Object, etc)
data - text to log
error - Error that will be appended to the log entry
Since:
2.3.0.7

log

void log(Object[] relatedTo,
         String data,
         Throwable error)
Log an error against a list of objects

Parameters:
relatedTo - a list of what this log is related to (ex. Peer, Torrent, Download, Object)
data - text to log
error - Error that will be appended to the log entry
Since:
2.3.0.7

log

void log(Object[] relatedTo,
         String data)
Log an error against a list of objects with implicit type LT_INFORMATION

Parameters:
relatedTo - a list of what this log is related to (ex. Peer, Torrent, Download, Object)
data - text to log
Since:
2.5.0.1

log

void log(Object relatedTo,
         String data)
Log an error against an object with implicit type LT_INFORMATION

Parameters:
relatedTo - What this log is related to (ex. Peer, Torrent, Download, Object, etc)
data - text to log
Since:
2.5.0.1

logAlert

void logAlert(int alert_type,
              String message)
raise an alert to the user, if UI present Note that messages shown to the user are filtered on unique message content So if you raise an identical alert the second + subsequent messages will not be shown. Thus, if you want "identical" messages to be shown, prefix them with something unique like a timestamp.

Parameters:
alert_type - LT_* constant
message - text to alert user with
Since:
2.0.8.0

logAlert

void logAlert(String message,
              Throwable e)
Alert the user of an error

Parameters:
message - text to alert user with
e - Error that will be attached to the alert
Since:
2.1.0.2

logAlertRepeatable

void logAlertRepeatable(int alert_type,
                        String message)
Raise an alert to the user, if UI present. Subsequent, identical messages will always generate an alert (i.e. duplicates won't be filtered)

Parameters:
alert_type - LT_* constant
message - text to alert user with
Since:
2.1.0.2

logAlertRepeatable

void logAlertRepeatable(String message,
                        Throwable e)
Raise an alert to the user, if UI present. Subsequent, identical messages will always generate an alert (i.e. duplicates won't be filtered)

Parameters:
message - text to alert user with
e - Error that will be attached to the alert
Since:
2.1.0.2

addListener

void addListener(LoggerChannelListener l)
Add a LoggerChannelListener to this LoggerChannel

Parameters:
l - Listener to add
Since:
2.0.8.0

removeListener

void removeListener(LoggerChannelListener l)
Remove a reviously added LoggerChannelListener

Parameters:
l - Listener to remove.
Since:
2.0.8.0

getLogger

Logger getLogger()
Retrieve the parent Logger object for this LoggerChannel.

Returns:
Logger object
Since:
2.3.0.0