com.aldebaran.qi.helper.proxies

Class ALLogger

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALLogger

public class ALLogger
extends ALProxy

This module allows you log errors, warnings, and info stdout or a file. The verbosity level allow you to customize the output.

See Also:

NAOqi APIs for ALLogger

Field Summary

Fields inherited from class com.aldebaran.qi.helper.ALProxy

name, service

Constructor Summary

Constructors

Constructor and Description
ALLogger(Session session)

Method Summary

Modifier and Type	Method and Description
void	clearStats()
void	debug(java.lang.String moduleName, java.lang.String message) DEPRECATED.
void	error(java.lang.String moduleName, java.lang.String message) DEPRECATED.
void	exit() Exits and unregisters the module.
void	fatal(java.lang.String moduleName, java.lang.String message) DEPRECATED.
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.lang.Object	getMethodHelp(java.lang.String methodName) Retrieves a method's description.
java.util.List<java.lang.String>	getMethodList() Retrieves the module's method list.
java.lang.Object	getModuleHelp() Retrieves the module's description.
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
void	info(java.lang.String moduleName, java.lang.String message) DEPRECATED.
java.lang.Boolean	isRunning(java.lang.Integer id) Returns true if the method is currently running.
java.lang.Boolean	isStatsEnabled()
java.lang.Boolean	isTraceEnabled()
void	logInFile(java.lang.String param1) Removed: not implemented anymore.
void	logInForwarder(java.lang.String param1) Removed: not implemented anymore.
java.lang.Boolean	ping() Just a ping.
void	removeHandler(java.lang.String param1) Removed: not implemented anymore.
void	setVerbosity(java.lang.String param1) Removed: not implemented anymore.
void	stop(java.lang.Integer id) returns true if the method is currently running
java.lang.Integer	verbosity() Removed: not implemented anymore.
java.lang.String	version() Returns the version of the module.
java.lang.Boolean	wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) Wait for the end of a long running method that was called using 'post'
void	warn(java.lang.String moduleName, java.lang.String message) DEPRECATED: use qiLogWarning instead.

Methods inherited from class com.aldebaran.qi.helper.ALProxy

call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ALLogger

public ALLogger(Session session)
         throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

isStatsEnabled

public java.lang.Boolean isStatsEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

clearStats

public void clearStats()
                throws CallError,
                       java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

isTraceEnabled

public java.lang.Boolean isTraceEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

exit

public void exit()
          throws CallError,
                 java.lang.InterruptedException

Exits and unregisters the module.

Throws:

CallError

java.lang.InterruptedException

version

public java.lang.String version()
                         throws CallError,
                                java.lang.InterruptedException

Returns the version of the module.

Returns:

A string containing the version of the module.

Throws:

CallError

java.lang.InterruptedException

ping

public java.lang.Boolean ping()
                       throws CallError,
                              java.lang.InterruptedException

Just a ping. Always returns true

Returns:

returns true

Throws:

CallError

java.lang.InterruptedException

getMethodList

public java.util.List<java.lang.String> getMethodList()
                                               throws CallError,
                                                      java.lang.InterruptedException

Retrieves the module's method list.

Returns:

An array of method names.

Throws:

CallError

java.lang.InterruptedException

getMethodHelp

public java.lang.Object getMethodHelp(java.lang.String methodName)
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves a method's description.

Parameters:

methodName - The name of the method.

Returns:

A structure containing the method's description.

Throws:

CallError

java.lang.InterruptedException

getModuleHelp

public java.lang.Object getModuleHelp()
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves the module's description.

Returns:

A structure describing the module.

Throws:

CallError

java.lang.InterruptedException

wait

public java.lang.Boolean wait(java.lang.Integer id,
                              java.lang.Integer timeoutPeriod)
                       throws CallError,
                              java.lang.InterruptedException

Wait for the end of a long running method that was called using 'post'

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

timeoutPeriod - The timeout period in ms. To wait indefinately, use a timeoutPeriod of zero.

Returns:

True if the timeout period terminated. False if the method returned.

Throws:

CallError

java.lang.InterruptedException

isRunning

public java.lang.Boolean isRunning(java.lang.Integer id)
                            throws CallError,
                                   java.lang.InterruptedException

Returns true if the method is currently running.

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

Returns:

True if the method is currently running

Throws:

CallError

java.lang.InterruptedException

stop

public void stop(java.lang.Integer id)
          throws CallError,
                 java.lang.InterruptedException

returns true if the method is currently running

Parameters:

id - the ID of the method to wait for

Throws:

CallError

java.lang.InterruptedException

getBrokerName

public java.lang.String getBrokerName()
                               throws CallError,
                                      java.lang.InterruptedException

Gets the name of the parent broker.

Returns:

The name of the parent broker.

Throws:

CallError

java.lang.InterruptedException

getUsage

public java.lang.String getUsage(java.lang.String name)
                          throws CallError,
                                 java.lang.InterruptedException

Gets the method usage string. This summarises how to use the method.

Parameters:

name - The name of the method.

Returns:

A string that summarises the usage of the method.

Throws:

CallError

java.lang.InterruptedException

fatal

public void fatal(java.lang.String moduleName,
                  java.lang.String message)
           throws CallError,
                  java.lang.InterruptedException

DEPRECATED. Use qiLogFatal instead. Log a fatal error.

Parameters:

moduleName - Name of the module.

message - Log Message.

Throws:

CallError

java.lang.InterruptedException

error

public void error(java.lang.String moduleName,
                  java.lang.String message)
           throws CallError,
                  java.lang.InterruptedException

DEPRECATED. Use qiLogError instead. Log an error.

Parameters:

moduleName - Name of the module.

message - Log Message.

Throws:

CallError

java.lang.InterruptedException

warn

public void warn(java.lang.String moduleName,
                 java.lang.String message)
          throws CallError,
                 java.lang.InterruptedException

DEPRECATED: use qiLogWarning instead. Log a warning.

Parameters:

moduleName - Name of the module.

message - Log Message.

Throws:

CallError

java.lang.InterruptedException

info

public void info(java.lang.String moduleName,
                 java.lang.String message)
          throws CallError,
                 java.lang.InterruptedException

DEPRECATED. Use qiLogInfo instead. Log a info message.

Parameters:

moduleName - Name of the module.

message - Log Message.

Throws:

CallError

java.lang.InterruptedException

debug

public void debug(java.lang.String moduleName,
                  java.lang.String message)
           throws CallError,
                  java.lang.InterruptedException

DEPRECATED. Use qiLogDebug instead. Log a debug message.

Parameters:

moduleName - Name of the module.

message - Log Message.

Throws:

CallError

java.lang.InterruptedException

setVerbosity

public void setVerbosity(java.lang.String param1)
                  throws CallError,
                         java.lang.InterruptedException

Removed: not implemented anymore.

Throws:

CallError

java.lang.InterruptedException

verbosity

public java.lang.Integer verbosity()
                            throws CallError,
                                   java.lang.InterruptedException

Removed: not implemented anymore.

Throws:

CallError

java.lang.InterruptedException

logInFile

public void logInFile(java.lang.String param1)
               throws CallError,
                      java.lang.InterruptedException

Removed: not implemented anymore.

Throws:

CallError

java.lang.InterruptedException

logInForwarder

public void logInForwarder(java.lang.String param1)
                    throws CallError,
                           java.lang.InterruptedException

Removed: not implemented anymore.

Throws:

CallError

java.lang.InterruptedException

removeHandler

public void removeHandler(java.lang.String param1)
                   throws CallError,
                          java.lang.InterruptedException

Removed: not implemented anymore.

Throws:

CallError

java.lang.InterruptedException