azkaban.utils

Class PropsUtils

java.lang.Object

azkaban.utils.PropsUtils

public class PropsUtils
extends java.lang.Object

Utility Functions related to Prop Operations

Method Summary

Modifier and Type	Method and Description
static Props	fromHierarchicalMap(java.util.Map<java.lang.String,java.lang.Object> propsMap) Convert a hierarchical Map to Prop Object
static Props	fromJSONString(java.lang.String json) Convert json String to Prop Object
static java.lang.String	getPropertyDiff(Props oldProps, Props newProps) The difference between old and new Props
static boolean	isVariableReplacementPattern(java.lang.String value) Check if the prop value is a variable replacement pattern
static Props	loadPluginProps(java.io.File pluginDir) Load plugin properties
static Props	loadProps(Props parent, java.io.File... propFiles) Load Props
static void	loadPropsBySuffix(java.io.File jobPath, Props props, java.lang.String... suffixes) Load properties from the given path
static Props	loadPropsInDir(java.io.File dir, java.lang.String... suffixes) Load job schedules from the given directories
static Props	loadPropsInDir(Props parent, java.io.File dir, java.lang.String... suffixes) Load job schedules from the given directories
static Props	loadPropsInDirs(java.util.List<java.io.File> dirs, java.lang.String... suffixes) Load job schedules from the given directories
static Props	newProps(Props parentProps, java.io.File file) new Props based on default Props and expand it from external prop file
static Props	newProps(Props parentProps, java.lang.String filePath) new Props based on default Props and expand it from external prop file
static Props	resolveProps(Props props) Resolve Props
static java.util.Map<java.lang.String,java.lang.Object>	toHierarchicalMap(Props props) Convert a Props object to a hierarchical Map
static java.lang.String	toJSONString(Props props, boolean localOnly) Convert props to json string
static java.util.Map<java.lang.String,java.lang.String>	toStringMap(Props props, boolean localOnly) Convert props to Map

Methods inherited from class java.lang.Object

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

Method Detail

loadPropsInDir

public static Props loadPropsInDir(java.io.File dir,
                                   java.lang.String... suffixes)

Load job schedules from the given directories

Parameters:

dir - The directory to look in

suffixes - File suffixes to load

Returns:

The loaded set of schedules

loadPropsInDir

public static Props loadPropsInDir(Props parent,
                                   java.io.File dir,
                                   java.lang.String... suffixes)

Load job schedules from the given directories

Parameters:

parent - The parent properties for these properties

dir - The directory to look in

suffixes - File suffixes to load

Returns:

The loaded set of schedules

loadProps

public static Props loadProps(Props parent,
                              java.io.File... propFiles)

Load Props

Parameters:

parent - parent prop

propFiles - prop files

Returns:

constructed new Prop

loadPluginProps

public static Props loadPluginProps(java.io.File pluginDir)

Load plugin properties

Parameters:

pluginDir - plugin's Base Directory

Returns:

The properties

loadPropsInDirs

public static Props loadPropsInDirs(java.util.List<java.io.File> dirs,
                                    java.lang.String... suffixes)

Load job schedules from the given directories

Parameters:

dirs - The directories to check for properties

suffixes - The suffixes to load

Returns:

The properties

loadPropsBySuffix

public static void loadPropsBySuffix(java.io.File jobPath,
                                     Props props,
                                     java.lang.String... suffixes)

Load properties from the given path

Parameters:

jobPath - The path to load from

props - The parent properties for loaded properties

suffixes - The suffixes of files to load

isVariableReplacementPattern

public static boolean isVariableReplacementPattern(java.lang.String value)

Check if the prop value is a variable replacement pattern

resolveProps

public static Props resolveProps(Props props)

Resolve Props

Parameters:

props - props

Returns:

resolved props

newProps

public static Props newProps(Props parentProps,
                             java.lang.String filePath)
                      throws java.io.IOException

new Props based on default Props and expand it from external prop file

Parameters:

parentProps - parent Props

filePath - filePath

Returns:

combined props

Throws:

java.io.IOException

newProps

public static Props newProps(Props parentProps,
                             java.io.File file)
                      throws java.io.IOException

new Props based on default Props and expand it from external prop file

Parameters:

parentProps - parent Props

file - prop file

Returns:

combined props

Throws:

java.io.IOException

toJSONString

public static java.lang.String toJSONString(Props props,
                                            boolean localOnly)

Convert props to json string

Parameters:

props - props

localOnly - include local prop sets only or not

Returns:

json string format of props

toStringMap

public static java.util.Map<java.lang.String,java.lang.String> toStringMap(Props props,
                                                                           boolean localOnly)

Convert props to Map

Parameters:

props - props

localOnly - include local prop sets only or not

Returns:

String Map of props

fromJSONString

public static Props fromJSONString(java.lang.String json)
                            throws java.io.IOException

Convert json String to Prop Object

Parameters:

json - json formatted string

Returns:

a new constructed Prop Object

Throws:

java.io.IOException - exception on parsing json string to prop object

fromHierarchicalMap

public static Props fromHierarchicalMap(java.util.Map<java.lang.String,java.lang.Object> propsMap)

Convert a hierarchical Map to Prop Object

Parameters:

propsMap - a hierarchical Map

Returns:

a new constructed Props Object

toHierarchicalMap

public static java.util.Map<java.lang.String,java.lang.Object> toHierarchicalMap(Props props)

Convert a Props object to a hierarchical Map

Parameters:

props - props object

Returns:

a hierarchical Map presented Props object

getPropertyDiff

public static java.lang.String getPropertyDiff(Props oldProps,
                                               Props newProps)

The difference between old and new Props

Parameters:

oldProps - old Props

newProps - new Props

Returns:

string formatted difference