1448486c6SDamjan Jovanovic/************************************************************** 2*2bfabe85Smseidel * 3448486c6SDamjan Jovanovic * Licensed to the Apache Software Foundation (ASF) under one 4448486c6SDamjan Jovanovic * or more contributor license agreements. See the NOTICE file 5448486c6SDamjan Jovanovic * distributed with this work for additional information 6448486c6SDamjan Jovanovic * regarding copyright ownership. The ASF licenses this file 7448486c6SDamjan Jovanovic * to you under the Apache License, Version 2.0 (the 8448486c6SDamjan Jovanovic * "License"); you may not use this file except in compliance 9448486c6SDamjan Jovanovic * with the License. You may obtain a copy of the License at 10*2bfabe85Smseidel * 11448486c6SDamjan Jovanovic * http://www.apache.org/licenses/LICENSE-2.0 12*2bfabe85Smseidel * 13448486c6SDamjan Jovanovic * Unless required by applicable law or agreed to in writing, 14448486c6SDamjan Jovanovic * software distributed under the License is distributed on an 15448486c6SDamjan Jovanovic * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16448486c6SDamjan Jovanovic * KIND, either express or implied. See the License for the 17448486c6SDamjan Jovanovic * specific language governing permissions and limitations 18448486c6SDamjan Jovanovic * under the License. 19*2bfabe85Smseidel * 20448486c6SDamjan Jovanovic *************************************************************/ 21448486c6SDamjan Jovanovic 22448486c6SDamjan Jovanovic 23448486c6SDamjan Jovanovic 24448486c6SDamjan Jovanovic#ifndef __com_sun_star_logging_SyslogHandler_idl__ 25448486c6SDamjan Jovanovic#define __com_sun_star_logging_SyslogHandler_idl__ 26448486c6SDamjan Jovanovic 27*2bfabe85Smseidel#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 28448486c6SDamjan Jovanovic#include <com/sun/star/lang/IllegalArgumentException.idl> 29448486c6SDamjan Jovanovic#endif 30448486c6SDamjan Jovanovic#ifndef __com_sun_star_beans_NamedValue_idl__ 31448486c6SDamjan Jovanovic#include <com/sun/star/beans/NamedValue.idl> 32448486c6SDamjan Jovanovic#endif 33448486c6SDamjan Jovanovic 34448486c6SDamjan Jovanovic//============================================================================= 35448486c6SDamjan Jovanovic 36*2bfabe85Smseidelmodule com { module sun { module star { module logging { 37448486c6SDamjan Jovanovic 38448486c6SDamjan Jovanovicinterface XLogHandler; 39448486c6SDamjan Jovanovic 40448486c6SDamjan Jovanovic//============================================================================= 41448486c6SDamjan Jovanovic 42448486c6SDamjan Jovanovic/** specifies a component implementing a log handler whose output 43448486c6SDamjan Jovanovic channel is the syslog network protocol. 44448486c6SDamjan Jovanovic 45448486c6SDamjan Jovanovic <p>The handler will use the <code>Encoding</code> attribute of <type>XLogHandler</type> 46448486c6SDamjan Jovanovic to determine how to encode strings before actually writing them to the output 47448486c6SDamjan Jovanovic file.</p> 48448486c6SDamjan Jovanovic 49448486c6SDamjan Jovanovic <p>The output is sent over UDP to the given Host and Port 50448486c6SDamjan Jovanovic in RFC5424 format, in plaintext, with APPNAME "soffice" and facility USER. 51448486c6SDamjan Jovanovic LogLevel::SEVERE becomes syslog's "error" severity, LogLevel::WARNING becomes syslog's 52448486c6SDamjan Jovanovic "warning" severity, LogLevel::INFO and LogLevel::CONFIG become syslog's "notice" 53448486c6SDamjan Jovanovic severity, and LogLevel::FINE and below become syslog's "debug" severity.</p> 54448486c6SDamjan Jovanovic 55448486c6SDamjan Jovanovic @see XLogHandler::Encoding 56448486c6SDamjan Jovanovic 57*2bfabe85Smseidel @since OpenOffice 4.2 58448486c6SDamjan Jovanovic */ 59448486c6SDamjan Jovanovicservice SyslogHandler : XLogHandler 60448486c6SDamjan Jovanovic{ 61448486c6SDamjan Jovanovic /** creates an instance of the log handler 62448486c6SDamjan Jovanovic 63448486c6SDamjan Jovanovic @param Settings 64448486c6SDamjan Jovanovic contains the initial settings for the log handler 65448486c6SDamjan Jovanovic 66448486c6SDamjan Jovanovic <p>The following settings are recognized and supported: 67448486c6SDamjan Jovanovic <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li> 68448486c6SDamjan Jovanovic <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li> 69448486c6SDamjan Jovanovic <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li> 70448486c6SDamjan Jovanovic </ul></p> 71448486c6SDamjan Jovanovic 72448486c6SDamjan Jovanovic <p>Additionally, the following settings are required for this particular handler: 73448486c6SDamjan Jovanovic <ul><li><code>Host</code> - the hostname of the syslog server</li> 74448486c6SDamjan Jovanovic <li><code>Port</code> - the port of the syslog server</li> 75448486c6SDamjan Jovanovic </ul></p> 76448486c6SDamjan Jovanovic 77448486c6SDamjan Jovanovic @throws ::com::sun::star::lang::IllegalArgumentException 78448486c6SDamjan Jovanovic if <arg>Settings</args> contains settings whose value is of the wrong type. 79448486c6SDamjan Jovanovic */ 80448486c6SDamjan Jovanovic createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings ) 81448486c6SDamjan Jovanovic raises ( ::com::sun::star::lang::IllegalArgumentException ); 82448486c6SDamjan Jovanovic}; 83448486c6SDamjan Jovanovic 84448486c6SDamjan Jovanovic//============================================================================= 85448486c6SDamjan Jovanovic 86*2bfabe85Smseidel}; }; }; }; 87448486c6SDamjan Jovanovic 88448486c6SDamjan Jovanovic//============================================================================= 89448486c6SDamjan Jovanovic 90448486c6SDamjan Jovanovic#endif 91