org.owasp.esapi.logging.cleaning

Class CodecLogScrubber

java.lang.Object

org.owasp.esapi.logging.cleaning.CodecLogScrubber

All Implemented Interfaces:

LogScrubber

public class CodecLogScrubber
extends Object
implements LogScrubber

Implementation of a LogScrubber which passes strings through a delegate codec with specific character immunity sets.

Constructor Summary

Constructors

Constructor and Description
CodecLogScrubber(Codec<?> messageCodec, char[] immuneChars) Ctr.

Method Summary

Modifier and Type	Method and Description
String	cleanMessage(String message) Updates the given message to account for restrictions for this implementation and returns the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodecLogScrubber

public CodecLogScrubber(Codec<?> messageCodec,
                        char[] immuneChars)

Ctr.

Parameters:

messageCodec - Delegate codec. Cannot be null

immuneChars - Immune character set.

Method Detail

cleanMessage

public String cleanMessage(String message)

Description copied from interface: LogScrubber

Updates the given message to account for restrictions for this implementation and returns the result.

Specified by:

cleanMessage in interface LogScrubber

Parameters:

message - Original message to clean.

Returns:

Cleaned message.