Package org.eclipse.rdf4j.common.app
Class AppConfiguration
java.lang.Object
org.eclipse.rdf4j.common.app.AppConfiguration
- All Implemented Interfaces:
Configuration
- Author:
- Herko ter Horst
-
Field Summary
Fields inherited from interface org.eclipse.rdf4j.common.app.config.Configuration
DEFAULT_RESOURCES_LOCATION, DIR, RESOURCES_LOCATION -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new, uninitialized application configuration.AppConfiguration(String applicationId) Create the application configuration.AppConfiguration(String applicationId, String longName) Create the application configuration.AppConfiguration(String applicationId, String longName, AppVersion version) Create the application configuration.AppConfiguration(String applicationId, AppVersion version) Create the application configuration. -
Method Summary
Modifier and TypeMethodDescriptionvoiddestroy()Clean up configuration resources.Get the name of the application (e.g.String[]Get the command line arguments of the application.Get the data directory as FileGet the full name of the application, which consists of the long name and the version number.Get logging configurationGet the long name of the application.Get the propertiesGet proxy settingsGet the version of the application.voidinit()Initialize the configuration settings.voidinit(boolean loadLogConfig) Initialize configuration and proxy settings, optionally load (logback) loggingvoidload()Load the configuration settings.voidsave()Store configuration settings.final voidsetApplicationId(String applicationId) Set the application ID stringvoidsetCommandLineArgs(String[] args) Set the command line arguments specified to the application.voidsetDataDirName(String dataDirName) Set the name of the data directoryfinal voidsetLongName(String longName) Set the long name of the application.voidsetProxySettings(ProxySettings proxySettings) Set proxy settingsfinal voidsetVersion(AppVersion version) Set the version of the application.
-
Constructor Details
-
AppConfiguration
public AppConfiguration()Create a new, uninitialized application configuration. -
AppConfiguration
Create the application configuration.- Parameters:
applicationId- the ID of the application
-
AppConfiguration
Create the application configuration.- Parameters:
applicationId- the ID of the applicationversion- the application's version
-
AppConfiguration
Create the application configuration.- Parameters:
applicationId- the ID of the applicationlongName- the long name of the application
-
AppConfiguration
Create the application configuration.- Parameters:
applicationId- the ID of the applicationlongName- the long name of the applicationversion- the application's version
-
-
Method Details
-
load
Description copied from interface:ConfigurationLoad the configuration settings. Settings will be loaded from a user and application specific location first. If no such settings exists, an attempt will be made to retrieve settings from a resource on the classpath. If no such settings exist either, settings will be loaded from a default resource on the classpath.- Specified by:
loadin interfaceConfiguration- Throws:
IOException- if the configuration settings could not be loaded due to an I/O problem.
-
save
Description copied from interface:ConfigurationStore configuration settings. Settings will be stored in a user and application specific location.- Specified by:
savein interfaceConfiguration- Throws:
IOException- if the configuration settings could not be saved due to an I/O problem.
-
init
Description copied from interface:ConfigurationInitialize the configuration settings.- Specified by:
initin interfaceConfiguration- Throws:
IOException- if the configuration settings could not be initialized because of an I/O problem.
-
init
Initialize configuration and proxy settings, optionally load (logback) logging- Parameters:
loadLogConfig- load logging configuration- Throws:
IOException
-
destroy
Description copied from interface:ConfigurationClean up configuration resources.- Specified by:
destroyin interfaceConfiguration- Throws:
IOException- if one or more resources could not be cleaned up. Implementations should attempt to clean up as many resources as possible before returning or throwing an exception.
-
getApplicationId
Get the name of the application (e.g. "AutoFocus" or "Metadata Server").- Returns:
- the name of the application
-
setApplicationId
Set the application ID string- Parameters:
applicationId- string
-
setDataDirName
Set the name of the data directory- Parameters:
dataDirName-
-
getLongName
Get the long name of the application.- Returns:
- the long name of the application
-
setLongName
Set the long name of the application.- Parameters:
longName- the new name
-
getFullName
Get the full name of the application, which consists of the long name and the version number.- Returns:
- the full name of the application
-
getVersion
Get the version of the application.- Returns:
- the version of the application
-
setVersion
Set the version of the application.- Parameters:
version- the new version
-
getCommandLineArgs
Get the command line arguments of the application.- Returns:
- A String array, as (typically) specified to the main method.
-
setCommandLineArgs
Set the command line arguments specified to the application.- Parameters:
args- A String array containing the arguments as specified to the main method.
-
getDataDir
Get the data directory as File- Returns:
- data directory
-
getLogConfiguration
Get logging configuration- Returns:
- log configuration
-
getProxySettings
Get proxy settings- Returns:
- proxy settings
-
setProxySettings
Set proxy settings- Parameters:
proxySettings- proxy settings
-
getProperties
Get the properties- Returns:
- Returns the properties.
-