org.eclipse.paho.client.mqttv3.logging

Class LoggerFactory

java.lang.Object

org.eclipse.paho.client.mqttv3.logging.LoggerFactory

public class LoggerFactory
extends java.lang.Object

A factory that returns a logger for use by the MQTT client. The default log and trace facility uses Java's build in log facility:- java.util.logging. For systems where this is not available or where an alternative logging framework is required the logging facility can be replaced using setLogger(String) which takes an implementation of the Logger interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MQTT_CLIENT_MSG_CAT Default message catalog.

Constructor Summary

Constructors

Constructor and Description
LoggerFactory()

Method Summary

Modifier and Type	Method and Description
static Logger	getLogger(java.lang.String messageCatalogName, java.lang.String loggerID) Find or create a logger for a named package/class.
static java.lang.String	getLoggingProperty(java.lang.String name) When run in JSR47, this allows access to the properties in the logging.properties file.
static void	setLogger(java.lang.String loggerClassName) Set the class name of the logger that the LoggerFactory will load If not set getLogger will attempt to create a logger appropriate for the platform.

Methods inherited from class java.lang.Object

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

Field Detail

MQTT_CLIENT_MSG_CAT

public static final java.lang.String MQTT_CLIENT_MSG_CAT

Default message catalog.

See Also:

Constant Field Values

Constructor Detail

LoggerFactory

public LoggerFactory()

Method Detail

getLogger

public static Logger getLogger(java.lang.String messageCatalogName,
                               java.lang.String loggerID)

Find or create a logger for a named package/class. If a logger has already been created with the given name it is returned. Otherwise a new logger is created. By default a logger that uses java.util.logging will be returned.

Parameters:

messageCatalogName - the resource bundle containing the logging messages.

loggerID - unique name to identify this logger.

Returns:

a suitable Logger.

Throws:

java.lang.Exception

getLoggingProperty

public static java.lang.String getLoggingProperty(java.lang.String name)

When run in JSR47, this allows access to the properties in the logging.properties file. If not run in JSR47, or the property isn't set, returns null.

Parameters:

name - the property to return

Returns:

the property value, or null if it isn't set or JSR47 isn't being used

setLogger

public static void setLogger(java.lang.String loggerClassName)

Set the class name of the logger that the LoggerFactory will load If not set getLogger will attempt to create a logger appropriate for the platform.

Parameters:

loggerClassName - - Logger implementation class name to use.