Package org.apache.sshd.common.util.logging

Class LoggingUtils

java.lang.Object

org.apache.sshd.common.util.logging.LoggingUtils

public final class LoggingUtils
extends Object

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
static Set<org.slf4j.event.Level>	SLF4J_LEVELS

Method Summary

Modifier and Type	Method	Description
static void	debug(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Throwable t)
static void	debug(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Object o5, Throwable t)
static void	debug(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Throwable t)
static void	debug(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Throwable t)
static void	debug(org.slf4j.Logger log, String message, Object o1, Object o2, Throwable t)
static <T> Consumer<T>	debugClosure(org.slf4j.Logger logger)
static <T> Consumer<T>	debugClosure(org.slf4j.Logger logger, Throwable thrown)
static void	error(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Throwable t)
static void	error(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Object o5, Throwable t)
static void	error(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Throwable t)
static void	error(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Throwable t)
static void	error(org.slf4j.Logger log, String message, Object o1, Object o2, Throwable t)
static <T> Consumer<T>	errorClosure(org.slf4j.Logger logger)
static <T> Consumer<T>	errorClosure(org.slf4j.Logger logger, Throwable thrown)
static String	formatMessage(String format, Object... arguments)	Formats an slf4j message using its formatting structure - mainly the usage of positional arguments - e.g., "Value1={}, Value2={}, ..."
static NavigableMap<Integer,String>	generateMnemonicMap(Class<?> clazz, String commonPrefix)	Scans using reflection API for all fields that are public static final that start with the given common prefix (case sensitive) and are of type Number.
static NavigableMap<Integer,String>	generateMnemonicMap(Class<?> clazz, Predicate<? super Field> acceptor)	Scans using reflection API for all numeric public static final fields that are also accepted by the predicate.
static Map<String,Integer>	getAmbiguousMenmonics(Class<?> clazz, String commonPrefix)	Scans using reflection API for all numeric public static final fields that have a common prefix and whose value is used by several of the other matching fields
static Map<String,Integer>	getAmbiguousMenmonics(Class<?> clazz, Predicate<? super Field> acceptor)	Scans using reflection API for all numeric public static final fields that are also accepted by the predicate and whose value is used by several of the other matching fields
static Collection<Field>	getMnemonicFields(Class<?> clazz, Predicate<? super Field> acceptor)	Scans using reflection API for all numeric public static final fields that are also accepted by the predicate.
static void	info(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Throwable t)
static void	info(org.slf4j.Logger log, String message, Object o1, Object o2, Throwable t)
static <T> Consumer<T>	infoClosure(org.slf4j.Logger logger)
static <T> Consumer<T>	infoClosure(org.slf4j.Logger logger, Throwable thrown)
static boolean	isLoggable(org.slf4j.Logger logger, Level level)
static <T> Consumer<T>	loggingClosure(org.slf4j.Logger logger, Level level)
static <T> Consumer<T>	loggingClosure(org.slf4j.Logger logger, Level level, Throwable t)
static void	logMessage(org.slf4j.Logger logger, Level level, Object message, Throwable t)
static <T> Consumer<T>	nologClosure(org.slf4j.Logger logger)
static org.slf4j.event.Level	slf4jLevelFromName(String name)
static <T> Consumer<T>	traceClosure(org.slf4j.Logger logger)
static <T> Consumer<T>	traceClosure(org.slf4j.Logger logger, Throwable thrown)
static void	warn(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Object o7, Object o8, Object o9, Throwable t)
static void	warn(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Object o7, Object o8, Throwable t)
static void	warn(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Object o7, Throwable t)
static void	warn(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Throwable t)
static void	warn(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Object o5, Throwable t)
static void	warn(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Object o4, Throwable t)
static void	warn(org.slf4j.Logger log, String message, Object o1, Object o2, Object o3, Throwable t)
static void	warn(org.slf4j.Logger log, String message, Object o1, Object o2, Throwable t)
static <T> Consumer<T>	warnClosure(org.slf4j.Logger logger)
static <T> Consumer<T>	warnClosure(org.slf4j.Logger logger, Throwable thrown)
static SimplifiedLog	wrap(org.slf4j.Logger logger)

Methods inherited from class java.lang.Object

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

Field Detail

SLF4J_LEVELS

public static final Set<org.slf4j.event.Level> SLF4J_LEVELS

Method Detail

slf4jLevelFromName

public static org.slf4j.event.Level slf4jLevelFromName(String name)

generateMnemonicMap

public static NavigableMap<Integer,String> generateMnemonicMap(Class<?> clazz,
                                                                     String commonPrefix)

Scans using reflection API for all fields that are public static final that start with the given common prefix (case sensitive) and are of type Number.

Parameters:

clazz - The Class to query

commonPrefix - The expected common prefix

Returns:

A NavigableMap of all the matching fields, where key=the field's Integer value and mapping=the field's name

See Also:

generateMnemonicMap(Class, Predicate)

generateMnemonicMap

public static NavigableMap<Integer,String> generateMnemonicMap(Class<?> clazz,
                                                                     Predicate<? super Field> acceptor)

Scans using reflection API for all numeric public static final fields that are also accepted by the predicate. Any field that is not such or fail to retrieve its value, or has a duplicate value is silently skipped.

Parameters:

clazz - The Class to query

acceptor - The Predicate used to decide whether to process the Field (besides being a Number and public static final).

Returns:

A NavigableMap of all the matching fields, where key=the field's Integer value and mapping=the field's name

See Also:

getMnemonicFields(Class, Predicate)

getAmbiguousMenmonics

public static Map<String,Integer> getAmbiguousMenmonics(Class<?> clazz,
                                                              String commonPrefix)

Scans using reflection API for all numeric public static final fields that have a common prefix and whose value is used by several of the other matching fields

Parameters:

clazz - The Class to query

commonPrefix - The expected common prefix

Returns:

A Map of all the mnemonic fields names whose value is the same as other fields in this map. The key is the field's name and value is its associated opcode.

See Also:

getAmbiguousMenmonics(Class, Predicate)

getAmbiguousMenmonics

public static Map<String,Integer> getAmbiguousMenmonics(Class<?> clazz,
                                                              Predicate<? super Field> acceptor)

Scans using reflection API for all numeric public static final fields that are also accepted by the predicate and whose value is used by several of the other matching fields

Parameters:

clazz - The Class to query

acceptor - The Predicate used to decide whether to process the Field (besides being a Number and public static final).

Returns:

A Map of all the mnemonic fields names whose value is the same as other fields in this map. The key is the field's name and value is its associated opcode.

See Also:

getMnemonicFields(Class, Predicate)

getMnemonicFields

public static Collection<Field> getMnemonicFields(Class<?> clazz,
                                                  Predicate<? super Field> acceptor)

Scans using reflection API for all numeric public static final fields that are also accepted by the predicate.

Parameters:

clazz - The Class to query

acceptor - The Predicate used to decide whether to process the Field (besides being a Number and public static final).

Returns:

A Collection of all the fields that have satisfied all conditions

wrap

public static SimplifiedLog wrap(org.slf4j.Logger logger)

logMessage

public static void logMessage(org.slf4j.Logger logger,
                              Level level,
                              Object message,
                              Throwable t)

isLoggable

public static boolean isLoggable(org.slf4j.Logger logger,
                                 Level level)

Parameters:

logger - The Logger instance - ignored if null

level - The validate log Level - ignored if null

Returns:

true if the level is enabled for the logger. The mapping of the level to the logger is as follows:

• Level.OFF always returns false
• Level.SEVERE returns Logger.isErrorEnabled()
• Level.WARNING returns Logger.isWarnEnabled()
• Level.INFO and Level.ALL returns Logger.isInfoEnabled()
• Level.CONFIG and Level.FINE returns Logger.isDebugEnabled()
• All other levels return Logger.isTraceEnabled()

loggingClosure

public static <T> Consumer<T> loggingClosure(org.slf4j.Logger logger,
                                             Level level)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

level - The log Level mapped as follows:

• Level.OFF - nologClosure(Logger)
• Level.SEVERE - errorClosure(Logger)
• Level.WARNING - warnClosure(Logger)
• Level.INFO/Level.ALL - infoClosure(Logger)
• Level.CONFIG/Level.FINE - debugClosure(Logger)
• All others - traceClosure(Logger)

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if the specific level is enabled

loggingClosure

public static <T> Consumer<T> loggingClosure(org.slf4j.Logger logger,
                                             Level level,
                                             Throwable t)

nologClosure

public static <T> Consumer<T> nologClosure(org.slf4j.Logger logger)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

Returns:

A consumer whose Consumer.accept(Object) method logs nothing when invoked

errorClosure

public static <T> Consumer<T> errorClosure(org.slf4j.Logger logger)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isErrorEnabled()

errorClosure

public static <T> Consumer<T> errorClosure(org.slf4j.Logger logger,
                                           Throwable thrown)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

thrown - A Throwable to attach to the message - ignored if null

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isErrorEnabled()

warnClosure

public static <T> Consumer<T> warnClosure(org.slf4j.Logger logger)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isWarnEnabled()

warnClosure

public static <T> Consumer<T> warnClosure(org.slf4j.Logger logger,
                                          Throwable thrown)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

thrown - A Throwable to attach to the message - ignored if null

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isWarnEnabled()

infoClosure

public static <T> Consumer<T> infoClosure(org.slf4j.Logger logger)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isInfoEnabled()

infoClosure

public static <T> Consumer<T> infoClosure(org.slf4j.Logger logger,
                                          Throwable thrown)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

thrown - A Throwable to attach to the message - ignored if null

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isInfoEnabled()

debugClosure

public static <T> Consumer<T> debugClosure(org.slf4j.Logger logger)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isDebugEnabled()

debugClosure

public static <T> Consumer<T> debugClosure(org.slf4j.Logger logger,
                                           Throwable thrown)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

thrown - A Throwable to attach to the message - ignored if null

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isDebugEnabled()

traceClosure

public static <T> Consumer<T> traceClosure(org.slf4j.Logger logger)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isTraceEnabled()

traceClosure

public static <T> Consumer<T> traceClosure(org.slf4j.Logger logger,
                                           Throwable thrown)

Type Parameters:

T - Generic message type consumer

Parameters:

logger - The Logger instance to use

thrown - A Throwable to attach to the message - ignored if null

Returns:

A consumer whose Consumer.accept(Object) method logs the String.valueOf(Object) value of its argument if Logger.isTraceEnabled()

formatMessage

public static String formatMessage(String format,
                                   Object... arguments)

Formats an slf4j message using its formatting structure - mainly the usage of positional arguments - e.g., "Value1={}, Value2={}, ..."

Parameters:

format - The formatting instructions - ignored if null/empty

arguments - The formatting arguments - ignored if null/empty

Returns:

The formatted message - or the format itself if no arguments or no format string

debug

public static void debug(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Throwable t)

debug

public static void debug(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Object o3,
                         Throwable t)

debug

public static void debug(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Object o3,
                         Object o4,
                         Throwable t)

debug

public static void debug(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Object o3,
                         Object o4,
                         Object o5,
                         Throwable t)

debug

public static void debug(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Object o3,
                         Object o4,
                         Object o5,
                         Object o6,
                         Throwable t)

info

public static void info(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Throwable t)

info

public static void info(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Object o3,
                        Throwable t)

warn

public static void warn(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Throwable t)

warn

public static void warn(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Object o3,
                        Throwable t)

warn

public static void warn(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Object o3,
                        Object o4,
                        Throwable t)

warn

public static void warn(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Object o3,
                        Object o4,
                        Object o5,
                        Throwable t)

warn

public static void warn(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Object o3,
                        Object o4,
                        Object o5,
                        Object o6,
                        Throwable t)

warn

public static void warn(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Object o3,
                        Object o4,
                        Object o5,
                        Object o6,
                        Object o7,
                        Throwable t)

warn

public static void warn(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Object o3,
                        Object o4,
                        Object o5,
                        Object o6,
                        Object o7,
                        Object o8,
                        Throwable t)

warn

public static void warn(org.slf4j.Logger log,
                        String message,
                        Object o1,
                        Object o2,
                        Object o3,
                        Object o4,
                        Object o5,
                        Object o6,
                        Object o7,
                        Object o8,
                        Object o9,
                        Throwable t)

error

public static void error(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Throwable t)

error

public static void error(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Object o3,
                         Throwable t)

error

public static void error(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Object o3,
                         Object o4,
                         Throwable t)

error

public static void error(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Object o3,
                         Object o4,
                         Object o5,
                         Throwable t)

error

public static void error(org.slf4j.Logger log,
                         String message,
                         Object o1,
                         Object o2,
                         Object o3,
                         Object o4,
                         Object o5,
                         Object o6,
                         Throwable t)