Package uk.gov.gchq.gaffer.federatedstore

Class FederatedStoreProperties

java.lang.Object

uk.gov.gchq.gaffer.store.StoreProperties

uk.gov.gchq.gaffer.federatedstore.FederatedStoreProperties

All Implemented Interfaces:

Cloneable

public class FederatedStoreProperties
extends StoreProperties

Additional StoreProperties for the FederatedStore.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CACHE_SERVICE_CLASS_DEFAULT
static String	CACHE_SERVICE_FEDERATED_STORE_CLASS	Name of the system property to use for defining a cache service class dedicated to the Federated Store.
static String	CACHE_SERVICE_FEDERATED_STORE_SUFFIX
static String	CUSTOM_PROPERTIES_AUTHS	String containing auths for allowing users to use store properties other than those contained in a graph library.
static String	CUSTOM_PROPERTIES_AUTHS_DEFAULT
static String	IS_PUBLIC_ACCESS_ALLOWED	Controls if adding graphs with public access is allowed.
static String	IS_PUBLIC_ACCESS_ALLOWED_DEFAULT
static String	STORE_CONFIGURED_GRAPHIDS
static String	STORE_CONFIGURED_MERGE_FUNCTIONS

Fields inherited from class uk.gov.gchq.gaffer.store.StoreProperties

ADMIN_AUTH, EXECUTOR_SERVICE_THREAD_COUNT, EXECUTOR_SERVICE_THREAD_COUNT_DEFAULT, GAFFER_NAMED_OPERATION_NESTED, JOB_TRACKER_ENABLED, JSON_SERIALISER_CLASS, JSON_SERIALISER_MODULES, OPERATION_DECLARATIONS, OPERATION_DECLARATIONS_JSON, REFLECTION_PACKAGES, RESCHEDULE_JOBS_ON_START, SCHEMA_CLASS, STORE_CLASS, STORE_PROPERTIES_CLASS, STRICT_JSON

Constructor Summary

Constructors

Constructor	Description
FederatedStoreProperties()

Method Summary

Modifier and Type	Method	Description
String	getCacheServiceFederatedStoreSuffix(String defaultValue)
static String	getCacheServiceFederatedStoreSuffix(StoreProperties properties, String defaultValue)
String	getCustomPropsValue()
String	getFederatedStoreCacheServiceClass()
String	getIsPublicAccessAllowed()
String	getIsPublicAccessAllowed(String defaultValue)
String	getStoreConfiguredGraphIds()
String	getStoreConfiguredMergeFunctions()
static FederatedStoreProperties	loadStoreProperties(InputStream storePropertiesStream)
static FederatedStoreProperties	loadStoreProperties(String pathStr)
static FederatedStoreProperties	loadStoreProperties(Path storePropertiesPath)
void	setCustomPropertyAuths(String auths)
void	setFalseGraphsCanHavePublicAccess()
void	setFederatedStoreCacheServiceClass(String cacheServiceClassString)
void	setGraphsCanHavePublicAccess(boolean b)
void	setStoreConfiguredGraphIds(String mergeFunctionFile)
void	setStoreConfiguredMergeFunctions(String mergeFunctionFile)
void	setTrueGraphsCanHavePublicAccess()

Methods inherited from class uk.gov.gchq.gaffer.store.StoreProperties

addOperationDeclarationPaths, clone, containsKey, equals, get, get, getAdminAuth, getCacheServiceClass, getCacheServiceClass, getCacheServiceDefaultSuffix, getCacheServiceJobTrackerSuffix, getCacheServiceNamedOperationSuffix, getCacheServiceNamedViewSuffix, getDefaultCacheServiceClass, getJobExecutorThreadCount, getJobTrackerCacheServiceClass, getJobTrackerEnabled, getJsonSerialiserClass, getJsonSerialiserModules, getNamedOperationCacheServiceClass, getNamedViewCacheServiceClass, getOperationDeclarationPaths, getOperationDeclarations, getProperties, getReflectionPackages, getRescheduleJobsOnStart, getSchemaClass, getSchemaClassName, getStoreClass, getStorePropertiesClass, getStorePropertiesClassName, getStrictJson, hashCode, isNestedNamedOperationAllow, isNestedNamedOperationAllow, loadStoreProperties, loadStoreProperties, loadStoreProperties, loadStoreProperties, loadStoreProperties, merge, set, setAdminAuth, setCacheServiceClass, setCacheServiceNameSuffix, setDefaultCacheServiceClass, setJobTrackerCacheServiceClass, setJobTrackerEnabled, setJsonSerialiserClass, setJsonSerialiserClass, setJsonSerialiserModules, setJsonSerialiserModules, setNamedOperationCacheServiceClass, setNamedViewCacheServiceClass, setNestedNamedOperationAllow, setOperationDeclarationPaths, setProperties, setReflectionPackages, setRescheduleJobsOnStart, setSchemaClass, setSchemaClass, setStoreClass, setStoreClass, setStorePropertiesClass, setStorePropertiesClassName, setStrictJson, toString, updateStorePropertiesClass, updateStorePropertiesClass

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

IS_PUBLIC_ACCESS_ALLOWED

public static final String IS_PUBLIC_ACCESS_ALLOWED

Controls if adding graphs with public access is allowed. True by default. e.g. gaffer.federatedstore.isPublicAllowed=true

See Also:

Constant Field Values

IS_PUBLIC_ACCESS_ALLOWED_DEFAULT

public static final String IS_PUBLIC_ACCESS_ALLOWED_DEFAULT

CUSTOM_PROPERTIES_AUTHS

public static final String CUSTOM_PROPERTIES_AUTHS

String containing auths for allowing users to use store properties other than those contained in a graph library. Unset by default, allowing all users to do this. e.g. gaffer.federatedstore.customPropertiesAuths="auth1"

See Also:

Constant Field Values

CUSTOM_PROPERTIES_AUTHS_DEFAULT

public static final String CUSTOM_PROPERTIES_AUTHS_DEFAULT

CACHE_SERVICE_CLASS_DEFAULT

public static final String CACHE_SERVICE_CLASS_DEFAULT

STORE_CONFIGURED_MERGE_FUNCTIONS

public static final String STORE_CONFIGURED_MERGE_FUNCTIONS

See Also:

Constant Field Values

STORE_CONFIGURED_GRAPHIDS

public static final String STORE_CONFIGURED_GRAPHIDS

See Also:

Constant Field Values

CACHE_SERVICE_FEDERATED_STORE_SUFFIX

public static final String CACHE_SERVICE_FEDERATED_STORE_SUFFIX

See Also:

Constant Field Values

CACHE_SERVICE_FEDERATED_STORE_CLASS

public static final String CACHE_SERVICE_FEDERATED_STORE_CLASS

Name of the system property to use for defining a cache service class dedicated to the Federated Store.

See Also:

Constant Field Values

Constructor Detail

FederatedStoreProperties

public FederatedStoreProperties()

Method Detail

loadStoreProperties

public static FederatedStoreProperties loadStoreProperties(String pathStr)

loadStoreProperties

public static FederatedStoreProperties loadStoreProperties(InputStream storePropertiesStream)

loadStoreProperties

public static FederatedStoreProperties loadStoreProperties(Path storePropertiesPath)

setCustomPropertyAuths

public void setCustomPropertyAuths(String auths)

getCustomPropsValue

public String getCustomPropsValue()

getIsPublicAccessAllowed

public String getIsPublicAccessAllowed()

getIsPublicAccessAllowed

public String getIsPublicAccessAllowed(String defaultValue)

setFalseGraphsCanHavePublicAccess

public void setFalseGraphsCanHavePublicAccess()

setTrueGraphsCanHavePublicAccess

public void setTrueGraphsCanHavePublicAccess()

setGraphsCanHavePublicAccess

public void setGraphsCanHavePublicAccess(boolean b)

getStoreConfiguredMergeFunctions

public String getStoreConfiguredMergeFunctions()

setStoreConfiguredMergeFunctions

public void setStoreConfiguredMergeFunctions(String mergeFunctionFile)

getStoreConfiguredGraphIds

public String getStoreConfiguredGraphIds()

setStoreConfiguredGraphIds

public void setStoreConfiguredGraphIds(String mergeFunctionFile)

getCacheServiceFederatedStoreSuffix

public String getCacheServiceFederatedStoreSuffix(String defaultValue)

getCacheServiceFederatedStoreSuffix

public static String getCacheServiceFederatedStoreSuffix(StoreProperties properties,
                                                         String defaultValue)

getFederatedStoreCacheServiceClass

public String getFederatedStoreCacheServiceClass()

setFederatedStoreCacheServiceClass

public void setFederatedStoreCacheServiceClass(String cacheServiceClassString)