de.eacg.ecs.client

Class JsonProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

de.eacg.ecs.client.JsonProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class JsonProperties
extends Properties

Simple java.util.Properties implementation, that is able to parse a properties file in json format. Restrictions: supported types: String and (nested) Object ; other types in json file are ignored. Nested objects key names are separated by '.' Example: { "name": {"firstName": "Bart", "lastName": "Simpson"}} produces the properties: name.firstName = "Bart" name.lastName = "Simpson" Additional features: - an additional 'defaults' properties list, my by provided in the constructors. - defaults for the manadatory properties required by the RestClient may also be set by named setters (e.g. setUserName()) - a validate method checks if all required properties for RestClient are available

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_KEY
static String	API_PATH
static String	BASE_URL
static String	PROXY_PASS
static String	PROXY_PORT
static String	PROXY_URL
static String	PROXY_USER
static String	USER_NAME

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
JsonProperties(InputStream is)
JsonProperties(InputStream is, Properties defaults)
JsonProperties(String filename)
JsonProperties(String filename, Properties defaults)

Method Summary

Modifier and Type	Method and Description
void	setApiKey(String apiKey)
void	setApiPath(String apiPath)
void	setBaseUrl(String baseUrl)
void	setProxyPass(String proxyPass)
void	setProxyPort(String proxyPort)
void	setProxyUrl(String proxyUrl)
void	setProxyUser(String proxyUser)
void	setUserName(String userName)
List<String>	validate(String... keys) check if minimum required parameters are set: "userName", "apiKey", "baseUrl", "apiPath"

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

USER_NAME

public static final String USER_NAME

See Also:

Constant Field Values

API_KEY

public static final String API_KEY

See Also:

Constant Field Values

BASE_URL

public static final String BASE_URL

See Also:

Constant Field Values

API_PATH

public static final String API_PATH

See Also:

Constant Field Values

PROXY_URL

public static final String PROXY_URL

See Also:

Constant Field Values

PROXY_PORT

public static final String PROXY_PORT

See Also:

Constant Field Values

PROXY_USER

public static final String PROXY_USER

See Also:

Constant Field Values

PROXY_PASS

public static final String PROXY_PASS

See Also:

Constant Field Values

Constructor Detail

JsonProperties

public JsonProperties(String filename)
               throws IOException

Throws:

IOException

JsonProperties

public JsonProperties(String filename,
                      Properties defaults)
               throws IOException

Throws:

IOException

JsonProperties

public JsonProperties(InputStream is)
               throws IOException

Throws:

IOException

JsonProperties

public JsonProperties(InputStream is,
                      Properties defaults)
               throws IOException

Throws:

IOException

Method Detail

setUserName

public void setUserName(String userName)

setApiKey

public void setApiKey(String apiKey)

setBaseUrl

public void setBaseUrl(String baseUrl)

setApiPath

public void setApiPath(String apiPath)

setProxyUrl

public void setProxyUrl(String proxyUrl)

setProxyPort

public void setProxyPort(String proxyPort)

setProxyUser

public void setProxyUser(String proxyUser)

setProxyPass

public void setProxyPass(String proxyPass)

validate

public List<String> validate(String... keys)

check if minimum required parameters are set: "userName", "apiKey", "baseUrl", "apiPath"

Parameters:

keys - additional keys to check

Returns:

a list of missing keys