Toolset (tools 1.0.0 API)

java.lang.Object
- org.devopology.tools.Toolset

Direct Known Subclasses:

Packager
```
public class Toolset
extends Object
```
Class to implement common methods

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIGURATION_EXECUTE_SHOW_CONTENT`
`static String`	`CONFIGURATION_LOGGER_MUTE`
`static String`	`CP` Common system executables
`protected File`	`currentWorkingDirectory` Track the current working directory
`static int`	`DIRECTORY`
`protected static int`	`EXIT_CODE` Exit code of the last executable execution
`static int`	`FILE`
`static String`	`FIND`
`static String`	`GREP`
`static String`	`GZIP`
`static String`	`KILL`
`static String`	`LS`
`static String`	`MKDIR`
`static int`	`NOT_FOUND` File types
`protected Properties`	`properties` Configuration
`static String`	`PS`
`static String`	`RM`
`static String`	`SYSTEMCTL` Systemdctl executable
`static String`	`SYSTEMD_SERVICE_ROOT` Systemd root path for service files
`static String`	`TAR`
`static String`	`UNZIP`
`static String`	`ZIP`

Constructor Summary

Constructors
Constructor and Description

Toolset()
Constructor

Constructors
Constructor and Description
`Toolset()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`File`	`absoluteFile()` Method to get an absolute File in the current working directory
`File`	`absoluteFile(String path)` Method to get an absolute File
`String`	`absolutePath(File file)` Method to get an absolute path
`String`	`absolutePath(String path)` Method to get an absolute path
`String[]`	`arguments(List<String> argumentList)`
`String[]`	`arguments(String... arguments)` Method to convert a variable argument list into a an array
`void`	`changeDirectory(String path)` Method to change the current working directory
`void`	`checkExitCode(int expectedExitCode)` Method to check the exit code of the last execute command
`long`	`checksumCRC32(String file)`
`void`	`cleanDirectory(String directory)`
`void`	`copyDirectory(String srcDir, String destDir)`
`void`	`copyDirectoryToDirectory(String srcDir, String destDir)`
`void`	`copyFile(String srcFile, String destFile)`
`void`	`debug(Object object)` Method to log a debug message
`void`	`deleteDirectory(String directory)`
`boolean`	`deleteQuietly(String file)`
`boolean`	`directoryContains(String directory, String child)`
`void`	`error(Object object)` Method to log an error error message
`ExecutionResult`	`execute(String executable, String[] arguments)` Method to execute an executable
`ExecutionResult`	`execute(String executable, String[] arguments, int expectedExitCode)` Method to execute an executable
`boolean`	`exists(String path)` Method to determine if a file exists
`int`	`exitCode()` Method to get the exit code of the last execute command
`void`	`forceDelete(String file)`
`void`	`forceMkdir(String directory)`
`void`	`forceMkdirParent(String file)`
`String`	`getConfiguration(String key, String defaultValue)` Method to get a configuration value based on key
`org.slf4j.Logger`	`getLogger()` Method to get the slf4j Logger
`String`	`getTempDirectoryPath()`
`String`	`getUserDirectoryPath()`
`void`	`info(Object object)` Method to log an info message
`List<String>`	`listFiles(String path)` Method to rename a file
`org.json.simple.JSONArray`	`loadJSONArray(String path)` Method to load a file's content as a JSONArray
`org.json.simple.JSONObject`	`loadJSONObject(String path)` Method to load a file's content as a JSONObject
`Properties`	`loadProperties(String path)` Method to create a directory, creating any necassary parent directories
`void`	`mergeConfiguration(Properties properties)` Method to merge Properties into the current configuration Properties
`void`	`moveDirectory(String srcDir, String destDir)`
`void`	`moveDirectoryToDirectory(String src, String destDir, boolean createDestDir)`
`void`	`moveFile(String srcFile, String destFile)`
`void`	`moveFileToDirectory(String srcFile, String destDir, boolean createDestDir)`
`void`	`moveToDirectory(String src, String destDir, boolean createDestDir)`
`String`	`noExtension(String filename)` Method to get a filename without extension
`String`	`noPath(String path)` Method to a filename from an absolute path
`org.json.simple.JSONArray`	`parseJSONArray(String json)` Method to parse a String as a JSONArray
`org.json.simple.JSONObject`	`parseJSONObject(String json)` Method to parse a String as a JSONObject
`String`	`pwd()` Method to get the current working directory
`byte[]`	`readFileToByteArray(String file)`
`String`	`readFileToString(String file)`
`String`	`readFileToString(String file, Charset encoding)`
`List<String>`	`recursivelyListFiles(String path)` Method to recursive list all children, grandchildren, etc.
`void`	`replaceProperties(Properties properties, String path)` Method to replace Properties in a file
`void`	`replaceProperties(Properties properties, String inputFilePath, String outFilePath)` Method to replace Properties in a file
`String`	`replaceProperties(String content)` Method to replace Properties in a String
`void`	`setConfiguration(Properties properties)` Method to set configuration Properties
`void`	`setConfiguration(String key, String value)` Method to set a configuration key / value
`long`	`sizeOf(File file)`
`long`	`sizeOfDirectory(String directory)`
`String[]`	`stringToArray(String string)` Method to convert a string with CRLF to a list
`List<String>`	`stringToList(String string)` Method to convert a string with CRLF to a list
`void`	`touch(String file)`
`void`	`trace(Object object)` Method to log a trace message
`int`	`type(String path)` Method to get the "type" of a file
`String`	`typeString(String path)` Method to get the "type" of a file as a String
`void`	`unzip(String zipFilename, String destinationPath)` Method to unzip a file into a directory
`void`	`unzip(String zipFilename, String destinationPath, boolean overwrite)` Method to unzip a file into a directory
`void`	`warn(Object object)` Method to log a warning warning
`void`	`writeByteArrayToFile(String file, byte[] data)`
`void`	`writeByteArrayToFile(String file, byte[] data, boolean append)`
`void`	`writeStringToFile(String file, String data)`
`void`	`writeStringToFile(String file, String data, Charset encoding)`
`void`	`zip(String sourcePath, String zipFilename)` Method to zip a directory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- CONFIGURATION_LOGGER_MUTE
```
public static final String CONFIGURATION_LOGGER_MUTE
```
- CONFIGURATION_EXECUTE_SHOW_CONTENT
```
public static final String CONFIGURATION_EXECUTE_SHOW_CONTENT
```
- SYSTEMD_SERVICE_ROOT
```
public static final String SYSTEMD_SERVICE_ROOT
```
  Systemd root path for service files
  
  See Also:
  
  Constant Field Values
- CP
```
public static final String CP
```
  Common system executables
  
  See Also:
  
  Constant Field Values
- FIND
```
public static final String FIND
```
  See Also:
  
  Constant Field Values
- GREP
```
public static final String GREP
```
  See Also:
  
  Constant Field Values
- GZIP
```
public static final String GZIP
```
  See Also:
  
  Constant Field Values
- KILL
```
public static final String KILL
```
  See Also:
  
  Constant Field Values
- LS
```
public static final String LS
```
  See Also:
  
  Constant Field Values
- MKDIR
```
public static final String MKDIR
```
  See Also:
  
  Constant Field Values
- PS
```
public static final String PS
```
  See Also:
  
  Constant Field Values
- RM
```
public static final String RM
```
  See Also:
  
  Constant Field Values
- TAR
```
public static final String TAR
```
  See Also:
  
  Constant Field Values
- UNZIP
```
public static final String UNZIP
```
  See Also:
  
  Constant Field Values
- ZIP
```
public static final String ZIP
```
  See Also:
  
  Constant Field Values
- SYSTEMCTL
```
public static final String SYSTEMCTL
```
  Systemdctl executable
  
  See Also:
  
  Constant Field Values
- EXIT_CODE
```
protected static int EXIT_CODE
```
  Exit code of the last executable execution
- NOT_FOUND
```
public static final int NOT_FOUND
```
  File types
  
  See Also:
  
  Constant Field Values
- DIRECTORY
```
public static final int DIRECTORY
```
  See Also:
  
  Constant Field Values
- FILE
```
public static final int FILE
```
  See Also:
  
  Constant Field Values
- currentWorkingDirectory
```
protected File currentWorkingDirectory
```
  Track the current working directory
- properties
```
protected Properties properties
```
  Configuration

Constructor Detail
- Toolset
```
public Toolset()
```
  Constructor

Method Detail

setConfiguration

public void setConfiguration(String key,
                             String value)

Method to set a configuration key / value

Parameters:: key -; value -

setConfiguration
```
public void setConfiguration(Properties properties)
```
Method to set configuration Properties

Parameters:

properties -

mergeConfiguration
```
public void mergeConfiguration(Properties properties)
```
Method to merge Properties into the current configuration Properties

Parameters:

properties -

getConfiguration

public String getConfiguration(String key,
                               String defaultValue)

Method to get a configuration value based on key

Parameters:: key -; defaultValue -
Returns:: String

stringToList
```
public List<String> stringToList(String string)
```
Method to convert a string with CRLF to a list

Parameters:

string -

Returns:

List

stringToArray
```
public String[] stringToArray(String string)
```
Method to convert a string with CRLF to a list

Parameters:

string -

Returns:

String []

noExtension
```
public String noExtension(String filename)
```
Method to get a filename without extension

Parameters:

filename -

Returns:

String

noPath
```
public String noPath(String path)
```
Method to a filename from an absolute path

Parameters:

path -

Returns:

String

getLogger
```
public org.slf4j.Logger getLogger()
```
Method to get the slf4j Logger

Returns:

debug
```
public void debug(Object object)
```
Method to log a debug message

Parameters:

object -

trace
```
public void trace(Object object)
```
Method to log a trace message

Parameters:

object -

info
```
public void info(Object object)
```
Method to log an info message

Parameters:

object -

warn
```
public void warn(Object object)
```
Method to log a warning warning

Parameters:

object -

error
```
public void error(Object object)
```
Method to log an error error message

Parameters:

object -

changeDirectory
```
public void changeDirectory(String path)
```
Method to change the current working directory

Parameters:

path -

pwd
```
public String pwd()
```
Method to get the current working directory

Returns:

String

absolutePath
```
public String absolutePath(String path)
```
Method to get an absolute path

Parameters:

path -

Returns:

String

absolutePath
```
public String absolutePath(File file)
```
Method to get an absolute path

Parameters:

file -

Returns:

String

absoluteFile
```
public File absoluteFile()
```
Method to get an absolute File in the current working directory

Returns:

File

absoluteFile
```
public File absoluteFile(String path)
```
Method to get an absolute File

Parameters:

path -

Returns:

File

arguments
```
public String[] arguments(String... arguments)
```
Method to convert a variable argument list into a an array

Parameters:

arguments -

Returns:

String []

arguments

public String[] arguments(List<String> argumentList)

loadProperties
```
public Properties loadProperties(String path)
```
Method to create a directory, creating any necassary parent directories

Parameters:

path -

exists
```
public boolean exists(String path)
```
Method to determine if a file exists

Parameters:

path -

Returns:

boolean

type
```
public int type(String path)
```
Method to get the "type" of a file

Parameters:

path -

Returns:

int

typeString
```
public String typeString(String path)
```
Method to get the "type" of a file as a String

Parameters:

path -

Returns:

String

listFiles
```
public List<String> listFiles(String path)
```
Method to rename a file

Parameters:

oldPath -

newPath -

recursivelyListFiles
```
public List<String> recursivelyListFiles(String path)
```
Method to recursive list all children, grandchildren, etc.

Parameters:

path -

Returns:

List

replaceProperties
```
public String replaceProperties(String content)
```
Method to replace Properties in a String

Parameters:

content -

Returns:

String

replaceProperties

public void replaceProperties(Properties properties,
                              String path)

Method to replace Properties in a file

Parameters:: properties -; path -

replaceProperties

public void replaceProperties(Properties properties,
                              String inputFilePath,
                              String outFilePath)

Method to replace Properties in a file

Parameters:: properties -; inputFilePath -; infoFilePath -

parseJSONObject
```
public org.json.simple.JSONObject parseJSONObject(String json)
```
Method to parse a String as a JSONObject

Parameters:

json -

Returns:

JSONOBject

loadJSONObject
```
public org.json.simple.JSONObject loadJSONObject(String path)
```
Method to load a file's content as a JSONObject

Parameters:

path -

Returns:

JSONObject

parseJSONArray
```
public org.json.simple.JSONArray parseJSONArray(String json)
```
Method to parse a String as a JSONArray

Parameters:

json -

Returns:

JSONArray

loadJSONArray
```
public org.json.simple.JSONArray loadJSONArray(String path)
```
Method to load a file's content as a JSONArray

Parameters:

path -

Returns:

JSONArray

execute

public ExecutionResult execute(String executable,
                               String[] arguments)

Method to execute an executable

Parameters:: executable -; arguments -
Returns:: ExecutionResult

execute

public ExecutionResult execute(String executable,
                               String[] arguments,
                               int expectedExitCode)

Method to execute an executable

Parameters:: executable -; arguments -; expectedExitCode -
Returns:: ExecutionResult

exitCode
```
public int exitCode()
```
Method to get the exit code of the last execute command

Returns:

int

checkExitCode
```
public void checkExitCode(int expectedExitCode)
```
Method to check the exit code of the last execute command

Parameters:

expectedExitCode -

zip

public void zip(String sourcePath,
                String zipFilename)

Method to zip a directory

Parameters:: sourcePath -; zipFilename -

unzip

public void unzip(String zipFilename,
                  String destinationPath)

Method to unzip a file into a directory

Parameters:: zipFilename -; destinationPath -

unzip

public void unzip(String zipFilename,
                  String destinationPath,
                  boolean overwrite)

Method to unzip a file into a directory

Parameters:: zipFilename -; destinationPath -; overwrite -

getTempDirectoryPath
```
public String getTempDirectoryPath()
```

getUserDirectoryPath
```
public String getUserDirectoryPath()
```

touch
```
public void touch(String file)
```

copyFile

public void copyFile(String srcFile,
                     String destFile)

copyDirectoryToDirectory

public void copyDirectoryToDirectory(String srcDir,
                                     String destDir)

copyDirectory

public void copyDirectory(String srcDir,
                          String destDir)

deleteDirectory

public void deleteDirectory(String directory)

deleteQuietly

public boolean deleteQuietly(String file)

directoryContains

public boolean directoryContains(String directory,
                                 String child)

cleanDirectory

public void cleanDirectory(String directory)

readFileToString

public String readFileToString(String file)

readFileToString

public String readFileToString(String file,
                               Charset encoding)

readFileToByteArray

public byte[] readFileToByteArray(String file)

writeStringToFile

public void writeStringToFile(String file,
                              String data)

writeStringToFile

public void writeStringToFile(String file,
                              String data,
                              Charset encoding)

writeByteArrayToFile

public void writeByteArrayToFile(String file,
                                 byte[] data)

writeByteArrayToFile

public void writeByteArrayToFile(String file,
                                 byte[] data,
                                 boolean append)

forceDelete
```
public void forceDelete(String file)
```

forceMkdir

public void forceMkdir(String directory)

forceMkdirParent

public void forceMkdirParent(String file)

sizeOf
```
public long sizeOf(File file)
```

sizeOfDirectory

public long sizeOfDirectory(String directory)

checksumCRC32

public long checksumCRC32(String file)

moveDirectory

public void moveDirectory(String srcDir,
                          String destDir)

moveDirectoryToDirectory

public void moveDirectoryToDirectory(String src,
                                     String destDir,
                                     boolean createDestDir)

moveFile

public void moveFile(String srcFile,
                     String destFile)

moveFileToDirectory

public void moveFileToDirectory(String srcFile,
                                String destDir,
                                boolean createDestDir)

moveToDirectory

public void moveToDirectory(String src,
                            String destDir,
                            boolean createDestDir)

Class Toolset

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIGURATION_LOGGER_MUTE

CONFIGURATION_EXECUTE_SHOW_CONTENT

SYSTEMD_SERVICE_ROOT

CP

FIND

GREP

GZIP

KILL

LS

MKDIR

PS

RM

TAR

UNZIP

ZIP

SYSTEMCTL

EXIT_CODE

NOT_FOUND

DIRECTORY

FILE

currentWorkingDirectory

properties

Constructor Detail

Toolset

Method Detail

setConfiguration

setConfiguration

mergeConfiguration

getConfiguration

stringToList

stringToArray

noExtension

noPath

getLogger

debug

trace

info

warn

error

changeDirectory

pwd

absolutePath

absolutePath

absoluteFile

absoluteFile

arguments

arguments

loadProperties

exists

type

typeString

listFiles

recursivelyListFiles

replaceProperties

replaceProperties

replaceProperties

parseJSONObject

loadJSONObject

parseJSONArray

loadJSONArray

execute

execute

exitCode

checkExitCode

zip

unzip

unzip

getTempDirectoryPath

getUserDirectoryPath

touch

copyFile

copyDirectoryToDirectory

copyDirectory

deleteDirectory