org.jlf.log
Interface RemoteLogManager

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
RemoteLogManagerImpl

public interface RemoteLogManager
extends java.rmi.Remote

RemoteLogManager is the RMI interface to the RemoteLogManagerImpl class so that RMI clients can control the application's logs.

See Also:
RemoteLogManagerImpl, LogManager

Method Summary
 void addLoggingMechanism(java.lang.String logName, java.lang.String mechanismName)
          Adds a logging mechanism to the log given.
 java.lang.String getLogFieldSeparator(java.lang.String logName)
          Gets the current log field separator of a particular log.
 int getLoggingLevel(java.lang.String logName)
          Gets the current logging level of a particular log.
 java.lang.String[] getLoggingMechanismNames(java.lang.String logName)
          Returns all of the names of the logging mechanisms currently active for the log given as input.
 java.lang.String[] getLogNames()
          Retrieves all of the names of the logs registered in the virtual machine.
 void logString(java.lang.String logName, java.lang.String logString, int loggingLevel)
          Adds a message string to the log if the log's level is currently set at or above the loggingLevel passed in.
 void removeLoggingMechanism(java.lang.String logName, java.lang.String mechanismName)
          Removes a logging mechanism from the log given.
 void setLogFieldSeparator(java.lang.String logName, java.lang.String logFieldSeparator)
          Resets the current log field separator of a particular log.
 void setLoggingLevel(java.lang.String logName, int loggingLevel)
          Resets the current logging level of a particular log.
 

Method Detail

getLogNames

public java.lang.String[] getLogNames()
                               throws java.rmi.RemoteException
Retrieves all of the names of the logs registered in the virtual machine.

Throws:
java.rmi.RemoteException

getLoggingLevel

public int getLoggingLevel(java.lang.String logName)
                    throws java.rmi.RemoteException
Gets the current logging level of a particular log.

Parameters:
logName - The name of the log as a string
java.rmi.RemoteException

setLoggingLevel

public void setLoggingLevel(java.lang.String logName,
                            int loggingLevel)
                     throws java.rmi.RemoteException
Resets the current logging level of a particular log.

Parameters:
logName - The name of the log as a string
java.rmi.RemoteException

getLogFieldSeparator

public java.lang.String getLogFieldSeparator(java.lang.String logName)
                                      throws java.rmi.RemoteException
Gets the current log field separator of a particular log.

Parameters:
logName - The name of the log as a string
java.rmi.RemoteException

setLogFieldSeparator

public void setLogFieldSeparator(java.lang.String logName,
                                 java.lang.String logFieldSeparator)
                          throws java.rmi.RemoteException
Resets the current log field separator of a particular log.

Parameters:
logName - The name of the log as a string
java.rmi.RemoteException

getLoggingMechanismNames

public java.lang.String[] getLoggingMechanismNames(java.lang.String logName)
                                            throws java.rmi.RemoteException
Returns all of the names of the logging mechanisms currently active for the log given as input.

Parameters:
logName - The name of the log as a string
java.rmi.RemoteException

addLoggingMechanism

public void addLoggingMechanism(java.lang.String logName,
                                java.lang.String mechanismName)
                         throws java.rmi.RemoteException
Adds a logging mechanism to the log given.

Parameters:
logName - The name of the log as a string
java.rmi.RemoteException

removeLoggingMechanism

public void removeLoggingMechanism(java.lang.String logName,
                                   java.lang.String mechanismName)
                            throws java.rmi.RemoteException
Removes a logging mechanism from the log given.

Parameters:
logName - The name of the log as a string
java.rmi.RemoteException

logString

public void logString(java.lang.String logName,
                      java.lang.String logString,
                      int loggingLevel)
               throws java.rmi.RemoteException
Adds a message string to the log if the log's level is currently set at or above the loggingLevel passed in.

Parameters:
logName - The name of the log as a string
logString - The string to write to all logging mechanisms
loggingLevel - The level at which to log the string.
java.rmi.RemoteException