gov.va.vinci.leo.tools

Class LeoUtils

java.lang.Object

gov.va.vinci.leo.tools.LeoUtils

public class LeoUtils
extends Object

Commonly used functions.

Author:

thomasginter

Constructor Summary

Constructors

Constructor and Description
LeoUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.uima.resource.Parameter[]	addParameter(org.apache.uima.resource.Parameter p, org.apache.uima.resource.Parameter[] parameters) Add the parameter p to the array of parameters.
static URL	createURL(String name) Computes the absolute URL for this import, using the relative location or name, whichever is specified by this import object.
static String	extractPearFile(File installDir, File pearFile, boolean doVerification, boolean cleanInstallDir) Extracts the contents of a PEAR file to the directory specified, optionally performs a verification step.
static String	filterText(String input, List<TextFilter> filters) Return a String that has applied the list of filters to the input string.
static String	getFileURI(File f) Return a URI string locator for the File object provided.
static String	getHeaderManipulationSafeString(Object object) returns a Header-Manipulation safe string using a "WhiteList" approach.
static org.apache.uima.resource.Parameter	getParameter(String name, org.apache.uima.resource.Parameter[] parameters) Return the Parameter in the array whose name matches the name provided.
static Class<?>	getRuntimeClass() Determines the currently executing runtime class.
static Set<org.apache.uima.resource.metadata.ConfigurationParameter>	getStaticConfigurationParameters(Class c) Create the set of ConfigurationParameter objects from the Param class of an object.
static String	getTimestampDateDotTime() Return a timestamp in the format of yyyyMMdd.HHmmss.
static String	getTimestampDateUnderscoreTime() Return a timestamp in the format of yyyyMMdd_HHmmss.
static String	getUUID() Generate a random UUID string.
static List<File>	listFiles(File src, FileFilter filter, boolean recurse) Return a list of File Objects in a directory.
static groovy.util.ConfigObject	loadConfigFile(String environment, String... configFilePaths) Load the config file(s).
static Map<String,String>	parseMappingString(String jsonString) Convert the JSON formatted string into a Map of Strings.

Methods inherited from class java.lang.Object

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

Constructor Detail

LeoUtils

public LeoUtils()

Method Detail

getTimestampDateDotTime

public static String getTimestampDateDotTime()

Return a timestamp in the format of yyyyMMdd.HHmmss.

Returns:

String representation of a timestamp

getTimestampDateUnderscoreTime

public static String getTimestampDateUnderscoreTime()

Return a timestamp in the format of yyyyMMdd_HHmmss.

Returns:

String representation of a timestamp

getUUID

public static String getUUID()

Generate a random UUID string.

Returns:

String representation of a UUID

createURL

public static URL createURL(String name)
                     throws org.apache.uima.util.InvalidXMLException

Computes the absolute URL for this import, using the relative location or name, whichever is specified by this import object.

Parameters:

name - the name of this import's target.

Returns:

the url of the import.

Throws:

org.apache.uima.util.InvalidXMLException - if the import could not be resolved

getFileURI

public static String getFileURI(File f)

Return a URI string locator for the File object provided.

Parameters:

f - the file to get URI for.

Returns:

the file URI.

listFiles

public static List<File> listFiles(File src,
                                   FileFilter filter,
                                   boolean recurse)

Return a list of File Objects in a directory. Optionally return only a list of Files that match the given FileFilter. Recurse into subdirectories if indicated. If no filter is provided then return all the files in the directory.

Parameters:

src - Source directory where the search will be performed.

filter - Optional, File filter to limit results that are returned.

recurse - If true then recurse into subdirectories, only return this directory results if false

Returns:

List of File objects found in this directory

extractPearFile

public static String extractPearFile(File installDir,
                                     File pearFile,
                                     boolean doVerification,
                                     boolean cleanInstallDir)
                              throws org.apache.uima.pear.tools.PackageInstallerException,
                                     IOException

Extracts the contents of a PEAR file to the directory specified, optionally performs a verification step. If there are no errors then return the path to the root descriptor file.

Parameters:

installDir - Directory where the pear file will be extracted.

pearFile - Pear file to extract

doVerification - If true then the PackageInstaller will perform an optional validation step

cleanInstallDir - Clean out the installation directory before extracting

Returns:

Path to the root component descriptor file

Throws:

org.apache.uima.pear.tools.PackageInstallerException - If there is an error extracting the PEAR file

IOException - If there is an error retrieving the path toe hte root component descriptor file

getRuntimeClass

public static Class<?> getRuntimeClass()

Determines the currently executing runtime class.

Returns:

The currently executing runtime class

loadConfigFile

public static groovy.util.ConfigObject loadConfigFile(String environment,
                                                      String... configFilePaths)
                                               throws IOException

Load the config file(s).

Parameters:

environment - name of the environment to load

configFilePaths - paths the config files to load, local or remote

Returns:

ConfigObject with accumulated variables representing the environment

Throws:

IOException - if there is a problem reading the config files

filterText

public static String filterText(String input,
                                List<TextFilter> filters)
                         throws IOException

Return a String that has applied the list of filters to the input string. If there are no filters to apply just returns the input string.

Parameters:

input - Text to be filtered if there are filters defined

filters - List of text filters to apply to the input text

Returns:

Filtered text or input text if no filters defined

Throws:

IOException - if there is an error getting the bytes from the filtered text

getStaticConfigurationParameters

public static Set<org.apache.uima.resource.metadata.ConfigurationParameter> getStaticConfigurationParameters(Class c)

Create the set of ConfigurationParameter objects from the Param class of an object.

Parameters:

c - Param class

Returns:

Set of ConfigurationParameter objects

getParameter

public static org.apache.uima.resource.Parameter getParameter(String name,
                                                              org.apache.uima.resource.Parameter[] parameters)

Return the Parameter in the array whose name matches the name provided.

Parameters:

name - Name of the parameter to find

parameters - Array of parameters to search

Returns:

The matching parameter or null if the parameter is not found or the arguments are empty

addParameter

public static org.apache.uima.resource.Parameter[] addParameter(org.apache.uima.resource.Parameter p,
                                                                org.apache.uima.resource.Parameter[] parameters)

Add the parameter p to the array of parameters.

Parameters:

p - Parameter to add

parameters - Array of parameters to which the parameter will be added

Returns:

New Array of Parameter objects which include the parameter provided.

parseMappingString

public static Map<String,String> parseMappingString(String jsonString)
                                             throws com.google.gson.JsonSyntaxException

Convert the JSON formatted string into a Map of Strings. i.e. {"jsonString":"class"}, {"C":"Valid","IR":"Invalid","IM":"InvalidMeasure"}

Parameters:

jsonString - JSON formatted validation string map

Returns:

HashMap of key, value string pairs. If jsonString is empty then returns an empty map.

Throws:

com.google.gson.JsonSyntaxException - if the JSON string is invalid

getHeaderManipulationSafeString

public static String getHeaderManipulationSafeString(Object object)

returns a Header-Manipulation safe string using a "WhiteList" approach. Note that the algorithm is designed to satisfy the HP Fortify Scanning algorithms.

Parameters:

value - the String value to be made Header-Manipulation safe

Returns:

the Header-Manipulation safe string