Package uk.gov.gchq.gaffer.store

Class StoreProperties

    • Constructor Detail

      • StoreProperties

        public StoreProperties()

      • 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 <T extends StoreProperties> T loadStoreProperties​(Path storePropertiesPath,
                                                                Class<T> requiredClass)

      • loadStoreProperties

        public static StoreProperties loadStoreProperties​(Path storePropertiesPath)

      • 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

      • 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)

      • getNamedViewEnabled

        public boolean getNamedViewEnabled()

      • setNamedViewEnabled

        public void setNamedViewEnabled​(boolean namedViewEnabled)

      • getNamedOperationEnabled

        public boolean getNamedOperationEnabled()

      • setNamedOperationEnabled

        public void setNamedOperationEnabled​(boolean namedOperationEnabled)

      • getRescheduleJobsOnStart

        public boolean getRescheduleJobsOnStart()

      • setRescheduleJobsOnStart

        public void setRescheduleJobsOnStart​(boolean rescheduleJobsOnStart)

      • 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)

      • 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​(String modules)

      • getStrictJson

        public Boolean getStrictJson()

      • setStrictJson

        public void setStrictJson​(Boolean strictJson)

      • getAdminAuth

        public String getAdminAuth()

      • setAdminAuth

        public void setAdminAuth​(String adminAuth)

      • getDefaultCacheServiceClass

        public String getDefaultCacheServiceClass()

      • setDefaultCacheServiceClass

        public void setDefaultCacheServiceClass​(String cacheServiceClassString)

      • getJobTrackerCacheServiceClass

        public String getJobTrackerCacheServiceClass()

      • setJobTrackerCacheServiceClass

        public void setJobTrackerCacheServiceClass​(String cacheServiceClassString)

      • getNamedViewCacheServiceClass

        public String getNamedViewCacheServiceClass()

      • setNamedViewCacheServiceClass

        public void setNamedViewCacheServiceClass​(String cacheServiceClassString)

      • getNamedOperationCacheServiceClass

        public String getNamedOperationCacheServiceClass()

      • setNamedOperationCacheServiceClass

        public void setNamedOperationCacheServiceClass​(String cacheServiceClassString)

      • setCacheServiceClass

        @Deprecated
public void setCacheServiceClass​(String cacheServiceClassString)
        Deprecated.

      • getCacheServiceClass

        @Deprecated
public String getCacheServiceClass()
        Deprecated.

      • setCacheServiceNameSuffix

        public void setCacheServiceNameSuffix​(String suffix)

      • getCacheServiceDefaultSuffix

        public String getCacheServiceDefaultSuffix​(String defaultValue)

      • getCacheServiceNamedOperationSuffix

        public String getCacheServiceNamedOperationSuffix​(String defaultValue)

      • isNestedNamedOperationAllow

        public boolean isNestedNamedOperationAllow()

      • isNestedNamedOperationAllow

        public boolean isNestedNamedOperationAllow​(boolean defaultValue)

      • setNestedNamedOperationAllow

        public void setNestedNamedOperationAllow​(boolean isAllowed)

      • getCacheServiceJobTrackerSuffix

        public String getCacheServiceJobTrackerSuffix​(String defaultValue)

      • getCacheServiceNamedViewSuffix

        public String getCacheServiceNamedViewSuffix​(String defaultValue)

      • getProperties

        public Properties getProperties()

      • setProperties

        public void setProperties​(Properties properties)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • updateStorePropertiesClass

        public void updateStorePropertiesClass()

      • updateStorePropertiesClass

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