org.objectweb.util.monolog.wrapper.remote.api
Interface MonologFactoryProxy

All Known Implementing Classes:
MonologFactoryProxyImpl

public interface MonologFactoryProxy

Author:
S.Chassande-Barrioz

Method Summary
 void addHandlerToLogger(java.lang.String handlerName, java.lang.String loggerName)
          A TopicalLogger manages a list of Handler instances.
 void addTopicToLogger(java.lang.String topic, java.lang.String loggerName)
          This method allows adding a topic to a TopicalLogger.
 int compareTo(java.lang.String levelname1, java.lang.String levelname2)
          Compares two levels.
 boolean createHandler(java.lang.String hn, java.lang.String handlertype)
          Creates a new handler
 boolean defineLevel(java.lang.String name, int value)
          It defines a new Level with a name and an integer value.
 boolean defineLevel(java.lang.String name, java.lang.String value)
          It defines a new Level with a name and a string value.
 java.util.Map getAllHandlerAttributes()
          It retrieves the attributes of all handlers
 java.util.Map getHandlerAttributes(java.lang.String handlername)
          It retrieves the attributes of an handler
 java.lang.String[] getHandlerNames()
          It retrieves name of all handler managed by this factory.
 Level getLevel(int value)
          It retrieves a Level instance which the integer value is equals to the parameter.
 Level getLevel(java.lang.String name)
          It retrieves a Level instance which the name is equals to the parameter.
 Level[] getLevels()
          It retrieves all Level instances defined in this manager.
 LoggerInfo getLogger(java.lang.String loggername)
          Creates a logger if it does not exist.
 LoggerInfo getLogger(java.lang.String key, java.lang.String resourceBundleName)
          Creates a logger if it does not exist.
 LoggerInfo[] getLoggers()
          It retrieves a list of all loggers.
 java.util.Properties getMonologProperties()
           
 java.lang.String getResourceBundleName()
          Accessors to a resource bundle name associated to a LoggerFactory.
 void removeAllHandlersFromLogger(java.lang.String loggerName)
          A TopicalLogger manages a list of Handler instances.
 boolean removeHandler(java.lang.String handlername)
          It removes the handler which the name is specified by the parameter
 void removeHandlerFromLogger(java.lang.String handlerName, java.lang.String loggerName)
          A TopicalLogger manages a list of Handler instances.
 void removeLevel(java.lang.String name)
          It removes a Level instance to this manager.
 void removeTopicFromLogger(java.lang.String topic, java.lang.String loggerName)
          This method allows removing a topic to a TopicalLogger.
 void setAdditivity(boolean a, java.lang.String loggerName)
          It assigns the additivity flag for this logger instance.
 void setHandlerAttribute(java.lang.String handlername, java.lang.String attributeName, java.lang.String value)
          Assignes a value to an handler attribute.
 void setResourceBundleName(java.lang.String resourceBundleName)
          Accessors to a resource bundle name associated to a LoggerFactory.
 

Method Detail

defineLevel

public boolean defineLevel(java.lang.String name,
                           int value)
                    throws java.rmi.RemoteException
It defines a new Level with a name and an integer value.

Parameters:
name - is the name of the new level
value - is the integer value of the new level
Returns:
true if the level has been created.
Throws:
java.rmi.RemoteException

defineLevel

public boolean defineLevel(java.lang.String name,
                           java.lang.String value)
                    throws java.rmi.RemoteException
It defines a new Level with a name and a string value. The string value is analyzed to obtain the integer value.

Parameters:
name - is the name of the new level
value - is the string value of the new level
Returns:
true if the level has been created.
Throws:
java.rmi.RemoteException

removeLevel

public void removeLevel(java.lang.String name)
                 throws java.rmi.RemoteException
It removes a Level instance to this manager.

Throws:
java.rmi.RemoteException

getLevel

public Level getLevel(java.lang.String name)
               throws java.rmi.RemoteException
It retrieves a Level instance which the name is equals to the parameter.

Parameters:
name - is the name of request Level
Returns:
a Leve instance or a null value if the level does not exist.
Throws:
java.rmi.RemoteException

getLevel

public Level getLevel(int value)
               throws java.rmi.RemoteException
It retrieves a Level instance which the integer value is equals to the parameter.

Parameters:
value - is the integer value of request Level
Returns:
a Leve instance or a null value if the level does not exist. As it is possible to define several Levels which have the same integer value this methods returns the Level instance of first name found in the list.
Throws:
java.rmi.RemoteException

getLevels

public Level[] getLevels()
                  throws java.rmi.RemoteException
It retrieves all Level instances defined in this manager.

Throws:
java.rmi.RemoteException

compareTo

public int compareTo(java.lang.String levelname1,
                     java.lang.String levelname2)
              throws java.rmi.RemoteException
Compares two levels.

Parameters:
levelname1 - is the name of the first level
levelname2 - is the name of the second level
Throws:
java.rmi.RemoteException

createHandler

public boolean createHandler(java.lang.String hn,
                             java.lang.String handlertype)
                      throws java.rmi.RemoteException
Creates a new handler

Parameters:
hn - is the name of the handler to create
handlertype - is the type of the parameter. The possible value are defined in this interface by the XXX_HANDLER_TYPE constants.
Returns:
true if the handler has been created
Throws:
java.rmi.RemoteException

removeHandler

public boolean removeHandler(java.lang.String handlername)
                      throws java.rmi.RemoteException
It removes the handler which the name is specified by the parameter

Parameters:
handlername - is the name of the handler
Returns:
true if the handler has been removed.
Throws:
java.rmi.RemoteException

getHandlerNames

public java.lang.String[] getHandlerNames()
                                   throws java.rmi.RemoteException
It retrieves name of all handler managed by this factory.

Throws:
java.rmi.RemoteException

getHandlerAttributes

public java.util.Map getHandlerAttributes(java.lang.String handlername)
                                   throws java.rmi.RemoteException
It retrieves the attributes of an handler

Parameters:
handlername - is the name of the handler
Returns:
a map containing the association between an attribute name (String) and an attribute value (String).
Throws:
java.rmi.RemoteException

getAllHandlerAttributes

public java.util.Map getAllHandlerAttributes()
                                      throws java.rmi.RemoteException
It retrieves the attributes of all handlers

Returns:
Map( String handlername, Map(String attributename, String attributevalue) )
Throws:
java.rmi.RemoteException

setHandlerAttribute

public void setHandlerAttribute(java.lang.String handlername,
                                java.lang.String attributeName,
                                java.lang.String value)
                         throws java.rmi.RemoteException
Assignes a value to an handler attribute.

Parameters:
handlername - is the name of the handler
attributeName - is the name of the attribute
value - is the new value of the attribute
Throws:
java.rmi.RemoteException

getLogger

public LoggerInfo getLogger(java.lang.String loggername)
                     throws java.rmi.RemoteException
Creates a logger if it does not exist.

Parameters:
loggername - is the name of the logger
Throws:
java.rmi.RemoteException

getLogger

public LoggerInfo getLogger(java.lang.String key,
                            java.lang.String resourceBundleName)
                     throws java.rmi.RemoteException
Creates a logger if it does not exist.

Parameters:
resourceBundleName - allows specifying the name of a resource bundle in order to internationalise the logging.
Throws:
java.rmi.RemoteException

getResourceBundleName

public java.lang.String getResourceBundleName()
                                       throws java.rmi.RemoteException
Accessors to a resource bundle name associated to a LoggerFactory.

Throws:
java.rmi.RemoteException

setResourceBundleName

public void setResourceBundleName(java.lang.String resourceBundleName)
                           throws java.rmi.RemoteException
Accessors to a resource bundle name associated to a LoggerFactory.

Throws:
java.rmi.RemoteException

getLoggers

public LoggerInfo[] getLoggers()
                        throws java.rmi.RemoteException
It retrieves a list of all loggers.

Throws:
java.rmi.RemoteException

addHandlerToLogger

public void addHandlerToLogger(java.lang.String handlerName,
                               java.lang.String loggerName)
                        throws java.rmi.RemoteException
A TopicalLogger manages a list of Handler instances. This method allows adding a handler to this list. The addHandler method returns true only if the Handler did not exist

Throws:
java.rmi.RemoteException

removeHandlerFromLogger

public void removeHandlerFromLogger(java.lang.String handlerName,
                                    java.lang.String loggerName)
                             throws java.rmi.RemoteException
A TopicalLogger manages a list of Handler instances. This method allows removing a handler to this list.

Throws:
java.rmi.RemoteException

removeAllHandlersFromLogger

public void removeAllHandlersFromLogger(java.lang.String loggerName)
                                 throws java.rmi.RemoteException
A TopicalLogger manages a list of Handler instances. This method allows removing all handler.

Throws:
java.rmi.RemoteException

setAdditivity

public void setAdditivity(boolean a,
                          java.lang.String loggerName)
                   throws java.rmi.RemoteException
It assigns the additivity flag for this logger instance.

Throws:
java.rmi.RemoteException

addTopicToLogger

public void addTopicToLogger(java.lang.String topic,
                             java.lang.String loggerName)
                      throws java.rmi.RemoteException
This method allows adding a topic to a TopicalLogger. This actions change the hierarchical structure, but also the list of handlers. The list of handlers of a TopicalLogger is composed of its handlers and all handlers inherited from its parents. Adding a topic changes the inherited handlers list.

Throws:
java.rmi.RemoteException

removeTopicFromLogger

public void removeTopicFromLogger(java.lang.String topic,
                                  java.lang.String loggerName)
                           throws java.rmi.RemoteException
This method allows removing a topic to a TopicalLogger. This actions change the hierarchical structure, but also the list of handlers. The list of handlers of a TopicalLogger is composed of its handlers and all handlers inherited from its parents. Removing a topic changes the inherited handlers list.

Throws:
java.rmi.RemoteException

getMonologProperties

public java.util.Properties getMonologProperties()
                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException