ifs.fnd.service

Class IfsProperties

java.lang.Object

ifs.fnd.service.IfsProperties

public final class IfsProperties
extends java.lang.Object

Handling of IFS specific properties. IFS properties are loaded from the file named 'ifs.properties' located in the IFS configuration directory.

If a value of an IFS property is used many times then consider storing its value in a local or static variable, but note that after a call to load() such variables may become invalid.

Methods returning mandatory properties may throw FndProperties.PropertyNotFoundException, which is a RuntimeException. Application code may catch this exception and convert it to an IfsException.

Since:

5.0.0

See Also:

IfsConfigDirectory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FndProperties.PropertyNotFoundException RuntimeException indicating that a specific IFS property has not been found in the configuration file.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ifs.fnd.service.FndProperties	ifsProperties The singleton instance of FndProperties.

Constructor Summary

Constructors

Constructor and Description
IfsProperties()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	forceProperty(java.lang.String name) Gets a mandatory IFS property.
static java.lang.String	getApplicationOwner() Gets database owner of IFS tables, views and packages.
static boolean	getChangePasswordEnabled() Gets boolean property indicating if it is allowed to change account passwords.
static java.lang.String	getCompressionLevel() Gets compression level used by Client, Anonymous and SOAP Gateways for response compression.
static java.lang.String	getConnectionString() Gets the connection string to SOAP Gateway.
static java.lang.String	getConnectPassword() Gets IFS Connect user password.
static java.lang.String	getConnectUser() Gets IFS Connect user.
static java.lang.String	getDbPassword() Gets the database user password for JDBC connections.
static java.lang.String	getDbUser() Gets the database user (IFSSYS) for JDBC connections.
static int	getDefaultFetchSize() Gets the default fetch size used when fetching results from database.
static int	getDefaultStatementExecutionTimeout() Gets the default database statement execution timeout to use for proxy sessions.
static java.lang.String	getFullyQualifiedDomainName() Deprecated.
static java.lang.String	getJdbcDriverClass() Gets the JDBC driver implementation class name.
static java.lang.String	getJdbcUrl() Gets database connection URL for JDBC driver.
static int	getMaxFetchSize() Gets the maximum fetch size used when fetching results from database.
static java.lang.String	getProperty(java.lang.String name) Gets an IFS property.
static boolean	getProperty(java.lang.String name, boolean defaultValue) Gets an optional IFS property.
static int	getProperty(java.lang.String name, int defaultValue) Gets an optional IFS property.
static java.lang.String	getProperty(java.lang.String name, java.lang.String defaultValue) Gets an optional IFS property.
static int	getStatementCacheSize() Gets the size of the statement cache in the JDBC driver.
static java.lang.String	getTeamServer() Gets the Team Server property.
static java.lang.String	getTransformerFactory() Gets the TransformerFactory implementation class name.
protected boolean	isLogInfo()
static void	load() Loads all IFS properties from file 'ifs.properties' located in the IFS configuration directory.
protected void	logError(java.lang.String text)
protected void	logError(java.lang.Throwable t)
protected void	logError(java.lang.Throwable t, java.lang.String text)
protected void	logInfo(java.lang.String text)

Methods inherited from class java.lang.Object

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

Field Detail

ifsProperties

protected static volatile ifs.fnd.service.FndProperties ifsProperties

The singleton instance of FndProperties. Has state UNINITIALIZED until load() or a get() is called.

Constructor Detail

IfsProperties

public IfsProperties()

Method Detail

load

public static void load()

Loads all IFS properties from file 'ifs.properties' located in the IFS configuration directory. A call to this method may change values of some IFS properties, so property values stored in static variables may become invalid.

See Also:

IfsConfigDirectory

getChangePasswordEnabled

public static boolean getChangePasswordEnabled()

Gets boolean property indicating if it is allowed to change account passwords.

Returns:

true if the value of the Change Password Enabled property has been set to "true", false if it has been set to "false"

Throws:

PropertyNotFoundException - - if the property has not been found

getDefaultFetchSize

public static int getDefaultFetchSize()

Gets the default fetch size used when fetching results from database.

Returns:

the value of the Default Fetch Size property or a default value if the property has not been found

getMaxFetchSize

public static int getMaxFetchSize()

Gets the maximum fetch size used when fetching results from database.

Returns:

the value of the Maximum Fetch Size property or a default value if the property has not been found

getStatementCacheSize

public static int getStatementCacheSize()

Gets the size of the statement cache in the JDBC driver.

Returns:

the value of the Statement Cache Size property or a default value if the property has not been found

getDefaultStatementExecutionTimeout

public static int getDefaultStatementExecutionTimeout()

Gets the default database statement execution timeout to use for proxy sessions.

Returns:

the value (in seconds) set in ifs.properties file or 1800 seconds (30 minutes) in case not defined.

getTransformerFactory

public static java.lang.String getTransformerFactory()

Gets the TransformerFactory implementation class name.

Returns:

the value of the Transformer Factory property or null the property has not been found

getTeamServer

public static java.lang.String getTeamServer()

Gets the Team Server property.

Returns:

the value of the Team Server property or null if the property has not been found

getCompressionLevel

public static java.lang.String getCompressionLevel()

Gets compression level used by Client, Anonymous and SOAP Gateways for response compression. Allowed values are "BEST", "SPEED", "DEFAULT" and "NONE".

Returns:

the value of the compression level property or a default value if the property has not been found

getConnectionString

public static java.lang.String getConnectionString()

Gets the connection string to SOAP Gateway.

Returns:

the value of the Connection String property

Throws:

PropertyNotFoundException - - if the property has not been found

getConnectUser

public static java.lang.String getConnectUser()

Gets IFS Connect user.

Returns:

the value of the Connect User property or a default value if the property has not been found

getConnectPassword

public static java.lang.String getConnectPassword()

Gets IFS Connect user password.

Returns:

the value of the Connect Password property

Throws:

PropertyNotFoundException - - if the property has not been found

getFullyQualifiedDomainName

public static java.lang.String getFullyQualifiedDomainName()

Deprecated.

Kept for compatibility only.

Returns:

an empty String

isLogInfo

protected boolean isLogInfo()

logInfo

protected void logInfo(java.lang.String text)

logError

protected void logError(java.lang.String text)

logError

protected void logError(java.lang.Throwable t)

logError

protected void logError(java.lang.Throwable t,
                        java.lang.String text)

getProperty

public static java.lang.String getProperty(java.lang.String name)

Gets an IFS property.

Parameters:

name - the name of the property

Returns:

the property value, or null if the named property has not been found

getProperty

public static java.lang.String getProperty(java.lang.String name,
                                           java.lang.String defaultValue)

Gets an optional IFS property.

Parameters:

name - the name of the property

defaultValue - the default value

Returns:

found property value, or the default value if the property has not been found

getProperty

public static boolean getProperty(java.lang.String name,
                                  boolean defaultValue)

Gets an optional IFS property.

Parameters:

name - the name of the property

defaultValue - the default value

Returns:

found property value, or the default value if the property has not been found

getProperty

public static int getProperty(java.lang.String name,
                              int defaultValue)

Gets an optional IFS property.

Parameters:

name - the name of the property

defaultValue - the default value

Returns:

found property value, or the default value if the property has not been found

forceProperty

public static java.lang.String forceProperty(java.lang.String name)

Gets a mandatory IFS property.

Parameters:

name - the name of the property

Returns:

the property value

Throws:

FndProperties.PropertyNotFoundException - - if the property has not been found

getApplicationOwner

public static java.lang.String getApplicationOwner()

Gets database owner of IFS tables, views and packages.

Returns:

the value of the Application Owner property or a default value if the property has not been found

getJdbcDriverClass

public static java.lang.String getJdbcDriverClass()

Gets the JDBC driver implementation class name. The default value is the implementation class for Oracle driver.

Returns:

the value of the JDBC Driver Class property or the default value if the property has not been found

getJdbcUrl

public static java.lang.String getJdbcUrl()

Gets database connection URL for JDBC driver.

Returns:

the value of the JDBC URL property

Throws:

FndProperties.PropertyNotFoundException - - if the property has not been found

getDbUser

public static java.lang.String getDbUser()

Gets the database user (IFSSYS) for JDBC connections.

Returns:

the value of the Database User property or a default value if the property has not been found

getDbPassword

public static java.lang.String getDbPassword()

Gets the database user password for JDBC connections.

Returns:

the value of the Database Password property

Throws:

FndProperties.PropertyNotFoundException - - if the property has not been found