org.gitlab4j.api.utils

Class MaskingLoggingFilter

java.lang.Object

org.gitlab4j.api.utils.MaskingLoggingFilter

All Implemented Interfaces:

javax.ws.rs.client.ClientRequestFilter, javax.ws.rs.client.ClientResponseFilter, javax.ws.rs.ext.WriterInterceptor

@Priority(value=-2147483648)
public class MaskingLoggingFilter
extends Object
implements javax.ws.rs.client.ClientRequestFilter, javax.ws.rs.client.ClientResponseFilter, javax.ws.rs.ext.WriterInterceptor

This class logs request and response info masking HTTP header values that are known to contain sensitive information. This class was patterned after org.glassfish.jersey.logging.LoggingInterceptor, but written in such a way that it could be sub-classed and have its behavior modified.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MaskingLoggingFilter.LoggingStream This class is responsible for logging the request entities, it will truncate at maxEntitySize and add "...more..." to the end of the entity log string.

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicLong	_id
static List<String>	DEFAULT_MASKED_HEADER_NAMES Default list of header names that should be masked.
protected static String	ENTITY_STREAM_PROPERTY Property name for the entity stream property
protected Level	level
protected Logger	logger
protected static String	LOGGING_ID_PROPERTY Property name for the logging record id property
protected Set<String>	maskedHeaderNames
protected int	maxEntitySize
protected static String	REQUEST_PREFIX Prefix for request log entries.
protected static String	RESPONSE_PREFIX Prefix for response log entries.
protected static String	SECTION_PREFIX Prefix that marks the beginning of a request or response section.

Constructor Summary

Constructors

Constructor and Description
MaskingLoggingFilter(Logger logger, Level level) Creates a masking logging filter for the specified logger with entity logging disabled.
MaskingLoggingFilter(Logger logger, Level level, int maxEntitySize) Creates a masking logging filter for the specified logger.
MaskingLoggingFilter(Logger logger, Level level, int maxEntitySize, List<String> maskedHeaderNames) Creates a masking logging filter for the specified logger.
MaskingLoggingFilter(Logger logger, Level level, List<String> maskedHeaderNames) Creates a masking logging filter for the specified logger with entity logging disabled.

Method Summary

Modifier and Type	Method and Description
void	addMaskedHeaderName(String maskedHeaderName) Add a header name to the list of masked header names.
protected StringBuilder	appendId(StringBuilder sb, long id)
void	aroundWriteTo(javax.ws.rs.ext.WriterInterceptorContext context)
protected void	buildEntityLogString(StringBuilder sb, byte[] entity, int entitySize, Charset charset)
void	filter(javax.ws.rs.client.ClientRequestContext requestContext)
void	filter(javax.ws.rs.client.ClientRequestContext requestContext, javax.ws.rs.client.ClientResponseContext responseContext)
protected Set<Map.Entry<String,List<String>>>	getSortedHeaders(Set<Map.Entry<String,List<String>>> headers)
protected void	log(StringBuilder sb)
protected void	printHeaders(StringBuilder sb, long id, String prefix, javax.ws.rs.core.MultivaluedMap<String,String> headers) Logs each of the HTTP headers, masking the value of the header if the header key is in the list of masked header names.
protected void	printRequestLine(StringBuilder sb, String note, long id, String method, URI uri)
protected void	printResponseLine(StringBuilder sb, String note, long id, int status)
void	setMaskedHeaderNames(List<String> maskedHeaderNames) Set the list of header names to mask values for.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MASKED_HEADER_NAMES

public static final List<String> DEFAULT_MASKED_HEADER_NAMES

Default list of header names that should be masked.

REQUEST_PREFIX

protected static final String REQUEST_PREFIX

Prefix for request log entries.

See Also:

Constant Field Values

RESPONSE_PREFIX

protected static final String RESPONSE_PREFIX

Prefix for response log entries.

See Also:

Constant Field Values

SECTION_PREFIX

protected static final String SECTION_PREFIX

Prefix that marks the beginning of a request or response section.

See Also:

Constant Field Values

ENTITY_STREAM_PROPERTY

protected static final String ENTITY_STREAM_PROPERTY

Property name for the entity stream property

LOGGING_ID_PROPERTY

protected static final String LOGGING_ID_PROPERTY

Property name for the logging record id property

logger

protected final Logger logger

level

protected final Level level

maxEntitySize

protected final int maxEntitySize

_id

protected final AtomicLong _id

maskedHeaderNames

protected Set<String> maskedHeaderNames

Constructor Detail

MaskingLoggingFilter

public MaskingLoggingFilter(Logger logger,
                            Level level)

Creates a masking logging filter for the specified logger with entity logging disabled.

Parameters:

logger - the logger to log messages to

level - level at which the messages will be logged

MaskingLoggingFilter

public MaskingLoggingFilter(Logger logger,
                            Level level,
                            int maxEntitySize)

Creates a masking logging filter for the specified logger.

Parameters:

logger - the logger to log messages to

level - level at which the messages will be logged

maxEntitySize - maximum number of entity bytes to be logged. When logging if the maxEntitySize is reached, the entity logging will be truncated at maxEntitySize and "...more..." will be added at the end of the log entry. If maxEntitySize is <= 0, entity logging will be disabled

MaskingLoggingFilter

public MaskingLoggingFilter(Logger logger,
                            Level level,
                            List<String> maskedHeaderNames)

Creates a masking logging filter for the specified logger with entity logging disabled.

Parameters:

logger - the logger to log messages to

level - level at which the messages will be logged

maskedHeaderNames - a list of header names that should have the values masked

MaskingLoggingFilter

public MaskingLoggingFilter(Logger logger,
                            Level level,
                            int maxEntitySize,
                            List<String> maskedHeaderNames)

Creates a masking logging filter for the specified logger.

Parameters:

logger - the logger to log messages to

level - level at which the messages will be logged

maxEntitySize - maximum number of entity bytes to be logged. When logging if the maxEntitySize is reached, the entity logging will be truncated at maxEntitySize and "...more..." will be added at the end of the log entry. If maxEntitySize is <= 0, entity logging will be disabled

maskedHeaderNames - a list of header names that should have the values masked

Method Detail

setMaskedHeaderNames

public void setMaskedHeaderNames(List<String> maskedHeaderNames)

Set the list of header names to mask values for. If null, will clear the header names to mask.

Parameters:

maskedHeaderNames - a list of header names that should have the values masked, if null, will clear the header names to mask

addMaskedHeaderName

public void addMaskedHeaderName(String maskedHeaderName)

Add a header name to the list of masked header names.

Parameters:

maskedHeaderName - the masked header name to add

log

protected void log(StringBuilder sb)

appendId

protected StringBuilder appendId(StringBuilder sb,
                                 long id)

printRequestLine

protected void printRequestLine(StringBuilder sb,
                                String note,
                                long id,
                                String method,
                                URI uri)

printResponseLine

protected void printResponseLine(StringBuilder sb,
                                 String note,
                                 long id,
                                 int status)

getSortedHeaders

protected Set<Map.Entry<String,List<String>>> getSortedHeaders(Set<Map.Entry<String,List<String>>> headers)

printHeaders

protected void printHeaders(StringBuilder sb,
                            long id,
                            String prefix,
                            javax.ws.rs.core.MultivaluedMap<String,String> headers)

Logs each of the HTTP headers, masking the value of the header if the header key is in the list of masked header names.

Parameters:

sb - the StringBuilder to build up the logging info in

id - the ID for the logging line

prefix - the logging line prefix character

headers - a MultiValue map holding the header keys and values

buildEntityLogString

protected void buildEntityLogString(StringBuilder sb,
                                    byte[] entity,
                                    int entitySize,
                                    Charset charset)

filter

public void filter(javax.ws.rs.client.ClientRequestContext requestContext)
            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

aroundWriteTo

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

Specified by:

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

Throws:

IOException

javax.ws.rs.WebApplicationException