SetupUtils (OpenDJ 3.0.0 Documentation)

java.lang.Object
- org.opends.server.util.SetupUtils

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public class SetupUtils
extends Object

This class provides a number of utility methods that may be used during the graphical or command-line setup process.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BUILD_ID` Build ID.
`static String`	`BUILD_JAVA_VENDOR` The java vendor of the JVM used to build.
`static String`	`BUILD_JAVA_VERSION` The java version used to generate the build.
`static String`	`BUILD_JVM_VENDOR` The vendor of the JVM used to create the build.
`static String`	`BUILD_JVM_VERSION` The version of the JVM used to create the build.
`static String`	`BUILD_NUMBER` The build number.
`static String`	`BUILD_OS` The OS used during the build.
`static String`	`BUILD_USER` The user that generated the build.
`static String`	`DEBUG_BUILD` Debug build identifier.
`static String`	`FIX_IDS` Fix IDs associated with the build.
`static String`	`HOST_NAME_FILE` The relative path where the setup stores the name of the host the user provides.
`static String`	`INCOMPATIBILITY_EVENTS` Incompatibilities found between builds (used by the upgrade tool).
`static String`	`LAZY_JAR_URLS` Java property used to know which are the jar files that must be downloaded lazily.
`static String`	`LIBRARIES_PATH_RELATIVE` The relative path where all the libraries (jar files) are.
`static String`	`MAJOR_VERSION` Major version.
`static String`	`MINOR_VERSION` Minor version.
`static String`	`NAME` Product name.
`static String`	`OPENDJ_JAVA_ARGS` Specific environment variable used by the scripts to set java arguments.
`static String`	`OPENDJ_JAVA_HOME` Specific environment variable used by the scripts to find java.
`static String`	`POINT_VERSION` Point version of the product.
`static String`	`REVISION` Revision in VCS.
`static String`	`URL_REPOSITORY` The VCS url repository.
`static String`	`VERSION_QUALIFIER` The version qualifier.
`static String`	`ZIP_FILE_NAME` Java property used to know which is the name of the zip file that must be unzipped and whose contents must be extracted during the Web Start based setup.

Constructor Summary

Constructors
Constructor and Description

SetupUtils()

Constructors
Constructor and Description
`SetupUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`canUseAsPort(int port)` Returns `true` if the provided port is free and we can use it, `false` otherwise.
`static boolean`	`canUseAsPort(String hostname, int port)` Returns `true` if the provided port is free and we can use it, `false` otherwise.
`static char[]`	`createSelfSignedCertificatePwd()` Returns a randomly generated password for a self-signed certificate keystore.
`static File`	`createTemplateFile(Set<String> baseDNs, int numEntries)` Creates a MakeLDIF template file using the provided information.
`static File`	`createTemplateFile(String baseDN, int numEntries)` Creates a MakeLDIF template file using the provided information.
`static void`	`exportCertificate(CertificateManager certManager, String alias, String path)` Export a certificate in a file.
`static String`	`getHostNameForCertificate(String installationRoot)` Returns the host name to be used to create self-signed certificates.
`static String`	`getScriptPath(String script)` Returns the String that can be used to launch an script using Runtime.exec.
`static boolean`	`isPrivilegedPort(int port)` Returns `true` if the provided port is a privileged port, `false` otherwise.

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

- Field Detail
  - OPENDJ_JAVA_HOME
```
public static final String OPENDJ_JAVA_HOME
```
    Specific environment variable used by the scripts to find java.
    
    See Also:
    Constant Field Values
  - OPENDJ_JAVA_ARGS
```
public static final String OPENDJ_JAVA_ARGS
```
    Specific environment variable used by the scripts to set java arguments.
    
    See Also:
    Constant Field Values
  - LAZY_JAR_URLS
```
public static final String LAZY_JAR_URLS
```
    Java property used to know which are the jar files that must be downloaded lazily. The current code in WebStartDownloader that uses this property assumes that the URL are separated with an space.
    
    See Also:
    Constant Field Values
  - ZIP_FILE_NAME
```
public static final String ZIP_FILE_NAME
```
    Java property used to know which is the name of the zip file that must be unzipped and whose contents must be extracted during the Web Start based setup.
    
    See Also:
    Constant Field Values
  - LIBRARIES_PATH_RELATIVE
```
public static final String LIBRARIES_PATH_RELATIVE
```
    The relative path where all the libraries (jar files) are.
    
    See Also:
    Constant Field Values
  - HOST_NAME_FILE
```
public static final String HOST_NAME_FILE
```
    The relative path where the setup stores the name of the host the user provides. This is used for instance to generate the self-signed admin certificate the first time the server starts.
  - NAME
```
public static final String NAME
```
    Product name.
    
    See Also:
    Constant Field Values
  - BUILD_ID
```
public static final String BUILD_ID
```
    Build ID.
    
    See Also:
    Constant Field Values
  - MAJOR_VERSION
```
public static final String MAJOR_VERSION
```
    Major version.
    
    See Also:
    Constant Field Values
  - MINOR_VERSION
```
public static final String MINOR_VERSION
```
    Minor version.
    
    See Also:
    Constant Field Values
  - POINT_VERSION
```
public static final String POINT_VERSION
```
    Point version of the product.
    
    See Also:
    Constant Field Values
  - REVISION
```
public static final String REVISION
```
    Revision in VCS.
    
    See Also:
    Constant Field Values
  - URL_REPOSITORY
```
public static final String URL_REPOSITORY
```
    The VCS url repository.
    
    See Also:
    Constant Field Values
  - VERSION_QUALIFIER
```
public static final String VERSION_QUALIFIER
```
    The version qualifier.
    
    See Also:
    Constant Field Values
  - INCOMPATIBILITY_EVENTS
```
public static final String INCOMPATIBILITY_EVENTS
```
    Incompatibilities found between builds (used by the upgrade tool).
    
    See Also:
    Constant Field Values
  - FIX_IDS
```
public static final String FIX_IDS
```
    Fix IDs associated with the build.
    
    See Also:
    Constant Field Values
  - DEBUG_BUILD
```
public static final String DEBUG_BUILD
```
    Debug build identifier.
    
    See Also:
    Constant Field Values
  - BUILD_OS
```
public static final String BUILD_OS
```
    The OS used during the build.
    
    See Also:
    Constant Field Values
  - BUILD_USER
```
public static final String BUILD_USER
```
    The user that generated the build.
    
    See Also:
    Constant Field Values
  - BUILD_JAVA_VERSION
```
public static final String BUILD_JAVA_VERSION
```
    The java version used to generate the build.
    
    See Also:
    Constant Field Values
  - BUILD_JAVA_VENDOR
```
public static final String BUILD_JAVA_VENDOR
```
    The java vendor of the JVM used to build.
    
    See Also:
    Constant Field Values
  - BUILD_JVM_VERSION
```
public static final String BUILD_JVM_VERSION
```
    The version of the JVM used to create the build.
    
    See Also:
    Constant Field Values
  - BUILD_JVM_VENDOR
```
public static final String BUILD_JVM_VENDOR
```
    The vendor of the JVM used to create the build.
    
    See Also:
    Constant Field Values
  - BUILD_NUMBER
```
public static final String BUILD_NUMBER
```
    The build number.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SetupUtils
```
public SetupUtils()
```
- Method Detail
  - createTemplateFile
```
public static File createTemplateFile(String baseDN,
                      int numEntries)
                               throws IOException
```
    Creates a MakeLDIF template file using the provided information.
    
    Parameters:
    baseDN - The base DN for the data in the template file.
    numEntries - The number of user entries the template file should create.
    
    Returns:
    The File object that references the created template file.
    
    Throws:
    
    IOException - If a problem occurs while writing the template file.
  - createTemplateFile
```
public static File createTemplateFile(Set<String> baseDNs,
                      int numEntries)
                               throws IOException
```
    Creates a MakeLDIF template file using the provided information.
    
    Parameters:
    baseDNs - The base DNs for the data in the template file.
    numEntries - The number of user entries the template file should create.
    
    Returns:
    The File object that references the created template file.
    
    Throws:
    
    IOException - If a problem occurs while writing the template file.
  - canUseAsPort
```
public static boolean canUseAsPort(String hostname,
                   int port)
```
    Returns true if the provided port is free and we can use it, false otherwise.
    
    Parameters:
    hostname - the host name we are analyzing. Use null to connect to any address.
    port - the port we are analyzing.
    
    Returns:
    true if the provided port is free and we can use it, false otherwise.
  - canUseAsPort
```
public static boolean canUseAsPort(int port)
```
    Returns true if the provided port is free and we can use it, false otherwise.
    
    Parameters:
    port - the port we are analyzing.
    
    Returns:
    true if the provided port is free and we can use it, false otherwise.
  - isPrivilegedPort
```
public static boolean isPrivilegedPort(int port)
```
    Returns true if the provided port is a privileged port, false otherwise.
    
    Parameters:
    port - the port we are analyzing.
    
    Returns:
    true if the provided port is a privileged port, false otherwise.
  - getScriptPath
```
public static String getScriptPath(String script)
```
    Returns the String that can be used to launch an script using Runtime.exec. This method is required because in Windows the script that contain a "=" in their path must be quoted.
    
    Parameters:
    script - the script name
    
    Returns:
    the absolute path for the given parentPath and relativePath.
  - createSelfSignedCertificatePwd
```
public static char[] createSelfSignedCertificatePwd()
```
    Returns a randomly generated password for a self-signed certificate keystore.
    
    Returns:
    a randomly generated password for a self-signed certificate keystore.
  - exportCertificate
```
public static void exportCertificate(CertificateManager certManager,
                     String alias,
                     String path)
                              throws CertificateEncodingException,
                                     IOException,
                                     KeyStoreException
```
    Export a certificate in a file. If the certificate alias to export is null, It will export the first certificate defined.
    
    Parameters:
    certManager - Certificate manager to use.
    alias - Certificate alias to export. If null the first certificate defined will be exported.
    path - Path of the output file.
    
    Throws:
    
    CertificateEncodingException - If the certificate manager cannot encode the certificate.
    
    IOException - If a problem occurs while creating or writing in the output file.
    
    KeyStoreException - If the certificate manager cannot retrieve the certificate to be exported.
  - getHostNameForCertificate
```
public static String getHostNameForCertificate(String installationRoot)
                                        throws UnknownHostException
```
    Returns the host name to be used to create self-signed certificates.
    The method will first try to read the host name file written by the setup where the user provided the host name where OpenDJ has been installed. If the file cannot be read, the class InetAddress is used.
    
    Parameters:
    installationRoot - the path where the server is installed.
    
    Returns:
    the host name to be used to create self-signed certificates.
    
    Throws:
    
    UnknownHostException - if a host name could not be used.

Class SetupUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPENDJ_JAVA_HOME

OPENDJ_JAVA_ARGS

LAZY_JAR_URLS

ZIP_FILE_NAME

LIBRARIES_PATH_RELATIVE

HOST_NAME_FILE

NAME

BUILD_ID

MAJOR_VERSION

MINOR_VERSION

POINT_VERSION

REVISION

URL_REPOSITORY

VERSION_QUALIFIER

INCOMPATIBILITY_EVENTS

FIX_IDS

DEBUG_BUILD

BUILD_OS

BUILD_USER

BUILD_JAVA_VERSION

BUILD_JAVA_VENDOR

BUILD_JVM_VERSION

BUILD_JVM_VENDOR

BUILD_NUMBER

Constructor Detail

SetupUtils

Method Detail

createTemplateFile

createTemplateFile

canUseAsPort

canUseAsPort

isPrivilegedPort

getScriptPath

createSelfSignedCertificatePwd

exportCertificate

getHostNameForCertificate