craterdog.smart

Class CensorshipSerializer

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializer<java.lang.String>

craterdog.smart.CensorshipSerializer

All Implemented Interfaces:

com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable, com.fasterxml.jackson.databind.ser.ContextualSerializer

public class CensorshipSerializer
extends com.fasterxml.jackson.databind.JsonSerializer<java.lang.String>
implements com.fasterxml.jackson.databind.ser.ContextualSerializer

This class handles the masking of sensitive attributes during string serialization. Any string attributes that are annotated with the @Sensitive(mask="some pattern") annotation will be masked accordingly.

Author:

Yan Ma

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer

com.fasterxml.jackson.databind.JsonSerializer.None

Constructor Summary

Constructors

Constructor and Description
CensorshipSerializer() The default constructor creates a serializer with no mask.
CensorshipSerializer(java.lang.String mask, char maskingCharacter) This constructor creates a serializer with the specified mask and masking character.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonSerializer<?>	createContextual(com.fasterxml.jackson.databind.SerializerProvider provider, com.fasterxml.jackson.databind.BeanProperty property)
void	serialize(java.lang.String value, com.fasterxml.jackson.core.JsonGenerator generator, com.fasterxml.jackson.databind.SerializerProvider provider)

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer

acceptJsonFormatVisitor, getDelegatee, handledType, isEmpty, isEmpty, isUnwrappingSerializer, replaceDelegatee, serializeWithType, unwrappingSerializer, usesObjectId

Methods inherited from class java.lang.Object

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

Constructor Detail

CensorshipSerializer

public CensorshipSerializer()

The default constructor creates a serializer with no mask. None of the characters of the string will be masked.

CensorshipSerializer

public CensorshipSerializer(java.lang.String mask,
                            char maskingCharacter)

This constructor creates a serializer with the specified mask and masking character. The characters of a string serialized using this serializer will be censored using the specified mask.

Parameters:

mask - The pattern to be used to mask the sensitive attribute.

maskingCharacter - The character to be used for masking.

Method Detail

createContextual

public com.fasterxml.jackson.databind.JsonSerializer<?> createContextual(com.fasterxml.jackson.databind.SerializerProvider provider,
                                                                         com.fasterxml.jackson.databind.BeanProperty property)
                                                                  throws com.fasterxml.jackson.databind.JsonMappingException

Specified by:

createContextual in interface com.fasterxml.jackson.databind.ser.ContextualSerializer

Throws:

com.fasterxml.jackson.databind.JsonMappingException

serialize

public void serialize(java.lang.String value,
                      com.fasterxml.jackson.core.JsonGenerator generator,
                      com.fasterxml.jackson.databind.SerializerProvider provider)
               throws java.io.IOException,
                      com.fasterxml.jackson.core.JsonProcessingException

Specified by:

serialize in class com.fasterxml.jackson.databind.JsonSerializer<java.lang.String>

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonProcessingException