INTEGRATION: CWS sdblogging (1.1.2); FILE ADDED

2007/05/22 19:19:49 fs 1.1.2.3: #i76119# implement changes suggested by API review: initialize components by generic ctor, not by component context values
2007/04/18 06:59:56 fs 1.1.2.2: better documentation (coming from interface-discuss)
2007/04/17 14:02:32 fs 1.1.2.1: #i76119# new logging API

2 files changed, 195 insertions, 0 deletions

diff --git a/offapi/com/sun/star/logging/ConsoleHandler.idl b/offapi/com/sun/star/logging/ConsoleHandler.idl
new file mode 100644
index 000000000000..8eb45b118c68
--- /dev/null
+++ b/offapi/com/sun/star/logging/ConsoleHandler.idl
@@ -0,0 +1,90 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: ConsoleHandler.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: hr $ $Date: 2007-06-27 14:46:48 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_logging_ConsoleHandler_idl__
+#define __com_sun_star_logging_ConsoleHandler_idl__
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+#ifndef __com_sun_star_beans_NamedValue_idl__
+#include <com/sun/star/beans/NamedValue.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module logging {
+
+interface XConsoleHandler;
+
+//=============================================================================
+
+/** specifies a component implementing a log handler whose output
+    channel is the processes console.
+
+    @since OOo 2.3
+ */
+service ConsoleHandler : XConsoleHandler
+{
+    /// creates a <code>ConsoleHandler</code>
+    create();
+
+    /** creates an instance of the log handler, using generic settings
+
+        @param Settings
+            contains the initial settings for the log handler
+
+            <p>The following settings are recognized and supported:
+            <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li>
+                <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li>
+                <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li>
+                <li><code>Threshold</code> - denotes the initial value of the <member>XConsoleHandler::Threshold</member></li>
+            </ul></p>
+
+        @throws ::com::sun::star::lang::IllegalArgumentException
+            if <arg>Settings</args> contains arguments with names other than in the list above, or
+            settings whose value is of the wrong type.
+    */
+    createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
+        raises ( ::com::sun::star::lang::IllegalArgumentException );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif
diff --git a/offapi/com/sun/star/logging/FileHandler.idl b/offapi/com/sun/star/logging/FileHandler.idl
new file mode 100644
index 000000000000..c5542390229e
--- /dev/null
+++ b/offapi/com/sun/star/logging/FileHandler.idl
@@ -0,0 +1,105 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: FileHandler.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: hr $ $Date: 2007-06-27 14:46:59 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_logging_FileHandler_idl__
+#define __com_sun_star_logging_FileHandler_idl__
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+#ifndef __com_sun_star_beans_NamedValue_idl__
+#include <com/sun/star/beans/NamedValue.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module logging {
+
+interface XLogHandler;
+
+//=============================================================================
+
+/** specifies a component implementing a log handler whose output
+    channel is a file.
+
+    <p>The handler will use the <code>Encoding</code> attribute of <type>XLogHandler</type>
+    to determine how to encode strings before actually writing them to the output
+    file.</p>
+
+    @see XLogHandler::Encoding
+
+    @since OOo 2.3
+ */
+service FileHandler : XLogHandler
+{
+    /** creates a log handler whose output is directed to a file given by URL.
+
+        @param FileURL
+            the URL of the file to be created. This URL is resolved using the
+            <type scope="::com::sun::star::util">PathSubstitution</type> service. That
+            is, it is allowed to include placeholders such as <code>$(userurl)</code>.
+    */
+    create( [in] string FileURL );
+
+    /** creates an instance of the log handler, using generic settings
+
+        @param Settings
+            contains the initial settings for the log handler
+
+            <p>The following settings are recognized and supported:
+            <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li>
+                <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li>
+                <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li>
+            </ul></p>
+
+            <p>Additionally, a setting name <code>FileURL</code> is recognized. It must be of type
+            string, and denotes the file URL to which the handler's output should be directed.</p>
+
+            <p>At least the URL argument must be present in the settings.</p>
+
+        @throws ::com::sun::star::lang::IllegalArgumentException
+            if <arg>Settings</args> contains settings whose value is of the wrong type.
+    */
+    createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
+        raises ( ::com::sun::star::lang::IllegalArgumentException );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif