uk.gov.gchq.gaffer.store

Class StoreProperties

java.lang.Object

uk.gov.gchq.gaffer.store.StoreProperties

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AccumuloProperties, FederatedStoreProperties, HBaseProperties, MapStoreProperties, ParquetStoreProperties, ProxyProperties

public class StoreProperties
extends Object
implements Cloneable

A StoreProperties contains specific configuration information for the store, such as database connection strings. It wraps Properties and lazy loads the all properties from a file when first used.

All StoreProperties classes must be JSON serialisable.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_AUTH
static String	EXECUTOR_SERVICE_THREAD_COUNT
static String	EXECUTOR_SERVICE_THREAD_COUNT_DEFAULT
static String	ID Deprecated. the ID should not be used. The properties ID should be supplied to the graph library separately.
static String	JOB_TRACKER_ENABLED
static String	JSON_SERIALISER_CLASS
static String	JSON_SERIALISER_MODULES
static String	OPERATION_DECLARATIONS
static String	REFLECTION_PACKAGES CSV of extra packages to be included in the reflection scanning.
static String	SCHEMA_CLASS
static String	STORE_CLASS
static String	STORE_PROPERTIES_CLASS
static String	STRICT_JSON

Constructor Summary

Constructors

Constructor and Description
StoreProperties()
StoreProperties(Path propFileLocation)
StoreProperties(Properties props)
StoreProperties(String id) Deprecated. the id should not be used. The properties id should be supplied to the graph library separately.

Method Summary

Modifier and Type	Method and Description
void	addOperationDeclarationPaths(String... newPaths)
StoreProperties	clone()
boolean	containsKey(Object key)
boolean	equals(Object obj)
String	get(String key)
String	get(String key, String defaultValue) Get a parameter from the schema file, or the default value.
String	getAdminAuth()
String	getId() Deprecated. the ID should be supplied to the graph library separately
Integer	getJobExecutorThreadCount()
Boolean	getJobTrackerEnabled()
String	getJsonSerialiserClass()
String	getJsonSerialiserModules()
String	getOperationDeclarationPaths()
OperationDeclarations	getOperationDeclarations() Returns the operation definitions from the file specified in the properties.
Properties	getProperties()
String	getReflectionPackages()
Class<? extends Schema>	getSchemaClass()
String	getSchemaClassName()
String	getStoreClass()
Class<? extends StoreProperties>	getStorePropertiesClass()
String	getStorePropertiesClassName()
Boolean	getStrictJson()
int	hashCode()
static StoreProperties	loadStoreProperties(InputStream storePropertiesStream)
static <T extends StoreProperties> T	loadStoreProperties(InputStream storePropertiesStream, Class<T> requiredClass)
static StoreProperties	loadStoreProperties(Path storePropertiesPath)
static <T extends StoreProperties> T	loadStoreProperties(Path storePropertiesPath, Class<T> requiredClass)
static StoreProperties	loadStoreProperties(Properties props)
static <T extends StoreProperties> T	loadStoreProperties(Properties props, Class<T> requiredClass)
static StoreProperties	loadStoreProperties(String pathStr)
static <T extends StoreProperties> T	loadStoreProperties(String pathStr, Class<T> requiredClass)
void	merge(StoreProperties properties)
void	set(String key, String value) Set a parameter from the schema file.
void	setAdminAuth(String adminAuth)
void	setId(String id) Deprecated. the ID should be supplied to the graph library separately
void	setJobTrackerEnabled(Boolean jobTrackerEnabled)
void	setJsonSerialiserClass(Class<? extends JSONSerialiser> jsonSerialiserClass)
void	setJsonSerialiserClass(String jsonSerialiserClass)
void	setJsonSerialiserModules(Set<Class<? extends JSONSerialiserModules>> modules)
void	setJsonSerialiserModules(String modules)
void	setOperationDeclarationPaths(String paths)
void	setProperties(Properties properties)
void	setReflectionPackages(String packages)
void	setSchemaClass(Class<? extends Schema> schemaClass)
void	setSchemaClass(String schemaClass)
void	setStoreClass(Class<? extends Store> storeClass)
void	setStoreClass(String storeClass)
void	setStorePropertiesClass(Class<? extends StoreProperties> storePropertiesClass)
void	setStorePropertiesClassName(String storePropertiesClassName)
void	setStrictJson(Boolean strictJson)
String	toString()
void	updateStorePropertiesClass()
void	updateStorePropertiesClass(Class<? extends StoreProperties> requiredClass)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

STORE_CLASS

public static final String STORE_CLASS

See Also:

Constant Field Values

SCHEMA_CLASS

public static final String SCHEMA_CLASS

See Also:

Constant Field Values

ID

@Deprecated
public static final String ID

Deprecated. the ID should not be used. The properties ID should be supplied to the graph library separately.

See Also:

Constant Field Values

STORE_PROPERTIES_CLASS

public static final String STORE_PROPERTIES_CLASS

See Also:

Constant Field Values

OPERATION_DECLARATIONS

public static final String OPERATION_DECLARATIONS

See Also:

Constant Field Values

JOB_TRACKER_ENABLED

public static final String JOB_TRACKER_ENABLED

See Also:

Constant Field Values

EXECUTOR_SERVICE_THREAD_COUNT

public static final String EXECUTOR_SERVICE_THREAD_COUNT

See Also:

Constant Field Values

EXECUTOR_SERVICE_THREAD_COUNT_DEFAULT

public static final String EXECUTOR_SERVICE_THREAD_COUNT_DEFAULT

See Also:

Constant Field Values

JSON_SERIALISER_CLASS

public static final String JSON_SERIALISER_CLASS

See Also:

Constant Field Values

JSON_SERIALISER_MODULES

public static final String JSON_SERIALISER_MODULES

See Also:

Constant Field Values

STRICT_JSON

public static final String STRICT_JSON

See Also:

Constant Field Values

ADMIN_AUTH

public static final String ADMIN_AUTH

See Also:

Constant Field Values

REFLECTION_PACKAGES

public static final String REFLECTION_PACKAGES

CSV of extra packages to be included in the reflection scanning.

See Also:

Constant Field Values

Constructor Detail

StoreProperties

public StoreProperties()

StoreProperties

@Deprecated
public StoreProperties(String id)

Deprecated. the id should not be used. The properties id should be supplied to the graph library separately.

Parameters:

id - the StoreProperties id.

StoreProperties

public StoreProperties(Path propFileLocation)

StoreProperties

public StoreProperties(Properties props)

Method Detail

loadStoreProperties

public static <T extends StoreProperties> T loadStoreProperties(String pathStr,
                                                                Class<T> requiredClass)

loadStoreProperties

public static StoreProperties loadStoreProperties(String pathStr)

loadStoreProperties

public static <T extends StoreProperties> T loadStoreProperties(Path storePropertiesPath,
                                                                Class<T> requiredClass)

loadStoreProperties

public static StoreProperties loadStoreProperties(Path storePropertiesPath)

loadStoreProperties

public static <T extends StoreProperties> T loadStoreProperties(InputStream storePropertiesStream,
                                                                Class<T> requiredClass)

loadStoreProperties

public static StoreProperties loadStoreProperties(InputStream storePropertiesStream)

loadStoreProperties

public static <T extends StoreProperties> T loadStoreProperties(Properties props,
                                                                Class<T> requiredClass)

loadStoreProperties

public static StoreProperties loadStoreProperties(Properties props)

get

public String get(String key)

Parameters:

key - the property key

Returns:

a property properties file with the given key.

containsKey

public boolean containsKey(Object key)

get

public String get(String key,
                  String defaultValue)

Get a parameter from the schema file, or the default value.

Parameters:

key - the property key

defaultValue - the default value to use if the property doesn't exist

Returns:

a property properties file with the given key or the default value if the property doesn't exist

set

public void set(String key,
                String value)

Set a parameter from the schema file.

Parameters:

key - the key

value - the value

merge

public void merge(StoreProperties properties)

getId

@Deprecated
public String getId()

Deprecated. the ID should be supplied to the graph library separately

Returns:

properties ID

setId

@Deprecated
public void setId(String id)

Deprecated. the ID should be supplied to the graph library separately

Set the ID for the StoreProperties

Parameters:

id - the value of the ID

getOperationDeclarations

public OperationDeclarations getOperationDeclarations()

Returns the operation definitions from the file specified in the properties. This is an optional feature, so if the property does not exist then this function will return an empty object.

Returns:

The Operation Definitions to load dynamically

getStoreClass

public String getStoreClass()

setStoreClass

public void setStoreClass(Class<? extends Store> storeClass)

setStoreClass

public void setStoreClass(String storeClass)

getJobTrackerEnabled

public Boolean getJobTrackerEnabled()

setJobTrackerEnabled

public void setJobTrackerEnabled(Boolean jobTrackerEnabled)

getSchemaClassName

public String getSchemaClassName()

getSchemaClass

public Class<? extends Schema> getSchemaClass()

setSchemaClass

public void setSchemaClass(String schemaClass)

setSchemaClass

public void setSchemaClass(Class<? extends Schema> schemaClass)

getStorePropertiesClassName

public String getStorePropertiesClassName()

setStorePropertiesClassName

public void setStorePropertiesClassName(String storePropertiesClassName)

getStorePropertiesClass

public Class<? extends StoreProperties> getStorePropertiesClass()

setStorePropertiesClass

public void setStorePropertiesClass(Class<? extends StoreProperties> storePropertiesClass)

getOperationDeclarationPaths

public String getOperationDeclarationPaths()

setOperationDeclarationPaths

public void setOperationDeclarationPaths(String paths)

getReflectionPackages

public String getReflectionPackages()

setReflectionPackages

public void setReflectionPackages(String packages)

getJobExecutorThreadCount

public Integer getJobExecutorThreadCount()

addOperationDeclarationPaths

public void addOperationDeclarationPaths(String... newPaths)

getJsonSerialiserClass

public String getJsonSerialiserClass()

setJsonSerialiserClass

public void setJsonSerialiserClass(Class<? extends JSONSerialiser> jsonSerialiserClass)

setJsonSerialiserClass

public void setJsonSerialiserClass(String jsonSerialiserClass)

getJsonSerialiserModules

public String getJsonSerialiserModules()

setJsonSerialiserModules

public void setJsonSerialiserModules(Set<Class<? extends JSONSerialiserModules>> modules)

setJsonSerialiserModules

public void setJsonSerialiserModules(String modules)

getStrictJson

public Boolean getStrictJson()

setStrictJson

public void setStrictJson(Boolean strictJson)

getAdminAuth

public String getAdminAuth()

setAdminAuth

public void setAdminAuth(String adminAuth)

getProperties

public Properties getProperties()

setProperties

public void setProperties(Properties properties)

clone

public StoreProperties clone()

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

updateStorePropertiesClass

public void updateStorePropertiesClass()

updateStorePropertiesClass

public void updateStorePropertiesClass(Class<? extends StoreProperties> requiredClass)

toString

public String toString()

Overrides:

toString in class Object