org.apache.nifi.properties

Class AbstractBootstrapPropertiesLoader

java.lang.Object

org.apache.nifi.properties.AbstractBootstrapPropertiesLoader

public abstract class AbstractBootstrapPropertiesLoader
extends Object

An abstract base class for an application-specific BootstrapProperties loader.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BOOTSTRAP_CONF
private static org.slf4j.Logger	logger
private static String	RELATIVE_APPLICATION_PROPERTIES_PATTERN

Constructor Summary

Constructors

Constructor and Description
AbstractBootstrapPropertiesLoader()

Method Summary

Modifier and Type	Method and Description
String	extractKeyFromBootstrapFile() Returns the key (if any) used to encrypt sensitive properties, extracted from $APPLICATION_HOME/conf/bootstrap.conf.
String	extractKeyFromBootstrapFile(String bootstrapPath) Returns the key (if any) used to encrypt sensitive properties, extracted from $APPLICATION_HOME/conf/bootstrap.conf.
protected abstract String	getApplicationPrefix() Return the property prefix used in the bootstrap.conf file for this application.
protected abstract String	getApplicationPropertiesFilename() Return the name of the main application properties file (e.g., nifi.properties).
protected abstract String	getApplicationPropertiesFilePathSystemProperty() Return the system property name that should specify the file path of the main application properties file.
private File	getBootstrapFile(String bootstrapPath) Returns the file for bootstrap.conf.
String	getDefaultApplicationPropertiesFilePath() Returns the default file path to $APPLICATION_HOME/conf/$APPLICATION.properties.
static BootstrapProperties	loadBootstrapProperties(Path bootstrapPath, String propertyPrefix) Loads a properties file into a BootstrapProperties object.
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

logger

private static final org.slf4j.Logger logger

RELATIVE_APPLICATION_PROPERTIES_PATTERN

private static final String RELATIVE_APPLICATION_PROPERTIES_PATTERN

See Also:

Constant Field Values

BOOTSTRAP_CONF

private static final String BOOTSTRAP_CONF

See Also:

Constant Field Values

Constructor Detail

AbstractBootstrapPropertiesLoader

public AbstractBootstrapPropertiesLoader()

Method Detail

getApplicationPrefix

protected abstract String getApplicationPrefix()

Return the property prefix used in the bootstrap.conf file for this application.

Returns:

the property prefix

getApplicationPropertiesFilename

protected abstract String getApplicationPropertiesFilename()

Return the name of the main application properties file (e.g., nifi.properties). This will be used to determine the default location of the application properties file.

Returns:

The name of the application properties file

getApplicationPropertiesFilePathSystemProperty

protected abstract String getApplicationPropertiesFilePathSystemProperty()

Return the system property name that should specify the file path of the main application properties file.

Returns:

The system property name that should provide the file path of the main application properties file

extractKeyFromBootstrapFile

public String extractKeyFromBootstrapFile()
                                   throws IOException

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

Returns:

the key in hexadecimal format

Throws:

IOException - if the file is not readable

loadBootstrapProperties

public 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

loadBootstrapProperties

public static BootstrapProperties loadBootstrapProperties(Path bootstrapPath,
                                                          String propertyPrefix)
                                                   throws IOException

Loads a properties file into a BootstrapProperties object.

Parameters:

bootstrapPath - The path to the properties file

propertyPrefix - The property prefix to enforce

Returns:

The BootstrapProperties

Throws:

IOException - If the properties file could not be read

extractKeyFromBootstrapFile

public String extractKeyFromBootstrapFile(String bootstrapPath)
                                   throws IOException

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

Parameters:

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

Returns:

the key in hexadecimal format

Throws:

IOException - if the file is not readable

getBootstrapFile

private File getBootstrapFile(String bootstrapPath)
                       throws IOException

Returns the file for bootstrap.conf.

Parameters:

bootstrapPath - the path to the bootstrap file (defaults to $APPLICATION_HOME/conf/bootstrap.conf if null)

Returns:

the $APPLICATION_HOME/conf/bootstrap.conf file

Throws:

IOException - if the directory containing the file is not readable

getDefaultApplicationPropertiesFilePath

public String getDefaultApplicationPropertiesFilePath()

Returns the default file path to $APPLICATION_HOME/conf/$APPLICATION.properties. If the system property provided by AbstractBootstrapPropertiesLoader#getApplicationPropertiesFilePathSystemProperty() is not set, it will be set to the relative path provided by AbstractBootstrapPropertiesLoader#getRelativeApplicationPropertiesFilePath().

Returns:

the path to the application properties file