ifs.fnd.service

Class IfsConfigDirectory

java.lang.Object

ifs.fnd.service.IfsConfigDirectory

public final class IfsConfigDirectory
extends java.lang.Object

Utility class that gives I/O-access to IFS configuration directory. The location of this directory is defined by the system property fndext.configDir or by two system properties: fndext.home and fndext.instance in the following way.

    ${fndext.home}/instance/${fndext.instance}/conf
 

Methods in this class throw IOExecptions, which are not reported to IFS Logging framework (this class does not depend on ifs.fnd.log package).

See Also:

IfsConstants.IFS_CONFIG_DIR, IfsConstants.IFS_HOME, IfsConstants.IFS_INSTANCE

Method Summary

Modifier and Type	Method and Description
static boolean	fileExists(java.lang.String fileName) Checks if a file exists in the IFS configuration directory.
static java.io.File	getDirectory() Gets IFS configuration directory.
static boolean	isDefined() Checks if the IFS configuration directory is defined.
static java.io.InputStream	openInputStream(java.lang.String fileName) Opens a configuration file located in the IFS configuration directory.
static java.io.Reader	openReader(java.lang.String fileName) Opens a configuration file located in the IFS configuration directory.

Methods inherited from class java.lang.Object

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

Method Detail

isDefined

public static boolean isDefined()

Checks if the IFS configuration directory is defined.

Returns:

true if the system property fndext.configDir or the system properties fndext.home and fndext.instance point to an existing directory, false otherwise

See Also:

getDirectory()

fileExists

public static boolean fileExists(java.lang.String fileName)

Checks if a file exists in the IFS configuration directory.

Parameters:

fileName - the name of the file to check

Returns:

true if the IFS configuration directory is defined and the specified file exists, false otherwise

getDirectory

public static java.io.File getDirectory()
                                 throws java.io.FileNotFoundException

Gets IFS configuration directory. The location of this directory is defined by the system property fndext.configDir or the system properties fndext.home and fndext.instance.

Returns:

an instance of File encapsulating the configuration directory

Throws:

java.io.FileNotFoundException - if IFS configuration directory is not defined, which may depend on missing or invalid system properties fndext.configDir or fndext.home and fndext.instance

See Also:

isDefined()

openInputStream

public static java.io.InputStream openInputStream(java.lang.String fileName)
                                           throws java.io.IOException

Opens a configuration file located in the IFS configuration directory.

Parameters:

fileName - the name of the configuration file (without path information)

Returns:

an open stream for reading bytes from the configuration file

Throws:

java.io.IOException - if the IFS configuration directory is not defined or an I/O error occurs

openReader

public static java.io.Reader openReader(java.lang.String fileName)
                                 throws java.io.IOException

Opens a configuration file located in the IFS configuration directory.

Parameters:

fileName - the name of the configuration file (without path information)

Returns:

an open reader for reading UTF-8 characters from the configuration file

Throws:

java.io.IOException - if the IFS configuration directory is not defined or an I/O error occurs