com.delphix.masking.helpers

Class LookupFileVerifier

java.lang.Object

com.delphix.masking.helpers.LookupFileVerifier

public final class LookupFileVerifier
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UTF8_BOM

Method Summary

Modifier and Type	Method and Description
static java.lang.String	cleanString(java.lang.String input, java.lang.Boolean isFirst)
static java.util.Map<java.lang.String,java.lang.String>	createReplacementMap(byte[] lookupFileBytes, java.lang.String lookupFileUri, java.lang.String delimiter, boolean caseSensitive) This creates a value to replacement map from the bytes of a lookup file.
static java.lang.String	getBytesHash(byte[] bytes)
static byte[]	getLookupFileBytes(ComponentService serviceProvider, FileReference lookupFile)
static java.util.Collection<java.lang.String>	setupFile(ComponentService serviceProvider, FileReference lookupFile, LogService logger, com.google.common.cache.Cache<java.lang.String,java.util.List<java.lang.String>> lookupLists) This method reads the lookupFile's values (providing encoding and BOM verification) and initializes the replacements caching for faster lookup.
static java.util.Collection<java.lang.String>	setupFile(ComponentService serviceProvider, FileReference lookupFile, LogService logger, com.google.common.cache.Cache<java.lang.String,java.util.List<java.lang.String>> lookupLists, java.lang.Boolean allowSingleSpacesLine, java.lang.Boolean trimWhitespace) Overloading the method to keep the signature of the old setupFile method intact.
static void	verifyEncoding(byte[] bytes)

Methods inherited from class java.lang.Object

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

Field Detail

UTF8_BOM

public static final java.lang.String UTF8_BOM

See Also:

Constant Field Values

Method Detail

cleanString

public static java.lang.String cleanString(java.lang.String input,
                                           java.lang.Boolean isFirst)

Parameters:

input - - single line of Lookup File

isFirst - - true if that's first line of the file (to be checked for BOM)

Returns:

- verified line (trimmed, BOM removed if present)

verifyEncoding

public static void verifyEncoding(byte[] bytes)
                           throws ComponentConfigurationException

Parameters:

bytes - - the row bytes presentation of the LookupFile

Throws:

ComponentConfigurationException - - if file isn't fully UTF-8 compatible

getBytesHash

public static java.lang.String getBytesHash(byte[] bytes)

Parameters:

bytes - - the row bytes presentation of the LookupFile

Returns:

- SHA-256 hash of the byte[]

getLookupFileBytes

public static byte[] getLookupFileBytes(@Nonnull
                                        ComponentService serviceProvider,
                                        FileReference lookupFile)

setupFile

public static java.util.Collection<java.lang.String> setupFile(@Nonnull
                                                               ComponentService serviceProvider,
                                                               FileReference lookupFile,
                                                               LogService logger,
                                                               com.google.common.cache.Cache<java.lang.String,java.util.List<java.lang.String>> lookupLists)

This method reads the lookupFile's values (providing encoding and BOM verification) and initializes the replacements caching for faster lookup.

Parameters:

serviceProvider - - ComponentService

lookupFile - - file, containing the masked values

logger - - LogService

lookupLists - - cache for lookup values per hashed input

Returns:

Collection of lookup file contained values

setupFile

public static java.util.Collection<java.lang.String> setupFile(@Nonnull
                                                               ComponentService serviceProvider,
                                                               FileReference lookupFile,
                                                               LogService logger,
                                                               com.google.common.cache.Cache<java.lang.String,java.util.List<java.lang.String>> lookupLists,
                                                               java.lang.Boolean allowSingleSpacesLine,
                                                               java.lang.Boolean trimWhitespace)

Overloading the method to keep the signature of the old setupFile method intact. It is called from the multiple algorithms. Adding boolean for allowing LookupFile to contain single line of spaces. It will be used for SecureLookup algorithm only. Multiple customers used old Secure Lookup algorithm to remove values (i.e. to replace with space). We should provide the similar behavior.

Parameters:

serviceProvider - - ComponentService

lookupFile - - file, containing the masked values

logger - - LogService

lookupLists - - cache for lookup values per hashed input

allowSingleSpacesLine - - allow single line of spaces in the lookup file as a valid replacement value

trimWhitespace - - trim whitespaces for each value in the lookup file

Returns:

Collection of lookup file contained values

createReplacementMap

public static java.util.Map<java.lang.String,java.lang.String> createReplacementMap(byte[] lookupFileBytes,
                                                                                    java.lang.String lookupFileUri,
                                                                                    java.lang.String delimiter,
                                                                                    boolean caseSensitive)

This creates a value to replacement map from the bytes of a lookup file. If there is a BOM, it is removed. A CaseInsensitiveMap is returned if the lookup values should not be case-sensitive. Otherwise, a HashMap.

Parameters:

lookupFileBytes - byte[] of lookup file contents

lookupFileUri - lookup file URI

delimiter - the literal string delimiter that separates a value/replacement pair

caseSensitive - whether the lookup value is case-sensitive

Returns:

Map of values to replacements from lookup file contents