1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_logging_SyslogHandler_idl__
25#define __com_sun_star_logging_SyslogHandler_idl__
26
27#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
28#include <com/sun/star/lang/IllegalArgumentException.idl>
29#endif
30#ifndef __com_sun_star_beans_NamedValue_idl__
31#include <com/sun/star/beans/NamedValue.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module logging {
37
38interface XLogHandler;
39
40//=============================================================================
41
42/** specifies a component implementing a log handler whose output
43    channel is the syslog network protocol.
44
45    <p>The handler will use the <code>Encoding</code> attribute of <type>XLogHandler</type>
46    to determine how to encode strings before actually writing them to the output
47    file.</p>
48
49    <p>The output is sent over UDP to the given Host and Port
50    in RFC5424 format, in plaintext, with APPNAME "soffice" and facility USER.
51    LogLevel::SEVERE becomes syslog's "error" severity, LogLevel::WARNING becomes syslog's
52    "warning" severity, LogLevel::INFO and LogLevel::CONFIG become syslog's "notice"
53    severity, and LogLevel::FINE and below become syslog's "debug" severity.</p>
54
55    @see XLogHandler::Encoding
56
57    @since OpenOffice 4.5
58 */
59service SyslogHandler : XLogHandler
60{
61    /** creates an instance of the log handler
62
63        @param Settings
64            contains the initial settings for the log handler
65
66            <p>The following settings are recognized and supported:
67            <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li>
68                <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li>
69                <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li>
70            </ul></p>
71
72            <p>Additionally, the following settings are required for this particular handler:
73            <ul><li><code>Host</code> - the hostname of the syslog server</li>
74                <li><code>Port</code> - the port of the syslog server</li>
75            </ul></p>
76
77        @throws ::com::sun::star::lang::IllegalArgumentException
78            if <arg>Settings</args> contains settings whose value is of the wrong type.
79    */
80    createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
81        raises ( ::com::sun::star::lang::IllegalArgumentException );
82};
83
84//=============================================================================
85
86}; }; }; };
87
88//=============================================================================
89
90#endif
91