1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_logging_XLogHandler_idl__
29#define __com_sun_star_logging_XLogHandler_idl__
30
31#ifndef __com_sun_star_lang_XComponent_idl__
32#include <com/sun/star/lang/XComponent.idl>
33#endif
34
35#ifndef __com_sun_star_logging_LogRecord_idl__
36#include <com/sun/star/logging/LogRecord.idl>
37#endif
38
39#ifndef __com_sun_star_logging_XLogFormatter_idl__
40#include <com/sun/star/logging/XLogFormatter.idl>
41#endif
42
43//=============================================================================
44
45module com { module sun { module star { module logging {
46
47//=============================================================================
48
49/** provides possibilites to send <type>LogRecord</type>s to an arbitrary output
50    channel.
51
52    @see XLogger
53
54    @since OOo 2.3
55 */
56published interface XLogHandler
57{
58    /** allows life time control for the handler
59
60        <p>Disposing the handler effectively means closing the channel
61        to which the handler forwards the log records.
62    */
63    interface ::com::sun::star::lang::XComponent;
64
65    /** specifies MIME charset name for the encoding to be used by this handler
66
67        <p>It depends on the concrete handler implementation whether or not this
68        parameter is needed.<p>
69
70        @see http://www.iana.org/assignments/character-sets
71    */
72    [attribute] string Encoding;
73
74    /** specifies the formatter to be used by this handler.
75    */
76    [attribute] XLogFormatter   Formatter;
77
78    /** specifies the log level of this handler
79
80        <p>Different handlers can have different log levels, which again might be
81        different from the log level of the <type>XLogger</type> for which the handlers
82        are used.</p>
83    */
84    [attribute] long    Level;
85
86    /** flushes all buffered output of the handler
87
88        <p>Log handlers are allowed to buffer their output. Upon <code>flush</code>
89        being called, they must flush all their buffers.</p>
90    */
91    void    flush();
92
93    /** publish the given log record at the handler's output channel.
94
95        @return
96            <TRUE/> if and only if the record was actually published. A handler
97            will not publish a record if its log level doesn't meet the handler's
98            log level, if the record is filtered, or if any other handler-specified
99            restrictions apply.
100    */
101    boolean publish( [in] LogRecord Record );
102};
103
104//=============================================================================
105
106}; }; }; };
107
108//=============================================================================
109
110#endif
111