io.netty.handler.logging

Class LoggingHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.handler.logging.LoggingHandler

All Implemented Interfaces:

ChannelHandler

@ChannelHandler.Sharable
public class LoggingHandler
extends ChannelHandlerAdapter

A ChannelHandler that logs all events using a logging framework. By default, all events are logged at DEBUG level.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable, ChannelHandler.Skip

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.util.internal.logging.InternalLogLevel	internalLevel
protected io.netty.util.internal.logging.InternalLogger	logger

Constructor Summary

Constructors

Constructor and Description
LoggingHandler() Creates a new instance whose logger name is the fully qualified class name of the instance with hex dump enabled.
LoggingHandler(Class<?> clazz) Creates a new instance with the specified logger name and with hex dump enabled.
LoggingHandler(Class<?> clazz, LogLevel level) Creates a new instance with the specified logger name.
LoggingHandler(LogLevel level) Creates a new instance whose logger name is the fully qualified class name of the instance.
LoggingHandler(String name) Creates a new instance with the specified logger name using the default log level.
LoggingHandler(String name, LogLevel level) Creates a new instance with the specified logger name.

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	appendHexDump(StringBuilder dump, ByteBuf buf) Appends the prettifies multi-line hexadecimal dump of the specified ByteBuf to the specified StringBuilder.
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise) Calls ChannelHandlerContext.bind(java.net.SocketAddress, ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline.
void	channelActive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelHandler in the ChannelPipeline.
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) Calls ChannelHandlerContext.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.deregister(ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.disconnect(ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx) Calls ChannelHandlerContext.flush() to forward to the next ChannelHandler in the ChannelPipeline.
protected String	format(ChannelHandlerContext ctx, String eventName) Formats an event and returns the formatted message.
protected String	format(ChannelHandlerContext ctx, String eventName, Object arg) Formats an event and returns the formatted message.
protected String	format(ChannelHandlerContext ctx, String eventName, Object firstArg, Object secondArg) Formats an event and returns the formatted message.
LogLevel	level() Returns the LogLevel that this handler uses to log
void	userEventTriggered(ChannelHandlerContext ctx, Object evt) Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelHandler in the ChannelPipeline.
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline.

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

channelReadComplete, channelWritabilityChanged, handlerAdded, handlerRemoved, isSharable, read

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final io.netty.util.internal.logging.InternalLogger logger

internalLevel

protected final io.netty.util.internal.logging.InternalLogLevel internalLevel

Constructor Detail

LoggingHandler

public LoggingHandler()

Creates a new instance whose logger name is the fully qualified class name of the instance with hex dump enabled.

LoggingHandler

public LoggingHandler(LogLevel level)

Creates a new instance whose logger name is the fully qualified class name of the instance.

Parameters:

level - the log level

LoggingHandler

public LoggingHandler(Class<?> clazz)

Creates a new instance with the specified logger name and with hex dump enabled.

Parameters:

clazz - the class type to generate the logger for

LoggingHandler

public LoggingHandler(Class<?> clazz,
              LogLevel level)

Creates a new instance with the specified logger name.

Parameters:

clazz - the class type to generate the logger for

level - the log level

LoggingHandler

public LoggingHandler(String name)

Creates a new instance with the specified logger name using the default log level.

Parameters:

name - the name of the class to use for the logger

LoggingHandler

public LoggingHandler(String name,
              LogLevel level)

Creates a new instance with the specified logger name.

Parameters:

name - the name of the class to use for the logger

level - the log level

Method Detail

level

public LogLevel level()

Returns the LogLevel that this handler uses to log

channelRegistered

public void channelRegistered(ChannelHandlerContext ctx)
                       throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelRegistered in interface ChannelHandler

Overrides:

channelRegistered in class ChannelHandlerAdapter

Throws:

Exception

channelUnregistered

public void channelUnregistered(ChannelHandlerContext ctx)
                         throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelUnregistered in interface ChannelHandler

Overrides:

channelUnregistered in class ChannelHandlerAdapter

Throws:

Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelActive in interface ChannelHandler

Overrides:

channelActive in class ChannelHandlerAdapter

Throws:

Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelInactive in interface ChannelHandler

Overrides:

channelInactive in class ChannelHandlerAdapter

Throws:

Exception

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                   Throwable cause)
                     throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

exceptionCaught in interface ChannelHandler

Overrides:

exceptionCaught in class ChannelHandlerAdapter

Throws:

Exception

userEventTriggered

public void userEventTriggered(ChannelHandlerContext ctx,
                      Object evt)
                        throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

userEventTriggered in interface ChannelHandler

Overrides:

userEventTriggered in class ChannelHandlerAdapter

Throws:

Exception

bind

public void bind(ChannelHandlerContext ctx,
        SocketAddress localAddress,
        ChannelPromise promise)
          throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.bind(java.net.SocketAddress, ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

bind in interface ChannelHandler

Overrides:

bind in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the bind operation is made

localAddress - the SocketAddress to which it should bound

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

connect

public void connect(ChannelHandlerContext ctx,
           SocketAddress remoteAddress,
           SocketAddress localAddress,
           ChannelPromise promise)
             throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

connect in interface ChannelHandler

Overrides:

connect in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the connect operation is made

remoteAddress - the SocketAddress to which it should connect

localAddress - the SocketAddress which is used as source on connect

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

disconnect

public void disconnect(ChannelHandlerContext ctx,
              ChannelPromise promise)
                throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.disconnect(ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

disconnect in interface ChannelHandler

Overrides:

disconnect in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the disconnect operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

close

public void close(ChannelHandlerContext ctx,
         ChannelPromise promise)
           throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

close in interface ChannelHandler

Overrides:

close in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

deregister

public void deregister(ChannelHandlerContext ctx,
              ChannelPromise promise)
                throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.deregister(ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

deregister in interface ChannelHandler

Overrides:

deregister in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

channelRead

public void channelRead(ChannelHandlerContext ctx,
               Object msg)
                 throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelRead in interface ChannelHandler

Overrides:

channelRead in class ChannelHandlerAdapter

Throws:

Exception

write

public void write(ChannelHandlerContext ctx,
         Object msg,
         ChannelPromise promise)
           throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

write in interface ChannelHandler

Overrides:

write in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

flush

public void flush(ChannelHandlerContext ctx)
           throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.flush() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

flush in interface ChannelHandler

Overrides:

flush in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the flush operation is made

Throws:

Exception - thrown if an error accour

format

protected String format(ChannelHandlerContext ctx,
            String eventName)

Formats an event and returns the formatted message.

Parameters:

eventName - the name of the event

format

protected String format(ChannelHandlerContext ctx,
            String eventName,
            Object arg)

Formats an event and returns the formatted message.

Parameters:

eventName - the name of the event

arg - the argument of the event

format

protected String format(ChannelHandlerContext ctx,
            String eventName,
            Object firstArg,
            Object secondArg)

Formats an event and returns the formatted message. This method is currently only used for formatting ChannelHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise).

Parameters:

eventName - the name of the event

firstArg - the first argument of the event

secondArg - the second argument of the event

appendHexDump

protected static void appendHexDump(StringBuilder dump,
                 ByteBuf buf)

Appends the prettifies multi-line hexadecimal dump of the specified ByteBuf to the specified StringBuilder.