com.ibm.retail.AEF.util
Interface LoggerControl

All Superinterfaces:
java.rmi.Remote

public interface LoggerControl
extends java.rmi.Remote

LoggerControl is an interface for enumerating the list of loggers, and for setting the level of a logger.


Method Summary
 void addSocketHandler(java.lang.String loggerName, java.lang.String host, int port)
          Adds a SocketHandler for a logger
 java.util.ArrayList getLoggerNames()
          Returns an array of the current logger names.
 void readConfiguration()
          Reloads the configuration file for logger properties
 void removeSocketHandler(java.lang.String loggerName, java.lang.String host, int port)
          Removes a SocketHandler for a logger
 void setLoggerLevel(java.lang.String loggerName, java.lang.String level)
          Sets the level of a logger.
 

Method Detail

setLoggerLevel

public void setLoggerLevel(java.lang.String loggerName,
                           java.lang.String level)
                    throws java.rmi.RemoteException,
                           AEFException
Sets the level of a logger.

Parameters:
loggerName - The name of the logger.
level - Valid levels are: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.INVALID_ARGUMENT, AEFConst.NO_SUCH_LOGGER
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_LOGGER_LEVEL
Common Errors

readConfiguration

public void readConfiguration()
                       throws java.rmi.RemoteException,
                              java.io.IOException
Reloads the configuration file for logger properties

Throws:
java.rmi.RemoteException
java.rmi.IOException
java.io.IOException

addSocketHandler

public void addSocketHandler(java.lang.String loggerName,
                             java.lang.String host,
                             int port)
                      throws java.rmi.RemoteException,
                             AEFException,
                             java.io.IOException
Adds a SocketHandler for a logger

Parameters:
loggerName - The name of the logger.
host - The host to log to.
port - The port to log to.
Throws:
java.rmi.RemoteException
java.rmi.IOException
AEFException - Among the possible AEFException error codes are:
AEFConst.INVALID_ARGUMENT, AEFConst.NO_SUCH_LOGGER
Common Errors
java.io.IOException

removeSocketHandler

public void removeSocketHandler(java.lang.String loggerName,
                                java.lang.String host,
                                int port)
                         throws java.rmi.RemoteException,
                                AEFException,
                                java.io.IOException
Removes a SocketHandler for a logger

Parameters:
loggerName - The name of the logger.
host - The host to log to.
port - The port to log to.
Throws:
java.rmi.RemoteException
java.rmi.IOException
AEFException - Among the possible AEFException error codes are:
AEFConst.INVALID_ARGUMENT, AEFConst.NO_SUCH_LOGGER
Common Errors
java.io.IOException

getLoggerNames

public java.util.ArrayList getLoggerNames()
                                   throws java.rmi.RemoteException
Returns an array of the current logger names.

Returns:
ArrayList
Throws:
java.rmi.RemoteException


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004