Package io.netty.handler.logging

Class LoggingHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.logging.LoggingHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

@Sharable
public class LoggingHandler
extends ChannelDuplexHandler

A ChannelHandler that logs all events using a logging framework. By default, all events are logged at DEBUG level and full hex dumps are recorded for ByteBufs.

Nested Class Summary

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

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
protected InternalLogLevel	internalLevel
protected InternalLogger	logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
ByteBufFormat	byteBufFormat()	Returns the ByteBufFormat that this handler uses to log
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, java.lang.Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.deregister(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, java.lang.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 ChannelOutboundHandler in the ChannelPipeline.
protected java.lang.String	format(ChannelHandlerContext ctx, java.lang.String eventName)	Formats an event and returns the formatted message.
protected java.lang.String	format(ChannelHandlerContext ctx, java.lang.String eventName, java.lang.Object arg)	Formats an event and returns the formatted message.
protected java.lang.String	format(ChannelHandlerContext ctx, java.lang.String eventName, java.lang.Object firstArg, java.lang.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, java.lang.Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)	Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class io.netty.channel.ChannelDuplexHandler

read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

logger

protected final InternalLogger logger

internalLevel

protected final 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(ByteBufFormat format)

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

Parameters:

format - Format of ByteBuf dumping

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(LogLevel level,
                      ByteBufFormat byteBufFormat)

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

Parameters:

level - the log level

byteBufFormat - the ByteBuf format

LoggingHandler

public LoggingHandler(java.lang.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(java.lang.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(java.lang.Class<?> clazz,
                      LogLevel level,
                      ByteBufFormat byteBufFormat)

Creates a new instance with the specified logger name.

Parameters:

clazz - the class type to generate the logger for

level - the log level

byteBufFormat - the ByteBuf format

LoggingHandler

public LoggingHandler(java.lang.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(java.lang.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

LoggingHandler

public LoggingHandler(java.lang.String name,
                      LogLevel level,
                      ByteBufFormat byteBufFormat)

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

byteBufFormat - the ByteBuf format

Method Detail

level

public LogLevel level()

Returns the LogLevel that this handler uses to log

byteBufFormat

public ByteBufFormat byteBufFormat()

Returns the ByteBufFormat that this handler uses to log

channelRegistered

public void channelRegistered(ChannelHandlerContext ctx)
                       throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelRegistered in interface ChannelInboundHandler

Overrides:

channelRegistered in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

channelUnregistered

public void channelUnregistered(ChannelHandlerContext ctx)
                         throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelUnregistered in interface ChannelInboundHandler

Overrides:

channelUnregistered in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelActive in interface ChannelInboundHandler

Overrides:

channelActive in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

exceptionCaught

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

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

exceptionCaught in interface ChannelInboundHandler

Overrides:

exceptionCaught in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

userEventTriggered

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

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

userEventTriggered in interface ChannelInboundHandler

Overrides:

userEventTriggered in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

bind

public void bind(ChannelHandlerContext ctx,
                 java.net.SocketAddress localAddress,
                 ChannelPromise promise)
          throws java.lang.Exception

Description copied from class: ChannelDuplexHandler

Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

bind in interface ChannelOutboundHandler

Overrides:

bind in class ChannelDuplexHandler

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:

java.lang.Exception - thrown if an error occurs

connect

public void connect(ChannelHandlerContext ctx,
                    java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)
             throws java.lang.Exception

Description copied from class: ChannelDuplexHandler

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

Specified by:

connect in interface ChannelOutboundHandler

Overrides:

connect in class ChannelDuplexHandler

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:

java.lang.Exception - thrown if an error occurs

disconnect

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

Description copied from class: ChannelDuplexHandler

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

Specified by:

disconnect in interface ChannelOutboundHandler

Overrides:

disconnect in class ChannelDuplexHandler

Parameters:

ctx - the ChannelHandlerContext for which the disconnect operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

close

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

Description copied from class: ChannelDuplexHandler

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

Specified by:

close in interface ChannelOutboundHandler

Overrides:

close in class ChannelDuplexHandler

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

deregister

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

Description copied from class: ChannelDuplexHandler

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

Specified by:

deregister in interface ChannelOutboundHandler

Overrides:

deregister in class ChannelDuplexHandler

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

channelReadComplete

public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelReadComplete in interface ChannelInboundHandler

Overrides:

channelReadComplete in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

channelRead

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

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelRead in interface ChannelInboundHandler

Overrides:

channelRead in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

write

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

Description copied from class: ChannelDuplexHandler

Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

write in interface ChannelOutboundHandler

Overrides:

write in class ChannelDuplexHandler

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:

java.lang.Exception - thrown if an error occurs

channelWritabilityChanged

public void channelWritabilityChanged(ChannelHandlerContext ctx)
                               throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelWritabilityChanged in interface ChannelInboundHandler

Overrides:

channelWritabilityChanged in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

flush

public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception

Description copied from class: ChannelDuplexHandler

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

Specified by:

flush in interface ChannelOutboundHandler

Overrides:

flush in class ChannelDuplexHandler

Parameters:

ctx - the ChannelHandlerContext for which the flush operation is made

Throws:

java.lang.Exception - thrown if an error occurs

format

protected java.lang.String format(ChannelHandlerContext ctx,
                                  java.lang.String eventName)

Formats an event and returns the formatted message.

Parameters:

eventName - the name of the event

format

protected java.lang.String format(ChannelHandlerContext ctx,
                                  java.lang.String eventName,
                                  java.lang.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 java.lang.String format(ChannelHandlerContext ctx,
                                  java.lang.String eventName,
                                  java.lang.Object firstArg,
                                  java.lang.Object secondArg)

Formats an event and returns the formatted message. This method is currently only used for formatting ChannelOutboundHandler.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