public final class Installation extends Object
Modifier and Type | Field and Description |
---|---|
static String |
ACCEPTED_LICENSE_FILE_NAME
The accepted license file name.
|
static String |
ADMIN_BACKEND_FILE_NAME
The admin data LDIF backend file name.
|
static String |
BACKUP_DIR_NAME
Backup directory name.
|
static String |
BUILDINFO_FILE_NAME
The buildinfo file name.
|
static String |
CONFIG_DIR_NAME
Config directory name.
|
static String |
CONFIG_FILE_NAME
The configuration LDIF file name.
|
static String |
DATABASE_DIR_NAME
Server instance database folder.
|
static String |
INSTALL_ROOT_SYSTEM_PROPERTY
The system property used to specify opendj archive root path.
|
static String |
LEGAL_NOTICES_DIR_NAME
The Legal folder which contains license file.
|
static String |
LIB_DIR_NAME
The lib directory name.
|
static String |
LICENSE_FILE_NAME
The license file name.
|
static String |
LOGS_DIR_NAME
Logs directory name.
|
static String |
MAC_JAVA_APP_STUB_NAME_FILE_NAME
The universal Java application stub file name.
|
static String |
MAKE_LDIF_DIR_NAME
MakeLDIF directory name.
|
static String |
SCHEMA_DIR_NAME
The schema directory name.
|
static String |
SETUP_TOOL_NAME
Platform independent name of the setup tool.
|
static String |
START_DS_TOOL_NAME
Platform independent name of the start-ds tool.
|
static String |
STATUS_TOOL_NAME
Platform independent name of the status tool.
|
static String |
TEMPLATE_DIR_NAME
The template directory name.
|
static String |
UNIX_BINARIES_DIR_NAME
UNIX binaries (scripts) directory name.
|
static String |
UPGRADE_TOOL_NAME
Platform independent name of the upgrade tool.
|
static String |
WINDOWS_BINARIES_DIR_NAME
Windows binaries (batch files) directory name.
|
Modifier and Type | Method and Description |
---|---|
static Path |
getInstancePathFromInstallPath(Path installPath)
Returns the
Path of the instance of the server contained in the provided server installation path. |
static String |
getToolName(String toolName)
Returns the provided tool name according to the running operating system.
|
static Path |
getToolPath(Path archivePath,
String toolName)
Returns the provided tool path according to the running operating system and the provided archive path.
|
static Path |
getToolPath(String toolName)
Returns the provided tool path according to the running operating system.
|
static Path |
installPath()
Returns the server's installation path.
|
static Path |
instanceConfigFilePath()
Returns a
Path to the server instance config.ldif file. |
static Path |
instancePath()
Returns the instance root directory (the path where the instance is installed).
|
public static final String BACKUP_DIR_NAME
public static final String WINDOWS_BINARIES_DIR_NAME
public static final String UNIX_BINARIES_DIR_NAME
public static final String CONFIG_DIR_NAME
public static final String DATABASE_DIR_NAME
public static final String LEGAL_NOTICES_DIR_NAME
public static final String LIB_DIR_NAME
public static final String LOGS_DIR_NAME
public static final String MAKE_LDIF_DIR_NAME
public static final String SCHEMA_DIR_NAME
public static final String TEMPLATE_DIR_NAME
public static final String BUILDINFO_FILE_NAME
public static final String CONFIG_FILE_NAME
public static final String ADMIN_BACKEND_FILE_NAME
public static final String LICENSE_FILE_NAME
public static final String ACCEPTED_LICENSE_FILE_NAME
public static final String MAC_JAVA_APP_STUB_NAME_FILE_NAME
public static final String SETUP_TOOL_NAME
public static final String START_DS_TOOL_NAME
public static final String STATUS_TOOL_NAME
public static final String UPGRADE_TOOL_NAME
public static final String INSTALL_ROOT_SYSTEM_PROPERTY
public static Path installPath()
public static Path instancePath()
public static Path instanceConfigFilePath()
Path
to the server instance config.ldif file.Path
to the server instance config.ldif file.public static Path getInstancePathFromInstallPath(Path installPath)
Path
of the instance of the server contained in the provided server installation path.
If the server is not setup, or does not run in split install/instance mode,
then this method returns null
.
installPath
- The installation pathnull
,
if there is no server has been setup from this installation path or if the server has not
been setup in split install/instance mode.public static Path getToolPath(String toolName)
toolName
- The name of the tool to run (without any extension)public static Path getToolPath(Path archivePath, String toolName)
archivePath
- The OpenDJ exploded archive root pathtoolName
- The name of the tool to run (without any extension)Copyright 2010-2020 ForgeRock AS.