offapi/com/sun/star/logging/XLogHandler.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: XLogHandler.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_XLogHandler_idl__
  32 #define __com_sun_star_logging_XLogHandler_idl__
  33
  34 #ifndef __com_sun_star_lang_XComponent_idl__
  35 #include <com/sun/star/lang/XComponent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_logging_LogRecord_idl__
  39 #include <com/sun/star/logging/LogRecord.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_logging_XLogFormatter_idl__
  43 #include <com/sun/star/logging/XLogFormatter.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module logging {
  49
  50 //=============================================================================
  51
  52 /** provides possibilites to send <type>LogRecord</type>s to an arbitrary output
  53     channel.
  54
  55     @see XLogger
  56
  57     @since OOo 2.3
  58  */
  59 interface XLogHandler
  60 {
  61     /** allows life time control for the handler
  62
  63         <p>Disposing the handler effectively means closing the channel
  64         to which the handler forwards the log records.
  65     */
  66     interface ::com::sun::star::lang::XComponent;
  67
  68     /** specifies MIME charset name for the encoding to be used by this handler
  69
  70         <p>It depends on the concrete handler implementation whether or not this
  71         parameter is needed.<p>
  72
  73         @see http://www.iana.org/assignments/character-sets
  74     */
  75     [attribute] string Encoding;
  76
  77     /** specifies the formatter to be used by this handler.
  78     */
  79     [attribute] XLogFormatter   Formatter;
  80
  81     /** specifies the log level of this handler
  82
  83         <p>Different handlers can have different log levels, which again might be
  84         different from the log level of the <type>XLogger</type> for which the handlers
  85         are used.</p>
  86     */
  87     [attribute] long    Level;
  88
  89     /** flushes all buffered output of the handler
  90
  91         <p>Log handlers are allowed to buffer their output. Upon <code>flush</code>
  92         being called, they must flush all their buffers.</p>
  93     */
  94     void    flush();
  95
  96     /** publish the given log record at the handler's output channel.
  97
  98         @return
  99             <TRUE/> if and only if the record was actually published. A handler
 100             will not publish a record if its log level doesn't meet the handler's
 101             log level, if the record is filtered, or if any other handler-specified
 102             restrictions apply.
 103     */
 104     boolean publish( [in] LogRecord Record );
 105 };
 106
 107 //=============================================================================
 108
 109 }; }; }; };
 110
 111 //=============================================================================
 112
 113 #endif