org.apache.nifi.util

Class NiFiBootstrapUtils

java.lang.Object

org.apache.nifi.util.NiFiBootstrapUtils

public class NiFiBootstrapUtils
extends Object

Encapsulates utility methods for dealing with bootstrap.conf or nifi.properties.

Field Summary

Fields

Modifier and Type	Field and Description
private static AbstractBootstrapPropertiesLoader	BOOTSTRAP_PROPERTIES_LOADER

Constructor Summary

Constructors

Constructor and Description
NiFiBootstrapUtils()

Method Summary

Modifier and Type	Method and Description
static String	extractKeyFromBootstrapFile() Returns the key (if any) used to encrypt sensitive properties, extracted from $NIFI_HOME/conf/bootstrap.conf.
static String	extractKeyFromBootstrapFile(String bootstrapPath) Returns the key (if any) used to encrypt sensitive properties, extracted from $NIFI_HOME/conf/bootstrap.conf.
static String	getDefaultApplicationPropertiesFilePath() Returns the default file path to $NIFI_HOME/conf/nifi.properties.
static BootstrapProperties	loadBootstrapProperties() Loads the default bootstrap.conf file into a BootstrapProperties object.
static BootstrapProperties	loadBootstrapProperties(String bootstrapPath) Loads the bootstrap.conf file into a BootstrapProperties object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BOOTSTRAP_PROPERTIES_LOADER

private static final AbstractBootstrapPropertiesLoader BOOTSTRAP_PROPERTIES_LOADER

Constructor Detail

NiFiBootstrapUtils

public NiFiBootstrapUtils()

Method Detail

extractKeyFromBootstrapFile

public static String extractKeyFromBootstrapFile()
                                          throws IOException

Returns the key (if any) used to encrypt sensitive properties, extracted from $NIFI_HOME/conf/bootstrap.conf.

Returns:

the key in hexadecimal format

Throws:

IOException - if the file is not readable

loadBootstrapProperties

public static BootstrapProperties loadBootstrapProperties()
                                                   throws IOException

Loads the default bootstrap.conf file into a BootstrapProperties object.

Returns:

The default bootstrap.conf as a BootstrapProperties object

Throws:

IOException - If the file is not readable

loadBootstrapProperties

public static BootstrapProperties loadBootstrapProperties(String bootstrapPath)
                                                   throws IOException

Loads the bootstrap.conf file into a BootstrapProperties object.

Parameters:

bootstrapPath - the path to the bootstrap file

Returns:

The bootstrap.conf as a BootstrapProperties object

Throws:

IOException - If the file is not readable

extractKeyFromBootstrapFile

public static String extractKeyFromBootstrapFile(String bootstrapPath)
                                          throws IOException

Returns the key (if any) used to encrypt sensitive properties, extracted from $NIFI_HOME/conf/bootstrap.conf.

Parameters:

bootstrapPath - the path to the bootstrap file (if null, returns the sensitive key found in $NIFI_HOME/conf/bootstrap.conf)

Returns:

the key in hexadecimal format

Throws:

IOException - if the file is not readable

getDefaultApplicationPropertiesFilePath

public static String getDefaultApplicationPropertiesFilePath()

Returns the default file path to $NIFI_HOME/conf/nifi.properties. If the system property nifi.properties.file.path is not set, it will be set to the relative conf/nifi.properties

Returns:

the path to the nifi.properties file