offapi/com/sun/star/logging/XLogger.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XLogger.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_logging_XLogger_idl__
  32 #define __com_sun_star_logging_XLogger_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module logging {
  41
  42 interface XLogHandler;
  43
  44 //=============================================================================
  45
  46 /** implemented by a component which is able to log events.
  47
  48     <p>This interface is roughly designed after the
  49     <a href="http://java.sun.com/javase/6/docs/api/java/util/logging/package-summary.html">Java
  50     Logging API</a>. However, there are some differences, the major ones being:
  51     <ul><li>There's no support (yet) for filtering log events.</li>
  52         <li>There ain't no convenience menthods for logging.</li>
  53         <li>There's no localization support.</li>
  54         <li>Logger instances do not form a hierarchy.</li>
  55     </ul></p>
  56
  57     @since OOo 2.3
  58  */
  59 interface XLogger
  60 {
  61     /** denotes the name of the logger.
  62     */
  63     [attribute, readonly]   string  Name;
  64
  65     /** specifies which log events are logged or ignored.
  66
  67         @see LogLevel
  68     */
  69     [attribute]   long Level;
  70
  71     /** adds the given handler to the list of handlers.
  72
  73         <p>When an event is logged, the logger will create a <type>LogRecord</type>
  74         for this event, and pass this record to all registered handlers. Single handlers
  75         might or might not log those records at their own discretion, and depending on
  76         additional restrictions such as filters specified at handler level.</p>
  77
  78         <p>Note: The log level of the given handler (<member>XLogHandler::Level</member>) will
  79         not be touched. In particular, it will not be set to the logger's log level. It's
  80         the responsibility of the component which knits a logger with one or more
  81         log handlers to ensure that all loggers have appropriate levels set.</p>
  82
  83         @param LogHandler
  84             the handler to add to the list of handlers. The call is ignored if this
  85             parameter is <NULL/>.
  86     */
  87     void    addLogHandler( [in] XLogHandler LogHandler );
  88
  89     /** removes the given handler from the list of handlers.
  90
  91         @param LogHandler
  92             the handler to remove from the list of handlers. The call is ignored if this
  93             parameter is <NULL/>, or if the handler has not previously beed added.
  94     */
  95     void    removeLogHandler( [in] XLogHandler LogHandler );
  96
  97     /** determines whether logger instance would produce any output for the given level.
  98
  99         <p>The method can be used to optimize performance as maybe complex parameter evaluation
 100         in the <code>log</code> calls can be omitted if <code>isLoggable</code> evaluates to false.</p>
 101
 102         @param Level
 103             level to be checked against
 104
 105         @returns
 106             <TRUE/> if there would be some output for this XLogger for the given level, <FALSE/>
 107             otherwise. Note that a return value of <FALSE/> could also indicate that the logger
 108             does not have any log handlers associated with it.
 109
 110         @see addLogHandler
 111         @see removeLogHandler
 112     */
 113     boolean isLoggable( [in] long Level );
 114
 115     /** logs a given message
 116
 117         @param Level
 118             the log level of this message. If this level is smaller than the logger's <member>Level</member>
 119             attribute, then the call will be ignored.
 120
 121         @param Message
 122             the message to log
 123     */
 124     void    log( [in] long Level, [in] string Message );
 125
 126     /** logs a given message, detailing the source class and method at which the logged
 127         event occured.
 128
 129         @param Level
 130             the log level of this message. If this level is smaller than the logger's <member>Level</member>
 131             attribute, then the call will be ignored.
 132
 133         @param SourceClass
 134             the source class at which the logged event occured.
 135
 136         @param SourceMethod
 137             the source class at which the logged event occured.
 138
 139         @param Message
 140             the message to log
 141     */
 142     void    logp( [in] long Level, [in] string SourceClassName, [in] string SourceMethodName, [in] string Message );
 143 };
 144
 145 //=============================================================================
 146
 147 }; }; }; };
 148
 149 //=============================================================================
 150
 151 #endif