org.finra.herd.core

Class HerdStringUtils

java.lang.Object

org.finra.herd.core.HerdStringUtils

public class HerdStringUtils
extends Object

HerdStringUtils

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIDDEN_TEXT

Constructor Summary

Constructors

Constructor and Description
HerdStringUtils()

Method Summary

Modifier and Type	Method and Description
static void	checkCsvInjection(String text, String errorMessage) Check if the text is vulnerable to CSV Injection attack.
static Integer	convertStringToInteger(String stringValue, Integer defaultValue) Convert a String to an Integer, returning a default value if the string is blank.
static String	decodeBase64(String base64EncodedText) Decodes and return the base64 encoded string.
static String	getFirstLevelPrefix(String prefix) Get first level prefix from the relative path.
static String	getMinimizedFilePath(String filePath, String directoryPath) This method will minimize a file path by removing the first appearance of the directory path string.
static String	getShortDescription(String description, Integer shortDescMaxLength) Truncates the description field to a configurable value thereby producing a 'short description'
static String	sanitizeLogText(String loggingText) Sanitize log text by replacing the password
static String	stripHtml(String fragment, String... whitelistTags) Strips HTML tags from a given input String, allows some tags to be retained via a whitelist
static boolean	verifyHerdVersionConformingString(String versionString) Determines if a String conforms to Herd's versioning scheme

Methods inherited from class java.lang.Object

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

Field Detail

HIDDEN_TEXT

public static final String HIDDEN_TEXT

See Also:

Constant Field Values

Constructor Detail

HerdStringUtils

public HerdStringUtils()

Method Detail

decodeBase64

public static String decodeBase64(String base64EncodedText)

Decodes and return the base64 encoded string.

Parameters:

base64EncodedText - the base64 encoded string

Returns:

the decoded string

getMinimizedFilePath

public static String getMinimizedFilePath(String filePath,
                                          String directoryPath)

This method will minimize a file path by removing the first appearance of the directory path string.

Parameters:

filePath - the file path to minimize

directoryPath - the directory path to remove

Returns:

the minimized file path

getShortDescription

public static String getShortDescription(String description,
                                         Integer shortDescMaxLength)

Truncates the description field to a configurable value thereby producing a 'short description'

Parameters:

description - the specified description

shortDescMaxLength - the short description maximum length

Returns:

truncated (short) description

stripHtml

public static String stripHtml(String fragment,
                               String... whitelistTags)

Strips HTML tags from a given input String, allows some tags to be retained via a whitelist

Parameters:

fragment - the specified String

whitelistTags - the specified whitelist tags

Returns:

cleaned String with allowed tags

checkCsvInjection

public static void checkCsvInjection(String text,
                                     String errorMessage)

Check if the text is vulnerable to CSV Injection attack.

Parameters:

text - the text

errorMessage - the error message in the exception when CVS Injection check fails

convertStringToInteger

public static Integer convertStringToInteger(String stringValue,
                                             Integer defaultValue)

Convert a String to an Integer, returning a default value if the string is blank.

Parameters:

stringValue - the string to convert, may be null

defaultValue - the default value

Returns:

the Integer represented by the string, or the default if the string is blank

sanitizeLogText

public static String sanitizeLogText(String loggingText)

Sanitize log text by replacing the password

Parameters:

loggingText - logging text

Returns:

sanitized text

verifyHerdVersionConformingString

public static boolean verifyHerdVersionConformingString(String versionString)

Determines if a String conforms to Herd's versioning scheme

Parameters:

versionString - The given input string

Returns:

boolean true if the input conforms, false otherwise

getFirstLevelPrefix

public static String getFirstLevelPrefix(String prefix)

Get first level prefix from the relative path. The path is assumed not to start from the "/" character.

Parameters:

prefix - the given prefix

Returns:

if exists, first level prefix including trailing slash, path value as it was specified otherwise