org.apache.oozie.util

Class ConfigUtils

java.lang.Object

org.apache.oozie.util.ConfigUtils

public class ConfigUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	BOOLEAN_DEFAULT
static float	FLOAT_DEFAULT
static int	INT_DEFAULT
static long	LONG_DEFAULT
static java.lang.String	STRING_DEFAULT

Constructor Summary

Constructors

Constructor and Description
ConfigUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static <E extends java.lang.Exception> void	checkAndSetDisallowedProperties(org.apache.hadoop.conf.Configuration base, java.lang.String newValue, E toThrow, boolean performWrite) Check Configuration whether it contains disallowed properties.
static java.lang.String	getOozieEffectiveUrl() Returns the HTTP or HTTPS URL for this Oozie server depending on which is actually configured
static java.lang.String	getOozieURL(boolean secure) Returns the HTTP or HTTPS URL for this Oozie server (http://HOSTNAME:HTTP_PORT/oozie or https://HOSTNAME:HTTPS_PORT/oozie)
static boolean	getWithDeprecatedCheck(org.apache.hadoop.conf.Configuration conf, java.lang.String newName, java.lang.String oldName, boolean defaultValue) Fetches a property using both a deprecated name and the new name.
static java.lang.String	getWithDeprecatedCheck(org.apache.hadoop.conf.Configuration conf, java.lang.String newName, java.lang.String oldName, java.lang.String defaultValue) Fetches a property using both a deprecated name and the new name.
static boolean	isBackwardSupportForCoordStatus()

Methods inherited from class java.lang.Object

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

Field Detail

BOOLEAN_DEFAULT

public static boolean BOOLEAN_DEFAULT

STRING_DEFAULT

public static java.lang.String STRING_DEFAULT

INT_DEFAULT

public static int INT_DEFAULT

FLOAT_DEFAULT

public static float FLOAT_DEFAULT

LONG_DEFAULT

public static long LONG_DEFAULT

Constructor Detail

ConfigUtils

public ConfigUtils()

Method Detail

getWithDeprecatedCheck

public static java.lang.String getWithDeprecatedCheck(org.apache.hadoop.conf.Configuration conf,
                                      java.lang.String newName,
                                      java.lang.String oldName,
                                      java.lang.String defaultValue)

Fetches a property using both a deprecated name and the new name. The deprecated property has precedence over the new name. If the deprecated name is used a warning is written to the log.

Parameters:

conf - configuration object.

newName - new property name.

oldName - deprecated property name.

defaultValue - default value.

Returns:

the property value, or the default value if not found under the deprecated name and the new name.

getWithDeprecatedCheck

public static boolean getWithDeprecatedCheck(org.apache.hadoop.conf.Configuration conf,
                             java.lang.String newName,
                             java.lang.String oldName,
                             boolean defaultValue)

Fetches a property using both a deprecated name and the new name. The deprecated property has precedence over the new name. If the deprecated name is used a warning is written to the log.

Parameters:

conf - configuration object.

newName - new property name.

oldName - deprecated property name.

defaultValue - default value.

Returns:

the property value, or the default value if not found under the deprecated name and the new name.

getOozieURL

public static java.lang.String getOozieURL(boolean secure)

Returns the HTTP or HTTPS URL for this Oozie server (http://HOSTNAME:HTTP_PORT/oozie or https://HOSTNAME:HTTPS_PORT/oozie)

Parameters:

secure - true to return the HTTPS URL or false to return the HTTP URL

Returns:

the HTTP or HTTPS URL for this Oozie server

getOozieEffectiveUrl

public static java.lang.String getOozieEffectiveUrl()

Returns the HTTP or HTTPS URL for this Oozie server depending on which is actually configured

Returns:

the HTTP or HTTPS URL for this Oozie server

isBackwardSupportForCoordStatus

public static boolean isBackwardSupportForCoordStatus()

checkAndSetDisallowedProperties

public static <E extends java.lang.Exception> void checkAndSetDisallowedProperties(org.apache.hadoop.conf.Configuration base,
                                                                   java.lang.String newValue,
                                                                   E toThrow,
                                                                   boolean performWrite)
                                            throws E extends java.lang.Exception

Check Configuration whether it contains disallowed properties. Given configuration property values of oozie-site.xml#oozie.configuration.check-and-set.DISALLOWED.PROPERTY_KEY, newValue and performWrite values, one of the following will happen:

• base doesn't contain any disallowed property: NOP
• base contains a disallowed property but its value is the same as newValue: NOP
• base contains a conflicting disallowed property and configuration tells we should also set, but performWrite=false: NOP
• base contains a conflicting disallowed property and configuration tells we should also set, and performWrite=true: base will be overwritten by key=newValue
• base contains a conflicting disallowed property and configuration tells we should not set: Exception toThrow is thrown

Type Parameters:

E - Exception type

Parameters:

base - the Configuration to check

newValue - the new value to assign if performWrite=true and if configuration value oozie.configuration.check-and-set.* is set

toThrow - the Exception to throw when oozie.configuration.check-and-set.* is unset

performWrite -

Throws:

E - the Exception to throw when oozie.configuration.check-and-set.* is unset

E extends java.lang.Exception