12dc7e66cSDamjan Jovanovic/************************************************************** 2*a1b6a2a0Smseidel * 32dc7e66cSDamjan Jovanovic * Licensed to the Apache Software Foundation (ASF) under one 42dc7e66cSDamjan Jovanovic * or more contributor license agreements. See the NOTICE file 52dc7e66cSDamjan Jovanovic * distributed with this work for additional information 62dc7e66cSDamjan Jovanovic * regarding copyright ownership. The ASF licenses this file 72dc7e66cSDamjan Jovanovic * to you under the Apache License, Version 2.0 (the 82dc7e66cSDamjan Jovanovic * "License"); you may not use this file except in compliance 92dc7e66cSDamjan Jovanovic * with the License. You may obtain a copy of the License at 10*a1b6a2a0Smseidel * 112dc7e66cSDamjan Jovanovic * http://www.apache.org/licenses/LICENSE-2.0 12*a1b6a2a0Smseidel * 132dc7e66cSDamjan Jovanovic * Unless required by applicable law or agreed to in writing, 142dc7e66cSDamjan Jovanovic * software distributed under the License is distributed on an 152dc7e66cSDamjan Jovanovic * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 162dc7e66cSDamjan Jovanovic * KIND, either express or implied. See the License for the 172dc7e66cSDamjan Jovanovic * specific language governing permissions and limitations 182dc7e66cSDamjan Jovanovic * under the License. 19*a1b6a2a0Smseidel * 202dc7e66cSDamjan Jovanovic *************************************************************/ 212dc7e66cSDamjan Jovanovic 222dc7e66cSDamjan Jovanovic 232dc7e66cSDamjan Jovanovic 242dc7e66cSDamjan Jovanovic#ifndef __com_sun_star_logging_SyslogHandler_idl__ 252dc7e66cSDamjan Jovanovic#define __com_sun_star_logging_SyslogHandler_idl__ 262dc7e66cSDamjan Jovanovic 27*a1b6a2a0Smseidel#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 282dc7e66cSDamjan Jovanovic#include <com/sun/star/lang/IllegalArgumentException.idl> 292dc7e66cSDamjan Jovanovic#endif 302dc7e66cSDamjan Jovanovic#ifndef __com_sun_star_beans_NamedValue_idl__ 312dc7e66cSDamjan Jovanovic#include <com/sun/star/beans/NamedValue.idl> 322dc7e66cSDamjan Jovanovic#endif 332dc7e66cSDamjan Jovanovic 342dc7e66cSDamjan Jovanovic//============================================================================= 352dc7e66cSDamjan Jovanovic 36*a1b6a2a0Smseidelmodule com { module sun { module star { module logging { 372dc7e66cSDamjan Jovanovic 382dc7e66cSDamjan Jovanovicinterface XLogHandler; 392dc7e66cSDamjan Jovanovic 402dc7e66cSDamjan Jovanovic//============================================================================= 412dc7e66cSDamjan Jovanovic 422dc7e66cSDamjan Jovanovic/** specifies a component implementing a log handler whose output 432dc7e66cSDamjan Jovanovic channel is the syslog network protocol. 442dc7e66cSDamjan Jovanovic 452dc7e66cSDamjan Jovanovic <p>The handler will use the <code>Encoding</code> attribute of <type>XLogHandler</type> 462dc7e66cSDamjan Jovanovic to determine how to encode strings before actually writing them to the output 472dc7e66cSDamjan Jovanovic file.</p> 482dc7e66cSDamjan Jovanovic 492dc7e66cSDamjan Jovanovic <p>The output is sent over UDP to the given Host and Port 502dc7e66cSDamjan Jovanovic in RFC5424 format, in plaintext, with APPNAME "soffice" and facility USER. 512dc7e66cSDamjan Jovanovic LogLevel::SEVERE becomes syslog's "error" severity, LogLevel::WARNING becomes syslog's 522dc7e66cSDamjan Jovanovic "warning" severity, LogLevel::INFO and LogLevel::CONFIG become syslog's "notice" 532dc7e66cSDamjan Jovanovic severity, and LogLevel::FINE and below become syslog's "debug" severity.</p> 542dc7e66cSDamjan Jovanovic 552dc7e66cSDamjan Jovanovic @see XLogHandler::Encoding 562dc7e66cSDamjan Jovanovic 57*a1b6a2a0Smseidel @since OpenOffice 4.2 582dc7e66cSDamjan Jovanovic */ 592dc7e66cSDamjan Jovanovicservice SyslogHandler : XLogHandler 602dc7e66cSDamjan Jovanovic{ 612dc7e66cSDamjan Jovanovic /** creates an instance of the log handler 622dc7e66cSDamjan Jovanovic 632dc7e66cSDamjan Jovanovic @param Settings 642dc7e66cSDamjan Jovanovic contains the initial settings for the log handler 652dc7e66cSDamjan Jovanovic 662dc7e66cSDamjan Jovanovic <p>The following settings are recognized and supported: 672dc7e66cSDamjan Jovanovic <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li> 682dc7e66cSDamjan Jovanovic <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li> 692dc7e66cSDamjan Jovanovic <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li> 702dc7e66cSDamjan Jovanovic </ul></p> 712dc7e66cSDamjan Jovanovic 722dc7e66cSDamjan Jovanovic <p>Additionally, the following settings are required for this particular handler: 732dc7e66cSDamjan Jovanovic <ul><li><code>Host</code> - the hostname of the syslog server</li> 742dc7e66cSDamjan Jovanovic <li><code>Port</code> - the port of the syslog server</li> 752dc7e66cSDamjan Jovanovic </ul></p> 762dc7e66cSDamjan Jovanovic 772dc7e66cSDamjan Jovanovic @throws ::com::sun::star::lang::IllegalArgumentException 782dc7e66cSDamjan Jovanovic if <arg>Settings</args> contains settings whose value is of the wrong type. 792dc7e66cSDamjan Jovanovic */ 802dc7e66cSDamjan Jovanovic createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings ) 812dc7e66cSDamjan Jovanovic raises ( ::com::sun::star::lang::IllegalArgumentException ); 822dc7e66cSDamjan Jovanovic}; 832dc7e66cSDamjan Jovanovic 842dc7e66cSDamjan Jovanovic//============================================================================= 852dc7e66cSDamjan Jovanovic 86*a1b6a2a0Smseidel}; }; }; }; 872dc7e66cSDamjan Jovanovic 882dc7e66cSDamjan Jovanovic//============================================================================= 892dc7e66cSDamjan Jovanovic 902dc7e66cSDamjan Jovanovic#endif 91