Class MaskingJsonGenerator

java.lang.Object

tools.jackson.core.JsonGenerator

tools.jackson.core.util.JsonGeneratorDelegate

net.logstash.logback.mask.MaskingJsonGenerator

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Versioned

public class MaskingJsonGenerator
extends JsonGeneratorDelegate

A JsonGenerator that can mask sensitive field values before delegating to a delegate JsonGenerator.

Identifying field values to mask by path

The MaskingJsonGenerator uses a collection of FieldMaskers to identify fields to mask by JSON path.

These field maskers are invoked after a new field name is written to determine if the field's value should be masked. If any masker returns a non-null value, then the returned value will be written as the field's value (instead of the original field value). Note that the masked value's type might differ from the fields original type.

Example FieldMaskers:

• FieldNameBasedFieldMasker
• PathBasedFieldMasker

Identifying field values to mask by value

The MaskingJsonGenerator uses a collection of ValueMaskers to mask field values by JSON path and field value.

These value maskers are invoked each time a new number or string scalar value is written to determine if the value should be masked. If all maskers return null, then the value is written as-is (i.e. not masked). If any masker returns non-null, then the returned value will be written as the field value.

Raw values are NOT masked.

It is much more efficient to mask field values by path, rather than by field value. Therefore, prefer using FieldMaskers instead of ValueMaskers whenever possible.

Example value maskers:

• RegexValueMasker

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MASK

Fields inherited from class JsonGeneratorDelegate

delegate, delegateCopyMethods

Constructor Summary

Constructors

Constructor	Description
MaskingJsonGenerator(JsonGenerator delegate, Collection<FieldMasker> fieldMaskers, Collection<ValueMasker> valueMaskers)

Method Summary

Modifier and Type	Method	Description
JsonGenerator	writeArray(double[] array, int offset, int length)
JsonGenerator	writeArray(int[] array, int offset, int length)
JsonGenerator	writeArray(long[] array, int offset, int length)
JsonGenerator	writeBinary(byte[] data)
JsonGenerator	writeBinary(byte[] data, int offset, int len)
int	writeBinary(InputStream data, int dataLength)
JsonGenerator	writeBinary(Base64Variant b64variant, byte[] data, int offset, int len)
int	writeBinary(Base64Variant b64variant, InputStream data, int dataLength)
JsonGenerator	writeBoolean(boolean state)
JsonGenerator	writeEmbeddedObject(Object object)
JsonGenerator	writeEndArray()
JsonGenerator	writeEndObject()
JsonGenerator	writeName(String name)
JsonGenerator	writeName(SerializableString name)
JsonGenerator	writeNull()
JsonGenerator	writeNumber(double v)
JsonGenerator	writeNumber(float v)
JsonGenerator	writeNumber(int v)
JsonGenerator	writeNumber(long v)
JsonGenerator	writeNumber(short v)
JsonGenerator	writeNumber(String encodedValue)
JsonGenerator	writeNumber(BigDecimal v)
JsonGenerator	writeNumber(BigInteger v)
JsonGenerator	writeObjectId(Object id)
JsonGenerator	writeObjectRef(Object id)
JsonGenerator	writeOmittedProperty(String fieldName)
JsonGenerator	writePropertyId(long id)
JsonGenerator	writeRaw(char c)
JsonGenerator	writeRaw(char[] text, int offset, int len)
JsonGenerator	writeRaw(String text)
JsonGenerator	writeRaw(String text, int offset, int len)
JsonGenerator	writeRaw(SerializableString raw)
JsonGenerator	writeRawUTF8String(byte[] text, int offset, int length)
JsonGenerator	writeRawValue(char[] text, int offset, int len)
JsonGenerator	writeRawValue(String text)
JsonGenerator	writeRawValue(String text, int offset, int len)
JsonGenerator	writeStartArray()
JsonGenerator	writeStartArray(Object forValue)
JsonGenerator	writeStartArray(Object forValue, int size)
JsonGenerator	writeStartObject()
JsonGenerator	writeStartObject(Object forValue)
JsonGenerator	writeStartObject(Object forValue, int size)
JsonGenerator	writeString(char[] text, int offset, int len)
JsonGenerator	writeString(Reader reader, int len)
JsonGenerator	writeString(String text)
JsonGenerator	writeString(SerializableString text)
JsonGenerator	writeTypeId(Object id)
JsonGenerator	writeUTF8String(byte[] text, int offset, int length)

Methods inherited from class JsonGeneratorDelegate

assignCurrentValue, canOmitProperties, canWriteObjectId, canWriteTypeId, close, configure, copyCurrentEvent, copyCurrentStructure, currentValue, delegate, flush, getCharacterEscapes, getHighestNonEscapedChar, getPrettyPrinter, getSchema, has, isClosed, isEnabled, objectWriteContext, streamWriteCapabilities, streamWriteContext, streamWriteFeatures, streamWriteOutputBuffered, streamWriteOutputTarget, version, writeArray, writeNumber, writePOJO, writeTree

Methods inherited from class JsonGenerator

_constructWriteException, _constructWriteException, _constructWriteException, _constructWriteException, _copyCurrentContents, _copyCurrentContentsExact, _copyCurrentFloatValue, _copyCurrentFloatValueExact, _copyCurrentIntValue, _copyCurrentStringValue, _reportArgumentError, _reportError, _reportUnsupportedOperation, _reportUnsupportedOperation, _verifyOffsets, _wrapIOFailure, _writeTypePrefixUsingNative, _writeTypePrefixUsingWrapper, copyCurrentEventExact, copyCurrentStructureExact, setCharacterEscapes, streamWriteConstraints, writeArrayPropertyStart, writeBinaryProperty, writeBooleanProperty, writeNullProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeObjectPropertyStart, writePOJOProperty, writeRawValue, writeStringProperty, writeTypePrefix, writeTypeSuffix

Methods inherited from class Object

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

Field Details

MASK

public static final String MASK

See Also:

• Constant Field Values

Constructor Details

MaskingJsonGenerator

public MaskingJsonGenerator(JsonGenerator delegate,
 Collection<FieldMasker> fieldMaskers,
 Collection<ValueMasker> valueMaskers)

Parameters:

delegate - the generator to which to write potentially masked JSON

fieldMaskers - FieldMaskers to mask fields

valueMaskers - ValueMaskers to mask values

Method Details

writeArray

public JsonGenerator writeArray(int[] array,
 int offset,
 int length)

Overrides:

writeArray in class JsonGeneratorDelegate

writeArray

public JsonGenerator writeArray(long[] array,
 int offset,
 int length)

Overrides:

writeArray in class JsonGeneratorDelegate

writeArray

public JsonGenerator writeArray(double[] array,
 int offset,
 int length)

Overrides:

writeArray in class JsonGeneratorDelegate

writeName

public JsonGenerator writeName(SerializableString name)

Overrides:

writeName in class JsonGeneratorDelegate

writeName

public JsonGenerator writeName(String name)

Overrides:

writeName in class JsonGeneratorDelegate

writePropertyId

public JsonGenerator writePropertyId(long id)

Overrides:

writePropertyId in class JsonGeneratorDelegate

writeBinary

public JsonGenerator writeBinary(Base64Variant b64variant,
 byte[] data,
 int offset,
 int len)

Overrides:

writeBinary in class JsonGeneratorDelegate

writeBinary

public JsonGenerator writeBinary(byte[] data)

Overrides:

writeBinary in class JsonGenerator

writeBinary

public JsonGenerator writeBinary(byte[] data,
 int offset,
 int len)

Overrides:

writeBinary in class JsonGenerator

writeBinary

public int writeBinary(Base64Variant b64variant,
 InputStream data,
 int dataLength)

Overrides:

writeBinary in class JsonGeneratorDelegate

writeBinary

public int writeBinary(InputStream data,
 int dataLength)

Overrides:

writeBinary in class JsonGenerator

writeBoolean

public JsonGenerator writeBoolean(boolean state)

Overrides:

writeBoolean in class JsonGeneratorDelegate

writeEmbeddedObject

public JsonGenerator writeEmbeddedObject(Object object)

Overrides:

writeEmbeddedObject in class JsonGeneratorDelegate

writeNull

public JsonGenerator writeNull()

Overrides:

writeNull in class JsonGeneratorDelegate

writeNumber

public JsonGenerator writeNumber(BigDecimal v)

Overrides:

writeNumber in class JsonGeneratorDelegate

writeNumber

public JsonGenerator writeNumber(BigInteger v)

Overrides:

writeNumber in class JsonGeneratorDelegate

writeNumber

public JsonGenerator writeNumber(double v)

Overrides:

writeNumber in class JsonGeneratorDelegate

writeNumber

public JsonGenerator writeNumber(float v)

Overrides:

writeNumber in class JsonGeneratorDelegate

writeNumber

public JsonGenerator writeNumber(int v)

Overrides:

writeNumber in class JsonGeneratorDelegate

writeNumber

public JsonGenerator writeNumber(short v)

Overrides:

writeNumber in class JsonGeneratorDelegate

writeNumber

public JsonGenerator writeNumber(long v)

Overrides:

writeNumber in class JsonGeneratorDelegate

writeNumber

public JsonGenerator writeNumber(String encodedValue)

Overrides:

writeNumber in class JsonGeneratorDelegate

writeObjectId

public JsonGenerator writeObjectId(Object id)

Overrides:

writeObjectId in class JsonGeneratorDelegate

writeObjectRef

public JsonGenerator writeObjectRef(Object id)

Overrides:

writeObjectRef in class JsonGeneratorDelegate

writeOmittedProperty

public JsonGenerator writeOmittedProperty(String fieldName)

Overrides:

writeOmittedProperty in class JsonGeneratorDelegate

writeRaw

public JsonGenerator writeRaw(char c)

Overrides:

writeRaw in class JsonGeneratorDelegate

writeRaw

public JsonGenerator writeRaw(char[] text,
 int offset,
 int len)

Overrides:

writeRaw in class JsonGeneratorDelegate

writeRaw

public JsonGenerator writeRaw(String text)

Overrides:

writeRaw in class JsonGeneratorDelegate

writeRaw

public JsonGenerator writeRaw(String text,
 int offset,
 int len)

Overrides:

writeRaw in class JsonGeneratorDelegate

writeRaw

public JsonGenerator writeRaw(SerializableString raw)

Overrides:

writeRaw in class JsonGeneratorDelegate

writeRawValue

public JsonGenerator writeRawValue(String text)

Overrides:

writeRawValue in class JsonGeneratorDelegate

writeRawValue

public JsonGenerator writeRawValue(String text,
 int offset,
 int len)

Overrides:

writeRawValue in class JsonGeneratorDelegate

writeRawValue

public JsonGenerator writeRawValue(char[] text,
 int offset,
 int len)

Overrides:

writeRawValue in class JsonGeneratorDelegate

writeRawUTF8String

public JsonGenerator writeRawUTF8String(byte[] text,
 int offset,
 int length)

Overrides:

writeRawUTF8String in class JsonGeneratorDelegate

writeStartArray

public JsonGenerator writeStartArray()

Overrides:

writeStartArray in class JsonGeneratorDelegate

writeStartArray

public JsonGenerator writeStartArray(Object forValue)

Overrides:

writeStartArray in class JsonGeneratorDelegate

writeStartArray

public JsonGenerator writeStartArray(Object forValue,
 int size)

Overrides:

writeStartArray in class JsonGeneratorDelegate

writeStartObject

public JsonGenerator writeStartObject()

Overrides:

writeStartObject in class JsonGeneratorDelegate

writeStartObject

public JsonGenerator writeStartObject(Object forValue)

Overrides:

writeStartObject in class JsonGeneratorDelegate

writeStartObject

public JsonGenerator writeStartObject(Object forValue,
 int size)

Overrides:

writeStartObject in class JsonGeneratorDelegate

writeString

public JsonGenerator writeString(char[] text,
 int offset,
 int len)

Overrides:

writeString in class JsonGeneratorDelegate

writeString

public JsonGenerator writeString(String text)

Overrides:

writeString in class JsonGeneratorDelegate

writeString

public JsonGenerator writeString(SerializableString text)

Overrides:

writeString in class JsonGeneratorDelegate

writeString

public JsonGenerator writeString(Reader reader,
 int len)

Overrides:

writeString in class JsonGeneratorDelegate

writeUTF8String

public JsonGenerator writeUTF8String(byte[] text,
 int offset,
 int length)

Overrides:

writeUTF8String in class JsonGeneratorDelegate

writeTypeId

public JsonGenerator writeTypeId(Object id)

Overrides:

writeTypeId in class JsonGeneratorDelegate

writeEndArray

public JsonGenerator writeEndArray()

Overrides:

writeEndArray in class JsonGeneratorDelegate

writeEndObject

public JsonGenerator writeEndObject()

Overrides:

writeEndObject in class JsonGeneratorDelegate