RuntimeParamUtil

java.lang.Object
- biolockj.util.RuntimeParamUtil

```
public class RuntimeParamUtil
extends Object
```
This utility processes the application runtime parameters passed to BioLockJ.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AWS_FLAG` `Config` AWS end parameter switch: "-aws"
`static String`	`BLJ_PROJ_DIR` Automatically added $BLJ_PROJ by biolockj script: "-projectDir"
`static String`	`CONFIG_FILE` `Config` file path runtime parameter switch: "-config"
`static String`	`DEBUG_FLAG` Flag argument; if present, BioLockJ will set the `Conig` property to DEBUG.
`static String`	`DIRECT_MODE` Direct mode runtime parameter switch: "-direct"
`static String`	`DOCKER_FLAG` Flag argument; if present, BioLockJ will use a docker volume map.
`static String`	`DOCKER_MAPPER` Argument giving the name of the class to use for the DockerMountMapper: "-docker-mapper"
`protected static String`	`HOME_DIR` Automatically added $HOME by biolockj/dockblj script: "-homeDir"
`static String`	`PASSWORD` Change password runtime parameter switch: "-password"
`static String`	`PRECHECK_FLAG` Flag argument; if present, BioLockJ will stop after checkDependencies step.
`static String`	`RESTART_DIR` Restart pipeline runtime parameter switch: "-restartDir"
`protected static String`	`SYSTEM_OUT_FLAG` Flag argument; if present, BioLockJ will print to System.out instead of Log for debugging early runtime errors.
`static String`	`UNUSED_PROPS_FLAG` Flag argument; if presetn, BioLockJ will run check dependencies for ALL modules to determine unused properties from the primary config.

Constructor Summary

Constructors
Constructor and Description

RuntimeParamUtil()

Constructors
Constructor and Description
`RuntimeParamUtil()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`doChangePassword()` Return TRUE if runtime parameters indicate change password request
`static boolean`	`doRestart()` Return TRUE if runtime parameters indicate attempt to restart pipeline
`static File`	`get_BLJ_PROJ()` Runtime property getter for "-projectDir"
`static File`	`get_BLJ_PROJ(boolean dockerize)`
`static String`	`getAdminEmailPassword()` Runtime property getter for "-password"
`static File`	`getConfigFile()` Runtime property getter for "-config"
`static File`	`getConfigFile(boolean dockerize)`
`static String`	`getDirectModuleDir()` Runtime property getter for "-direct"
`static File`	`getDirectPipelineDir()` Runtime property getter for direct module pipeline directory
`static String`	`getDockerMapper()`
`static File`	`getFileParam(String paramName, boolean dockerize)` Get a File that is given through a parameter; if in docker, get the in-container form of the path
`static String`	`getJavaModuleArgs(JavaModule module)` For cluster env, runtime params that need be forward to detached cluster Java modules.
`static String`	`getProjectName()` Deprecated. Use `BioLockJ.getProjectName()` instead
`static File`	`getRestartDir()` Return restart pipeline directory
`static File`	`getRestartDir(boolean dockerize)`
`static String`	`getRuntimeArgs()` Return the runtime args as a String.
`static boolean`	`isAwsMode()` Return TRUE if runtime parameter "-aws" was found
`static boolean`	`isInDocker()`
`static boolean`	`isPrecheckAllMode()`
`static boolean`	`isPrecheckMode()`
`static boolean`	`isVerbose()`
`static boolean`	`logToSystemOut()` Return TRUE if runtime parameters indicate Logs should be written to system.out
`static void`	`printArgsDescriptions()` Print arg descriptions TODO: PROBLEMATIC APPROACH TO SHOW ARGS BY PRINTING VARIABLES IN THIS METHOD
`protected static void`	`printRuntimeArgs(String[] args)` Print the runtime args to System.out or using the Logger based on useSysOut parameter.
`static void`	`registerRuntimeParameters(String[] args)` TODO: runtime params should always store the string as given on the command line, and that should be the host-file path, even when running in docker.
`static void`	`validateParams()`

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

- Field Detail
  - AWS_FLAG
```
public static final String AWS_FLAG
```
    Config AWS end parameter switch: "-aws"
    
    See Also:
    
    Constant Field Values
  - BLJ_PROJ_DIR
```
public static final String BLJ_PROJ_DIR
```
    Automatically added $BLJ_PROJ by biolockj script: "-projectDir"
    
    See Also:
    
    Constant Field Values
  - DOCKER_MAPPER
```
public static final String DOCKER_MAPPER
```
    Argument giving the name of the class to use for the DockerMountMapper: "-docker-mapper"
    
    See Also:
    
    Constant Field Values
  - CONFIG_FILE
```
public static final String CONFIG_FILE
```
    Config file path runtime parameter switch: "-config"
    
    See Also:
    
    Constant Field Values
  - DIRECT_MODE
```
public static final String DIRECT_MODE
```
    Direct mode runtime parameter switch: "-direct"
    
    See Also:
    
    Constant Field Values
  - HOME_DIR
```
protected static final String HOME_DIR
```
    Automatically added $HOME by biolockj/dockblj script: "-homeDir"
    
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final String PASSWORD
```
    Change password runtime parameter switch: "-password"
    
    See Also:
    
    Constant Field Values
  - RESTART_DIR
```
public static final String RESTART_DIR
```
    Restart pipeline runtime parameter switch: "-restartDir"
    
    See Also:
    
    Constant Field Values
  - SYSTEM_OUT_FLAG
```
protected static final String SYSTEM_OUT_FLAG
```
    Flag argument; if present, BioLockJ will print to System.out instead of Log for debugging early runtime errors.
    flag: "-systemOut"
    
    See Also:
    
    DEBUG_FLAG, Constant Field Values
  - PRECHECK_FLAG
```
public static final String PRECHECK_FLAG
```
    Flag argument; if present, BioLockJ will stop after checkDependencies step. flag: "-precheck"
    
    See Also:
    
    Constant Field Values
  - DEBUG_FLAG
```
public static final String DEBUG_FLAG
```
    Flag argument; if present, BioLockJ will set the Conig property to DEBUG.
    flag: "-verbose"
    
    See Also:
    
    SYSTEM_OUT_FLAG, Constant Field Values
  - DOCKER_FLAG
```
public static final String DOCKER_FLAG
```
    Flag argument; if present, BioLockJ will use a docker volume map. flag: "-docker"
    
    See Also:
    
    Constant Field Values
  - UNUSED_PROPS_FLAG
```
public static final String UNUSED_PROPS_FLAG
```
    Flag argument; if presetn, BioLockJ will run check dependencies for ALL modules to determine unused properties from the primary config.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RuntimeParamUtil
```
public RuntimeParamUtil()
```
- Method Detail
  - doChangePassword
```
public static boolean doChangePassword()
```
    Return TRUE if runtime parameters indicate change password request
    
    Returns:
    
    boolean
  - getFileParam
```
public static File getFileParam(String paramName,
                                boolean dockerize)
                         throws DockerVolCreationException
```
    Get a File that is given through a parameter; if in docker, get the in-container form of the path
    
    Parameters:
    
    paramName - - String key to use with params
    
    Returns:
    
    Throws:
    
    DockerVolCreationException
    
    InterruptedException
    
    IOException
  - doRestart
```
public static boolean doRestart()
                         throws DockerVolCreationException
```
    Return TRUE if runtime parameters indicate attempt to restart pipeline
    
    Returns:
    
    boolean
    
    Throws:
    
    DockerVolCreationException
  - get_BLJ_PROJ
```
public static File get_BLJ_PROJ()
                         throws DockerVolCreationException
```
    Runtime property getter for "-projectDir"
    
    Returns:
    
    $BLJ_PROJ_DIR pipeline parent directory
    
    Throws:
    
    DockerVolCreationException
  - get_BLJ_PROJ
```
public static File get_BLJ_PROJ(boolean dockerize)
                         throws DockerVolCreationException
```
    Throws:
    
    DockerVolCreationException
  - getAdminEmailPassword
```
public static String getAdminEmailPassword()
```
    Runtime property getter for "-password"
    
    Returns:
    
    New clear-text password
  - getConfigFile
```
public static File getConfigFile()
                          throws DockerVolCreationException
```
    Runtime property getter for "-config"
    
    Returns:
    
    Config file
    
    Throws:
    
    DockerVolCreationException
  - getConfigFile
```
public static File getConfigFile(boolean dockerize)
                          throws DockerVolCreationException
```
    Throws:
    
    DockerVolCreationException
  - getDirectModuleDir
```
public static String getDirectModuleDir()
```
    Runtime property getter for "-direct"
    
    Returns:
    
    Direct module BioModule class name
  - getDirectPipelineDir
```
public static File getDirectPipelineDir()
```
    Runtime property getter for direct module pipeline directory
    
    Returns:
    
    Pipeline directory dir
  - getJavaModuleArgs
```
public static String getJavaModuleArgs(JavaModule module)
                                throws DockerVolCreationException
```
    For cluster env, runtime params that need be forward to detached cluster Java modules. For Docker env, return line with BLJ_OPTIONS in Docker java_module scripts.
    
    Parameters:
    
    module - JavaModule
    
    Returns:
    
    java -jar BioLockJ.jar runtime args
    
    Throws:
    
    DockerVolCreationException
  - getProjectName
```
public static String getProjectName()
                             throws Exception
```
    Deprecated. Use BioLockJ.getProjectName() instead
    
    Extract the project name from the Config file.
    
    Returns:
    
    Project name
    
    Throws:
    
    Exception
  - getRestartDir
```
public static File getRestartDir()
                          throws DockerVolCreationException
```
    Return restart pipeline directory
    
    Returns:
    
    File directory path
    
    Throws:
    
    DockerVolCreationException
  - getRestartDir
```
public static File getRestartDir(boolean dockerize)
                          throws DockerVolCreationException
```
    Throws:
    
    DockerVolCreationException
  - getRuntimeArgs
```
public static String getRuntimeArgs()
```
    Return the runtime args as a String.
    
    Returns:
    
    Runtime arg String value
  - isAwsMode
```
public static boolean isAwsMode()
```
    Return TRUE if runtime parameter "-aws" was found
    
    Returns:
    
    boolean
  - isPrecheckMode
```
public static boolean isPrecheckMode()
```
  - isVerbose
```
public static boolean isVerbose()
```
  - isInDocker
```
public static boolean isInDocker()
```
  - isPrecheckAllMode
```
public static boolean isPrecheckAllMode()
```
  - logToSystemOut
```
public static boolean logToSystemOut()
```
    Return TRUE if runtime parameters indicate Logs should be written to system.out
    
    Returns:
    
    boolean
  - printArgsDescriptions
```
public static void printArgsDescriptions()
```
    Print arg descriptions TODO: PROBLEMATIC APPROACH TO SHOW ARGS BY PRINTING VARIABLES IN THIS METHOD
  - registerRuntimeParameters
```
public static void registerRuntimeParameters(String[] args)
                                      throws RuntimeParamException,
                                             DockerVolCreationException
```
    TODO: runtime params should always store the string as given on the command line, and that should be the host-file path, even when running in docker. Register and verify the runtime parameters. There are 2 required parameters:
    1. The Config file path
    2. The pipeline parent directory ($DOCKER_PROJ)
    Parameters:
    
    args - Program runtime parameters
    
    Throws:
    
    RuntimeParamException - if invalid parameters found
    
    DockerVolCreationException
  - printRuntimeArgs
```
protected static void printRuntimeArgs(String[] args)
```
    Print the runtime args to System.out or using the Logger based on useSysOut parameter.
    
    Parameters:
    
    args - Runtime Args
  - validateParams
```
public static void validateParams()
                           throws RuntimeParamException,
                                  DockerVolCreationException
```
    Throws:
    
    RuntimeParamException
    
    DockerVolCreationException
  - getDockerMapper
```
public static String getDockerMapper()
```

Class RuntimeParamUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AWS_FLAG

BLJ_PROJ_DIR

DOCKER_MAPPER

CONFIG_FILE

DIRECT_MODE

HOME_DIR

PASSWORD

RESTART_DIR

SYSTEM_OUT_FLAG

PRECHECK_FLAG

DEBUG_FLAG

DOCKER_FLAG

UNUSED_PROPS_FLAG

Constructor Detail

RuntimeParamUtil

Method Detail

doChangePassword

getFileParam

doRestart

get_BLJ_PROJ

get_BLJ_PROJ

getAdminEmailPassword

getConfigFile

getConfigFile

getDirectModuleDir

getDirectPipelineDir

getJavaModuleArgs

getProjectName

getRestartDir

getRestartDir

getRuntimeArgs

isAwsMode

isPrecheckMode

isVerbose

isInDocker

isPrecheckAllMode

logToSystemOut

printArgsDescriptions

registerRuntimeParameters

printRuntimeArgs

validateParams

getDockerMapper