From 842704fd9b60a36db777a5b9518ce063accfad82 Mon Sep 17 00:00:00 2001 From: tpf Date: Mon, 4 Mar 2002 16:11:01 +0000 Subject: #97825# changed XLogger interfaces to obey the JDK 1.4 final interfaces --- udkapi/com/sun/star/util/logging/XLoggerRemote.idl | 195 +++++---------------- 1 file changed, 48 insertions(+), 147 deletions(-) (limited to 'udkapi/com/sun/star/util/logging/XLoggerRemote.idl') diff --git a/udkapi/com/sun/star/util/logging/XLoggerRemote.idl b/udkapi/com/sun/star/util/logging/XLoggerRemote.idl index 9ff6c87f8ad2..7d40eb481145 100644 --- a/udkapi/com/sun/star/util/logging/XLoggerRemote.idl +++ b/udkapi/com/sun/star/util/logging/XLoggerRemote.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLoggerRemote.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tpf $ $Date: 2002-01-14 17:20:27 $ + * last change: $Author: tpf $ $Date: 2002-03-04 17:11:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,152 +75,64 @@ module com { module sun { module star { module util { module logging { //============================================================================= -/** logging interface -*/ - -interface XLoggerRemote: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - /** adds a properties change listener that informs the client if some - performance relevant data changed on server side. - For now we just transmit the LogLevel thus we do not need any remote - calls just for checking the need to log. - - @param listener - properties change listener - */ - - [oneway] void addPropertiesChangeListener( - [in] com::sun::star::beans::XPropertiesChangeListener listener); +/** Remote logging interface. The twin of XLogger. This interface will do the + remote communication. Differences compared with XLogger: - //------------------------------------------------------------------------- - /** Log a SEVERE message. + getLogger() is omitted as createInstance will suffice here. + No need to obey to the java API here. - @param sourceClass - name of class that issued the logging request + getName() and isLoggable() are added here just in case. + Normally these two can be handled by XLogger without using this interface. - @param sourceMethod - name of method that issued the logging request + logp() contains an additional parameter "thread" which enables the server + to display the client thread of this call - @param msg - the string message - - @param thread - client thread that initially called this method - */ - - [oneway] void severe( [in] string sourceClass, - [in] string sourceMethod, - [in] string msg, - [in] string thread ); - - //------------------------------------------------------------------------- - /** Log a WARNING message. - - @param sourceClass - name of class that issued the logging request - - @param sourceMethod - name of method that issued the logging request + addPropertiesChangeListener() is used to register a call back with the server. + This enables ther server to communicate any changes in the configuration + to the client. The client can use this info to do some prechecks thus + avoiding unneccessary remote calls. +*/ - @param msg - the string message +interface XLoggerRemote: com::sun::star::uno::XInterface +{ + /** gets logging level of this XLoggerRemote - @param thread - client thread that initially called this method + @returns logging level of this XLoggerRemote */ - [oneway] void warning( [in] string sourceClass, - [in] string sourceMethod, - [in] string msg, - [in] string thread ); + long getLevel(); //------------------------------------------------------------------------- - /** Log an INFO message. - @param sourceClass - name of class that issued the logging request + /** gets name of this XLoggerRemote - @param sourceMethod - name of method that issued the logging request - - @param msg - the string message - - @param thread - client thread that initially called this method + @returns name of this XLoggerRemote */ - [oneway] void info( [in] string sourceClass, - [in] string sourceMethod, - [in] string msg, - [in] string thread ); + string getName(); //------------------------------------------------------------------------- - /** Log a CONFIG message. - @param sourceClass - name of class that issued the logging request + /** will this XLoggerRemote produce any output for the given level? + can be used to optimize performance as maybe complex parameter evaluation + in the logp call can be omitted if isLoggable evaluates to false - @param sourceMethod - name of method that issued the logging request - - @param msg - the string message - - @param thread - client thread that initially called this method - */ - - [oneway] void config( [in] string sourceClass, - [in] string sourceMethod, - [in] string msg, - [in] string thread ); - - //------------------------------------------------------------------------- - /** Log a FINE message. - - @param sourceClass - name of class that issued the logging request - - @param sourceMethod - name of method that issued the logging request - - @param msg - the string message + @param level + level to be checked against - @param thread - client thread that initially called this method + @returns true if there will be some output for this XLoggerRemote for the given level, + false otherwise */ - [oneway] void fine( [in] string sourceClass, - [in] string sourceMethod, - [in] string msg, - [in] string thread ); + boolean isLoggable( [in] long level ); //------------------------------------------------------------------------- - /** Log a FINER message. - - @param sourceClass - name of class that issued the logging request - - @param sourceMethod - name of method that issued the logging request - - @param msg - the string message - @param thread - client thread that initially called this method - */ - - [oneway] void finer( [in] string sourceClass, - [in] string sourceMethod, - [in] string msg, - [in] string thread ); + /** Log a message. The p in logp is derived from "precise" as given + is the java.util.logging API - //------------------------------------------------------------------------- - /** Log a FINEST message. + @param level + the log level of this message @param sourceClass name of class that issued the logging request @@ -235,36 +147,25 @@ interface XLoggerRemote: com::sun::star::uno::XInterface client thread that initially called this method */ - [oneway] void finest( [in] string sourceClass, - [in] string sourceMethod, - [in] string msg, - [in] string thread ); + [oneway] void logp( [in] long level, + [in] string sourceClass, + [in] string sourceMethod, + [in] string msg, + [in] string thread ); //------------------------------------------------------------------------- - /** Log a message. - @param sourceClass - name of class that issued the logging request - - @param sourceMethod - name of method that issued the logging request - - @param level - the log level of this message - - @param msg - the string message + /** adds a properties change listener that informs the client if some + performance relevant data changed on server side. + For now we just transmit the LogLevel thus we do not need any remote + calls just for checking the need to log. - @param thread - client thread that initially called this method + @param listener + properties change listener */ - [oneway] void log( [in] string sourceClass, - [in] string sourceMethod, - [in] long level, - [in] string msg, - [in] string thread ); - + [oneway] void addPropertiesChangeListener( + [in] com::sun::star::beans::XPropertiesChangeListener listener); }; //============================================================================= -- cgit