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_FileHandler_idl__
25#define __com_sun_star_logging_FileHandler_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 a file.
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    @see XLogHandler::Encoding
50
51    @since OOo 2.3
52 */
53service FileHandler : XLogHandler
54{
55    /** creates a log handler whose output is directed to a file given by URL.
56
57        @param FileURL
58            the URL of the file to be created. This URL is resolved using the
59            <type scope="::com::sun::star::util">PathSubstitution</type> service. That
60            is, it is allowed to include placeholders such as <code>$(userurl)</code>.
61    */
62    create( [in] string FileURL );
63
64    /** creates an instance of the log handler, using generic settings
65
66        @param Settings
67            contains the initial settings for the log handler
68
69            <p>The following settings are recognized and supported:
70            <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li>
71                <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li>
72                <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li>
73            </ul></p>
74
75            <p>Additionally, a setting name <code>FileURL</code> is recognized. It must be of type
76            string, and denotes the file URL to which the handler's output should be directed.</p>
77
78            <p>At least the URL argument must be present in the settings.</p>
79
80        @throws ::com::sun::star::lang::IllegalArgumentException
81            if <arg>Settings</args> contains settings whose value is of the wrong type.
82    */
83    createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
84        raises ( ::com::sun::star::lang::IllegalArgumentException );
85};
86
87//=============================================================================
88
89}; }; }; };
90
91//=============================================================================
92
93#endif
94