CoreConstants (Asakusa Framework 0.10.4 API)

java.lang.Object
- com.asakusafw.windgate.bootstrap.CoreConstants

public final class CoreConstants
extends Object

Constants of Asakusa Framework Core.

Since:: 0.10.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ENV_ASAKUSA_BATCHAPPS_HOME` The environment variable name of batch application installation path.
`static String`	`ENV_ASAKUSA_HOME` The environment variable name of framework installation path.
`static String`	`PATH_APP_JOBFLOW_LIB_FILE_PREFIX` The jobflow package file path prefix (relative from batchapps root).
`static String`	`PATH_APP_JOBFLOW_LIB_FILE_SUFFIX` The jobflow package file path suffix.
`static String`	`PATH_APP_USER_LIB_DIR` The batch shared libraries directory path (relative from batchapps root).
`static String`	`PATH_CORE_CONF_DIR` The framework core configuration directory path (relative from framework root).
`static String`	`PATH_CORE_CONF_FILE` The framework core configuration file path (relative from framework root).
`static String`	`PATH_CORE_LIB_DIR` The framework core libraries directory path (relative from framework root).
`static String`	`PATH_DEFAULT_BATCHAPPS_DIR` The default path of batch application installation path (relative from framework root).
`static String`	`PATH_EXTENSION_LIB_DIR` The framework extension libraries directory path (relative from framework root).
`static String`	`PATH_HADOOP_EMBEDDED_LIB_DIR` The framework embedded Hadoop libraries directory path (relative from framework root).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Path`	`getAppJobflowLibFile(Path application, String flowId)` Returns the jobflow package file.
`static Path`	`getApplication(Environment env, String batchId)` Returns the application base directory.
`static Path`	`getBatchappsHome(Environment env)` Returns the batch application installation directory.
`static Path`	`getHome(Environment env)` Returns the framework installation directory.

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

- Field Detail
  - ENV_ASAKUSA_HOME
```
public static final String ENV_ASAKUSA_HOME
```
    The environment variable name of framework installation path.
    
    See Also:
    
    Constant Field Values
  - ENV_ASAKUSA_BATCHAPPS_HOME
```
public static final String ENV_ASAKUSA_BATCHAPPS_HOME
```
    The environment variable name of batch application installation path.
    
    See Also:
    
    Constant Field Values
  - PATH_DEFAULT_BATCHAPPS_DIR
```
public static final String PATH_DEFAULT_BATCHAPPS_DIR
```
    The default path of batch application installation path (relative from framework root).
    
    See Also:
    
    Constant Field Values
  - PATH_CORE_LIB_DIR
```
public static final String PATH_CORE_LIB_DIR
```
    The framework core libraries directory path (relative from framework root).
    
    See Also:
    
    Constant Field Values
  - PATH_CORE_CONF_DIR
```
public static final String PATH_CORE_CONF_DIR
```
    The framework core configuration directory path (relative from framework root).
    
    See Also:
    
    Constant Field Values
  - PATH_CORE_CONF_FILE
```
public static final String PATH_CORE_CONF_FILE
```
    The framework core configuration file path (relative from framework root).
    
    See Also:
    
    Constant Field Values
  - PATH_HADOOP_EMBEDDED_LIB_DIR
```
public static final String PATH_HADOOP_EMBEDDED_LIB_DIR
```
    The framework embedded Hadoop libraries directory path (relative from framework root).
    
    See Also:
    
    Constant Field Values
  - PATH_EXTENSION_LIB_DIR
```
public static final String PATH_EXTENSION_LIB_DIR
```
    The framework extension libraries directory path (relative from framework root).
    
    See Also:
    
    Constant Field Values
  - PATH_APP_JOBFLOW_LIB_FILE_PREFIX
```
public static final String PATH_APP_JOBFLOW_LIB_FILE_PREFIX
```
    The jobflow package file path prefix (relative from batchapps root).
    
    See Also:
    
    Constant Field Values
  - PATH_APP_JOBFLOW_LIB_FILE_SUFFIX
```
public static final String PATH_APP_JOBFLOW_LIB_FILE_SUFFIX
```
    The jobflow package file path suffix.
    
    See Also:
    
    Constant Field Values
  - PATH_APP_USER_LIB_DIR
```
public static final String PATH_APP_USER_LIB_DIR
```
    The batch shared libraries directory path (relative from batchapps root).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getHome
```
public static Path getHome(Environment env)
```
    Returns the framework installation directory.
    
    Parameters:
    
    env - the current environment variables
    
    Returns:
    
    the target path
  - getBatchappsHome
```
public static Path getBatchappsHome(Environment env)
```
    Returns the batch application installation directory.
    
    Parameters:
    
    env - the current environment variables
    
    Returns:
    
    the target path
  - getApplication
```
public static Path getApplication(Environment env,
                                  String batchId)
```
    Returns the application base directory.
    
    Parameters:
    
    env - the current environment variables
    
    batchId - the batch ID
    
    Returns:
    
    the target path
  - getAppJobflowLibFile
```
public static Path getAppJobflowLibFile(Path application,
                                        String flowId)
```
    Returns the jobflow package file.
    
    Parameters:
    
    application - the application directory
    
    flowId - the target flow ID
    
    Returns:
    
    the target path

Class CoreConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENV_ASAKUSA_HOME

ENV_ASAKUSA_BATCHAPPS_HOME

PATH_DEFAULT_BATCHAPPS_DIR

PATH_CORE_LIB_DIR

PATH_CORE_CONF_DIR

PATH_CORE_CONF_FILE

PATH_HADOOP_EMBEDDED_LIB_DIR

PATH_EXTENSION_LIB_DIR

PATH_APP_JOBFLOW_LIB_FILE_PREFIX

PATH_APP_JOBFLOW_LIB_FILE_SUFFIX

PATH_APP_USER_LIB_DIR

Method Detail

getHome

getBatchappsHome

getApplication

getAppJobflowLibFile