org.glassfish.jersey.filter
Class LoggingFilter

java.lang.Object
  org.glassfish.jersey.filter.LoggingFilter

All Implemented Interfaces:

javax.ws.rs.client.ClientRequestFilter, javax.ws.rs.client.ClientResponseFilter, javax.ws.rs.container.ContainerRequestFilter, javax.ws.rs.container.ContainerResponseFilter, javax.ws.rs.ext.WriterInterceptor

@PreMatching
@Priority(value=-2147483648)
public class LoggingFilter
extends Object
implements javax.ws.rs.container.ContainerRequestFilter, javax.ws.rs.client.ClientRequestFilter, javax.ws.rs.container.ContainerResponseFilter, javax.ws.rs.client.ClientResponseFilter, javax.ws.rs.ext.WriterInterceptor

Universal logging filter. Can be used on client or server side. Has the highest priority.

Author:

Pavel Bucek (pavel.bucek at oracle.com), Martin Matula (martin.matula at oracle.com)

Constructor Summary

LoggingFilter()
Create a logging filter logging the request and response to a default JDK logger, named as the fully qualified class name of this class.

LoggingFilter(Logger logger, boolean printEntity)
Create a logging filter with custom logger and custom settings of entity logging.

LoggingFilter(Logger logger, int maxEntitySize)
Creates a logging filter with custom logger and entity logging turned on, but potentially limiting the size of entity to be buffered and logged.

Method Summary

void	aroundWriteTo(javax.ws.rs.ext.WriterInterceptorContext writerInterceptorContext)
void	filter(javax.ws.rs.client.ClientRequestContext context)
void	filter(javax.ws.rs.client.ClientRequestContext requestContext, javax.ws.rs.client.ClientResponseContext responseContext)
void	filter(javax.ws.rs.container.ContainerRequestContext context)
void	filter(javax.ws.rs.container.ContainerRequestContext requestContext, javax.ws.rs.container.ContainerResponseContext responseContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingFilter

public LoggingFilter()

Create a logging filter logging the request and response to a default JDK logger, named as the fully qualified class name of this class. Entity logging is turned off by default.

LoggingFilter

public LoggingFilter(Logger logger,
                     boolean printEntity)

Create a logging filter with custom logger and custom settings of entity logging.

Parameters:

logger - the logger to log requests and responses.

printEntity - if true, entity will be logged as well up to the default maxEntitySize, which is 10KB

LoggingFilter

public LoggingFilter(Logger logger,
                     int maxEntitySize)

Creates a logging filter with custom logger and entity logging turned on, but potentially limiting the size of entity to be buffered and logged.

Parameters:

logger - the logger to log requests and responses.

maxEntitySize - maximum number of entity bytes to be logged (and buffered) - if the entity is larger, logging filter will print (and buffer in memory) only the specified number of bytes and print "...more..." string at the end.

Method Detail

filter

public void filter(javax.ws.rs.client.ClientRequestContext context)
            throws IOException

Specified by:

filter in interface javax.ws.rs.client.ClientRequestFilter

Throws:

IOException

filter

public void filter(javax.ws.rs.client.ClientRequestContext requestContext,
                   javax.ws.rs.client.ClientResponseContext responseContext)
            throws IOException

Specified by:

filter in interface javax.ws.rs.client.ClientResponseFilter

Throws:

IOException

filter

public void filter(javax.ws.rs.container.ContainerRequestContext context)
            throws IOException

Specified by:

filter in interface javax.ws.rs.container.ContainerRequestFilter

Throws:

IOException

filter

public void filter(javax.ws.rs.container.ContainerRequestContext requestContext,
                   javax.ws.rs.container.ContainerResponseContext responseContext)
            throws IOException

Specified by:

filter in interface javax.ws.rs.container.ContainerResponseFilter

Throws:

IOException

aroundWriteTo

public void aroundWriteTo(javax.ws.rs.ext.WriterInterceptorContext writerInterceptorContext)
                   throws IOException,
                          javax.ws.rs.WebApplicationException

Specified by:

aroundWriteTo in interface javax.ws.rs.ext.WriterInterceptor

Throws:

IOException

javax.ws.rs.WebApplicationException