HubConfigImpl (marklogic-data-hub 5.8.0 API)

java.lang.Object
- com.marklogic.hub.HubClientConfig
- - com.marklogic.hub.impl.HubConfigImpl

All Implemented Interfaces:

HubConfig
```
public class HubConfigImpl
extends com.marklogic.hub.HubClientConfig
implements HubConfig
```
Extends HubConfigImpl to define all Data Hub properties, including those specific to deploying DHF.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`customForestPath`
`protected java.lang.Integer`	`finalForestsPerHost`
`protected java.lang.String`	`finalHttpName`
`protected java.lang.Integer`	`finalSchemasForestsPerHost`
`protected java.lang.Integer`	`finalTriggersForestsPerHost`
`protected java.lang.Integer`	`jobForestsPerHost`
`protected java.lang.String`	`jobHttpName`
`protected java.lang.Integer`	`modulesForestsPerHost`
`protected java.lang.Integer`	`stagingForestsPerHost`
`protected java.lang.String`	`stagingHttpName`
`protected java.lang.Integer`	`stagingSchemasForestsPerHost`
`protected java.lang.Integer`	`stagingTriggersForestsPerHost`

Fields inherited from interface com.marklogic.hub.HubConfig
DEFAULT_AUTH_METHOD, DEFAULT_CUSTOM_FOREST_PATH, DEFAULT_DEVELOPER_ROLE_NAME, DEFAULT_FINAL_NAME, DEFAULT_FINAL_PORT, DEFAULT_FINAL_SCHEMAS_DB_NAME, DEFAULT_FINAL_TRIGGERS_DB_NAME, DEFAULT_FORESTS_PER_HOST, DEFAULT_HUB_LOG_LEVEL, DEFAULT_JOB_NAME, DEFAULT_JOB_PORT, DEFAULT_MODULES_DB_NAME, DEFAULT_ROLE_NAME, DEFAULT_SCHEME, DEFAULT_STAGING_NAME, DEFAULT_STAGING_PORT, DEFAULT_STAGING_SCHEMAS_DB_NAME, DEFAULT_STAGING_TRIGGERS_DB_NAME, ENTITY_CONFIG_DIR, EXP_FINAL_ENTITY_QUERY_OPTIONS_FILE, EXP_STAGING_ENTITY_QUERY_OPTIONS_FILE, FINAL_ENTITY_DATABASE_FILE, FINAL_ENTITY_QUERY_OPTIONS_FILE, HUB_CONFIG_DIR, PATH_PREFIX, PII_PROTECTED_PATHS_FILE, PII_QUERY_ROLESET_FILE, STAGING_ENTITY_DATABASE_FILE, STAGING_ENTITY_QUERY_OPTIONS_FILE, USER_CONFIG_DIR, USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES

Constructor Summary

Constructors
Constructor and Description
`HubConfigImpl()` Constructs a HubConfigImpl with a default set of property values.
`HubConfigImpl(HubProject hubProject)` Constructor for when using this object outside of a Spring container, but a HubProject is still needed.
`HubConfigImpl(java.lang.String host, java.lang.String mlUsername, java.lang.String mlPassword)` Provides a minimally-configured instance of HubConfigImpl based on DHF default properties, with no dependency on Spring or on project files.
`HubConfigImpl(java.lang.String host, java.lang.String mlUsername, java.lang.String mlPassword, java.lang.String stagingDbName, java.lang.String finalDbName)` Provides a minimally-configured instance of HubConfigImpl based on DHF default properties, with no dependency on Spring or on project files.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addDhfPropertiesToCustomTokens(com.marklogic.appdeployer.AppConfig appConfig)` Populates the custom tokens map in the given AppConfig object.
`void`	`applyDefaultPermissionPropertyValues()` This is called by applyDefaultPropertyValues, but is separate for testing purposes.
`void`	`applyDefaultPropertyValues()` Applies values that, prior to 5.3.0, were stored in the dhf-defaults.properties file that was available from the classpath.
`void`	`applyProperties(java.util.Properties properties)` Applies properties in the given properties to this instance.
`void`	`applyProperties(com.marklogic.mgmt.util.PropertySource propertySource)` Applies properties in the given property source to this instance.
`void`	`applyProperties(com.marklogic.mgmt.util.PropertySource propertySource, com.marklogic.appdeployer.AppConfig appConfigToReuse, com.marklogic.mgmt.ManageConfig manageConfigToReuse, com.marklogic.mgmt.admin.AdminConfig adminConfigToReuse)` Applies properties in the given property source to this instance.
`void`	`configureForDhs()`
`void`	`createProject(java.lang.String projectDirString)` Initializes the java application state to a specific location.
`void`	`disableSimpleSsl()`
`void`	`enableSimpleSsl()`
`com.marklogic.mgmt.admin.AdminConfig`	`getAdminConfig()`
`com.marklogic.mgmt.admin.AdminManager`	`getAdminManager()`
`com.marklogic.appdeployer.AppConfig`	`getAppConfig()` Returns the current AppConfig object attached to the HubConfig
`java.lang.String`	`getAuthMethod(com.marklogic.hub.DatabaseKind kind)` Returns the AuthMethod object for the DatabaseKind in the hub config
`java.lang.String`	`getCertFile(com.marklogic.hub.DatabaseKind kind)` Returns the SSL Cert file as a string for the DatabaseKind in the hub config
`java.lang.String`	`getCertPassword(com.marklogic.hub.DatabaseKind kind)` Returns the SSL Cert Password as a string for the DatabaseKind in the hub config
`java.lang.String`	`getCustomForestPath()` Returns the path for the custom forests definition
`java.lang.String`	`getDbName(com.marklogic.hub.DatabaseKind kind)` Returns the database name for the DatabaseKind set in the config
`java.nio.file.Path`	`getEntityDatabaseDir()` Gets the path for the entity database directory
`java.lang.String`	`getEntityModelPermissions()` Prior to 5.1.0, entities were assigned permissions returned by getModulePermissions.
`java.lang.String`	`getExternalName(com.marklogic.hub.DatabaseKind kind)` Returns the external name for the host for the DatabaseKind in the hub config
`java.lang.String`	`getFlowDeveloperRoleName()` Get the roleName the hub uses for developing flows
`java.lang.String`	`getFlowOperatorRoleName()` Get the roleName the hub uses
`java.lang.String`	`getFlowPermissions()` Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions.
`java.nio.file.Path`	`getFlowsDir()` Gets the path for the flows directory
`java.lang.Integer`	`getForestsPerHost(com.marklogic.hub.DatabaseKind kind)` Returns the number of forests per host for the DatabaseKind set in the config
`java.lang.String`	`getHost()` Gets the hostname of the AppConfig
`java.lang.String`	`getHttpName(com.marklogic.hub.DatabaseKind kind)` Returns the appserver name for the DatabaseKind set in the config
`java.nio.file.Path`	`getHubConfigDir()` Gets the path for the hub's config directory
`java.nio.file.Path`	`getHubDatabaseDir()` Gets the path for the hub's database directory
`java.nio.file.Path`	`getHubEntitiesDir()` Gets the path for the hub entities directory
`java.lang.String`	`getHubLogLevel()` Gets the current level of logging set for the data hub
`java.nio.file.Path`	`getHubMappingsDir()` Gets the path for the hub mappings directory
`java.nio.file.Path`	`getHubPluginsDir()` Gets the path for the hub plugins directory
`HubProject`	`getHubProject()` Returns the HubProject associated with the HubConfig
`java.nio.file.Path`	`getHubProjectDir()`
`java.util.Properties`	`getHubPropertiesFromDb(com.marklogic.client.DatabaseClient client)`
`java.nio.file.Path`	`getHubSecurityDir()` Gets the path for the hub's security directory
`java.nio.file.Path`	`getHubServersDir()` Gets the path for the hub servers directory
`java.lang.String`	`getInfo()` Gets information on a datahub configuration
`java.lang.Boolean`	`getIsProvisionedEnvironment()` Signifies if we are dealing with a provisioned environment.
`java.lang.String`	`getJarVersion()` Gets the current version of the DHF Jar
`java.lang.String`	`getJobPermissions()`
`com.marklogic.mgmt.ManageClient`	`getManageClient()`
`com.marklogic.mgmt.ManageConfig`	`getManageConfig()`
`java.lang.String`	`getMappingPermissions()` Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions.
`java.lang.String`	`getMlPassword()`
`java.lang.String`	`getMlUsername()`
`java.nio.file.Path`	`getModulesDir()` Gets the path for the modules directory
`java.lang.Integer`	`getPort(com.marklogic.hub.DatabaseKind kind)` Returns the port number for the DatabaseKind set in the config
`java.lang.String`	`getProjectDir()` Deprecated.
`java.lang.String`	`getScheme(com.marklogic.hub.DatabaseKind kind)` Deprecated.
`boolean`	`getSimpleSsl(com.marklogic.hub.DatabaseKind kind)` Returns if Simple SSL is set for the DatabaseKind in the hub config
`javax.net.ssl.SSLContext`	`getSslContext(com.marklogic.hub.DatabaseKind kind)` Returns the SSL Context for the DatabaseKind set in the config
`com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier`	`getSslHostnameVerifier(com.marklogic.hub.DatabaseKind kind)` Returns the SSL hostname verifier object for the DatabaseKind in the hub config
`java.nio.file.Path`	`getStepDefinitionPath(StepDefinition.StepDefinitionType type)`
`java.lang.String`	`getStepDefinitionPermissions()` Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions.
`java.nio.file.Path`	`getStepDefinitionsDir()` Gets the path for the step definitions directory
`javax.net.ssl.X509TrustManager`	`getTrustManager(com.marklogic.hub.DatabaseKind kind)` Returns the TrustManager object for the DatabaseKind in the hub config
`java.nio.file.Path`	`getUserConfigDir()` Gets the path for the user config directory
`java.nio.file.Path`	`getUserDatabaseDir()` Gets the path for the user database directory
`java.nio.file.Path`	`getUserSchemasDir()` Gets the path for the user schemas directory
`java.nio.file.Path`	`getUserSecurityDir()` Gets the path for the user security directory
`java.nio.file.Path`	`getUserServersDir()` Gets the path for the user servers directory
`void`	`initHubProject()` Initializes the hub project on disk
`protected void`	`initializeConfigDirs(com.marklogic.appdeployer.AppConfig config)` ml-app-deployer defaults to a single config path of src/main/ml-config.
`protected void`	`initializeModulePaths(com.marklogic.appdeployer.AppConfig config)` Need to initialize every module path as being relative to the current project directory.
`protected void`	`initializePropertyConsumerMap()` Defines functions for consuming properties from a PropertySource.
`void`	`loadConfigurationFromProperties(java.util.Properties userProperties, boolean loadGradleProperties)` Use this when you need to apply properties, and you likely also want to load properties from Gradle files.
`com.marklogic.client.DatabaseClient`	`newAppServicesClient()` Creates a new DatabaseClient for accessing the AppServices app
`com.marklogic.client.DatabaseClient`	`newAppServicesModulesClient()`
`com.marklogic.client.DatabaseClient`	`newFinalClient()` Gets a new DatabaseClient that queries the Final database and appserver
`com.marklogic.hub.HubClient`	`newHubClient()`
`com.marklogic.client.DatabaseClient`	`newReverseFlowClient()` Gets a new DatabaseClient that queries the Final database using the staging appserver.
`com.marklogic.client.DatabaseClient`	`newStagingClient()` Gets a new DatabaseClient that queries the staging database and appserver
`com.marklogic.client.DatabaseClient`	`newTraceDbClient()` Deprecated.
`void`	`refreshProject()` Loads HubConfig object with values from gradle.properties (optionally overridden with gradle-(environment).properties).
`protected HubProject`	`requireHubProject()`
`void`	`setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)`
`void`	`setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)`
`void`	`setAppConfig(com.marklogic.appdeployer.AppConfig config)` Sets the AppConfig for the current HubConfig
`void`	`setAppConfig(com.marklogic.appdeployer.AppConfig config, boolean skipUpdate)` Sets the AppConfig for the current HubConfig, with skipUpdate option
`void`	`setAuthMethod(com.marklogic.hub.DatabaseKind kind, java.lang.String authMethod)` Sets the SSL Auth Method for the DatabaseKind in the config
`void`	`setCertFile(com.marklogic.hub.DatabaseKind kind, java.lang.String certFile)` Sets the SSL Certfile to use for the DatabaseKind in the config
`void`	`setCertPass(com.marklogic.hub.DatabaseKind kind, java.lang.String certPassword)` Sets the SSL Cert password for the DatabaseKind in the config
`void`	`setCustomForestPath(java.lang.String customForestPath)`
`void`	`setDbName(com.marklogic.hub.DatabaseKind kind, java.lang.String dbName)` Sets the database name for the databaseKind on the hubconfig
`void`	`setEntityModelPermissions(java.lang.String entityModelPermissions)`
`void`	`setExternalName(com.marklogic.hub.DatabaseKind kind, java.lang.String externalName)` Sets the external hostname for the DatabaseKind in the config
`void`	`setFlowDeveloperRoleName(java.lang.String flowDeveloperRoleName)` Set the role name that the hub uses for developing flows
`void`	`setFlowOperatorRoleName(java.lang.String flowOperatorRoleName)` Set the role name that the hub uses
`void`	`setFlowPermissions(java.lang.String flowPermissions)`
`void`	`setForestsPerHost(com.marklogic.hub.DatabaseKind kind, java.lang.Integer forestsPerHost)` Sets the number of forests per host for the databaseKind on the hubconfig
`void`	`setHost(java.lang.String host)`
`void`	`setHttpName(com.marklogic.hub.DatabaseKind kind, java.lang.String httpName)` Sets the appserver name for the databaseKind on the hubconfig
`void`	`setHubProject(HubProject hubProject)`
`void`	`setIsProvisionedEnvironment(boolean isProvisionedEnvironment)`
`void`	`setJobPermissions(java.lang.String jobPermissions)`
`void`	`setManageClient(com.marklogic.mgmt.ManageClient manageClient)`
`void`	`setMappingPermissions(java.lang.String mappingPermissions)`
`void`	`setMlPassword(java.lang.String mlPassword)`
`void`	`setMlUsername(java.lang.String mlUsername)`
`void`	`setPort(com.marklogic.hub.DatabaseKind kind, java.lang.Integer port)` Sets the port number for the databaseKind on the hubconfig
`void`	`setProjectDir(java.lang.String projectDir)` Deprecated.
`void`	`setScheme(com.marklogic.hub.DatabaseKind kind, java.lang.String scheme)` Deprecated.
`void`	`setSimpleSsl(com.marklogic.hub.DatabaseKind kind, java.lang.Boolean simpleSsl)` Sets if Simple SSL is to be used for the DatabaseKind in the config
`void`	`setSslContext(com.marklogic.hub.DatabaseKind kind, javax.net.ssl.SSLContext sslContext)` Sets the SSL Context for the DatabaseKind in the config
`void`	`setSslHostnameVerifier(com.marklogic.hub.DatabaseKind kind, com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier sslHostnameVerifier)` Sets the SSL Hostname Verifier object for the DatabaseKind in the config
`void`	`setStepDefinitionPermissions(java.lang.String stepDefinitionPermissions)`
`void`	`setTrustManager(com.marklogic.hub.DatabaseKind kind, javax.net.ssl.X509TrustManager trustManager)` Sets the Trust Manager for the DatabaseKind in the config
`java.lang.String`	`toString()`
`static HubConfigImpl`	`withDefaultProperties()` Deprecated.
`static HubConfigImpl`	`withProperties(java.util.Properties props)` Convenience method for instantiating a HubConfigImpl with its default property values and then overlaying the values specified in the given Properties object.
`HubConfig`	`withPropertiesFromEnvironment(java.lang.String environment)` It is not expected that a client would use this, as it would be partially re-inventing what the Gradle properties plugin does.

Methods inherited from class com.marklogic.hub.HubClientConfig
applyProperties, getDatabaseNames, getFinalAuthMethod, getFinalCertFile, getFinalCertPassword, getFinalDbName, getFinalExternalName, getFinalPort, getFinalSchemasDbName, getFinalSimpleSsl, getFinalSslContext, getFinalSslHostnameVerifier, getFinalTriggersDbName, getFinalTrustManager, getIsHostLoadBalancer, getJobAuthMethod, getJobCertFile, getJobCertPassword, getJobDbName, getJobExternalName, getJobPort, getJobSimpleSsl, getJobSslContext, getJobSslHostnameVerifier, getJobTrustManager, getModulePermissions, getModulesDbName, getPassword, getPropertyConsumerMap, getStagingAuthMethod, getStagingCertFile, getStagingCertPassword, getStagingDbName, getStagingExternalName, getStagingPort, getStagingSchemasDbName, getStagingSimpleSsl, getStagingSslContext, getStagingSslHostnameVerifier, getStagingTriggersDbName, getStagingTrustManager, getUsername, newFinalClient, newJobDbClient, newModulesDbClient, newStagingClient, registerLowerCasedPropertyConsumers, setConfiguredDatabaseClientFactory, setFinalAuthMethod, setFinalCertFile, setFinalCertPassword, setFinalDbName, setFinalExternalName, setFinalPort, setFinalSchemasDbName, setFinalSimpleSsl, setFinalSslContext, setFinalSslHostnameVerifier, setFinalTriggersDbName, setFinalTrustManager, setIsHostLoadBalancer, setJobAuthMethod, setJobCertFile, setJobCertPassword, setJobDbName, setJobExternalName, setJobPort, setJobSimpleSsl, setJobSslContext, setJobSslHostnameVerifier, setJobTrustManager, setManageConfig, setModulePermissions, setModulesDbName, setPassword, setStagingAuthMethod, setStagingCertFile, setStagingCertPassword, setStagingDbName, setStagingExternalName, setStagingPort, setStagingSchemasDbName, setStagingSimpleSsl, setStagingSslContext, setStagingSslHostnameVerifier, setStagingTriggersDbName, setStagingTrustManager, setUsername

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.marklogic.hub.HubConfig
getIsHostLoadBalancer, getModulePermissions, getStagingTriggersDbName, newFinalClient, newJobDbClient, newModulesDbClient, newStagingClient

- Field Detail
  - stagingHttpName
```
protected java.lang.String stagingHttpName
```
  - stagingForestsPerHost
```
protected java.lang.Integer stagingForestsPerHost
```
  - finalHttpName
```
protected java.lang.String finalHttpName
```
  - finalForestsPerHost
```
protected java.lang.Integer finalForestsPerHost
```
  - jobHttpName
```
protected java.lang.String jobHttpName
```
  - jobForestsPerHost
```
protected java.lang.Integer jobForestsPerHost
```
  - modulesForestsPerHost
```
protected java.lang.Integer modulesForestsPerHost
```
  - stagingTriggersForestsPerHost
```
protected java.lang.Integer stagingTriggersForestsPerHost
```
  - finalTriggersForestsPerHost
```
protected java.lang.Integer finalTriggersForestsPerHost
```
  - stagingSchemasForestsPerHost
```
protected java.lang.Integer stagingSchemasForestsPerHost
```
  - finalSchemasForestsPerHost
```
protected java.lang.Integer finalSchemasForestsPerHost
```
  - customForestPath
```
protected java.lang.String customForestPath
```
- Constructor Detail
  - HubConfigImpl
```
public HubConfigImpl()
```
    Constructs a HubConfigImpl with a default set of property values.
  - HubConfigImpl
```
public HubConfigImpl(HubProject hubProject)
```
    Constructor for when using this object outside of a Spring container, but a HubProject is still needed.
    
    Parameters:
    
    hubProject -
  - HubConfigImpl
```
public HubConfigImpl(java.lang.String host,
                     java.lang.String mlUsername,
                     java.lang.String mlPassword)
```
    Provides a minimally-configured instance of HubConfigImpl based on DHF default properties, with no dependency on Spring or on project files.
    
    Parameters:
    
    host -
    
    mlUsername -
    
    mlPassword -
  - HubConfigImpl
```
public HubConfigImpl(java.lang.String host,
                     java.lang.String mlUsername,
                     java.lang.String mlPassword,
                     java.lang.String stagingDbName,
                     java.lang.String finalDbName)
```
    Provides a minimally-configured instance of HubConfigImpl based on DHF default properties, with no dependency on Spring or on project files.
    
    Parameters:
    
    host -
    
    mlUsername -
    
    mlPassword -
    
    stagingDbName -
    
    finalDbName -
- Method Detail
  - withDefaultProperties
```
@Deprecated
public static HubConfigImpl withDefaultProperties()
```
    Deprecated.
    
    As of 5.3.0, this is now equivalent to the default constructor, as the default constructor now applies the default property values that this method had been doing. So there's no need to call this; just use the default constructor.
    
    Returns:
  - withProperties
```
public static HubConfigImpl withProperties(java.util.Properties props)
```
    Convenience method for instantiating a HubConfigImpl with its default property values and then overlaying the values specified in the given Properties object. Note that because this calls applyProperties, the various *Config objects - e.g. AppConfig - will be instantiated. It is thus expected, though not required, that the given Properties object defines mlUsername and mlPassword. Also note that because a HubProject is not being provided via this method, any initialization logic pertaining to the existence of a project will not be applied.
    
    Parameters:
    
    props -
    
    Returns:
  - newAppServicesModulesClient
```
public com.marklogic.client.DatabaseClient newAppServicesModulesClient()
```
    Specified by:
    
    newAppServicesModulesClient in interface HubConfig
    
    Returns:
    
    a DatabaseClient that connects to the DHF modules database via the app server identified by mlAppServicesPort. The use case for this is when it's necessary to perform operations against the modules database, but it's not known whether one of the DHF app servers has been created.
  - applyProperties
```
public void applyProperties(java.util.Properties properties)
```
    Applies properties in the given properties to this instance. Will create new AppConfig, ManageConfig, and AdminConfig objects based on these properties.
    
    Overrides:
    
    applyProperties in class com.marklogic.hub.HubClientConfig
    
    Parameters:
    
    properties -
  - applyProperties
```
public void applyProperties(com.marklogic.mgmt.util.PropertySource propertySource)
```
    Applies properties in the given property source to this instance. Will create new AppConfig, ManageConfig, and AdminConfig objects based on these properties.
    
    Parameters:
    
    propertySource -
  - applyProperties
```
public void applyProperties(com.marklogic.mgmt.util.PropertySource propertySource,
                            com.marklogic.appdeployer.AppConfig appConfigToReuse,
                            com.marklogic.mgmt.ManageConfig manageConfigToReuse,
                            com.marklogic.mgmt.admin.AdminConfig adminConfigToReuse)
```
    Applies properties in the given property source to this instance. Reuses the *Config objects passed into it if they're not null. This is essential for the DH Gradle plugin, where these objects are created before the DH Gradle plugin calls this method, and they cannot be recreated, they can only be modified.
    
    Parameters:
    
    propertySource -
    
    appConfigToReuse -
    
    manageConfigToReuse -
    
    adminConfigToReuse -
  - getHubPropertiesFromDb
```
public java.util.Properties getHubPropertiesFromDb(com.marklogic.client.DatabaseClient client)
```
  - requireHubProject
```
protected HubProject requireHubProject()
```
  - createProject
```
public void createProject(java.lang.String projectDirString)
```
    Description copied from interface: HubConfig
    
    Initializes the java application state to a specific location. A properties file is expected to be found in this directory.
    
    Specified by:
    
    createProject in interface HubConfig
    
    Parameters:
    
    projectDirString - The directory in which to find properties for a project.
  - getHost
```
public java.lang.String getHost()
```
    Description copied from interface: HubConfig
    
    Gets the hostname of the AppConfig
    
    Specified by:
    
    getHost in interface HubConfig
    
    Overrides:
    
    getHost in class com.marklogic.hub.HubClientConfig
    
    Returns:
    
    name of host
  - getDbName
```
public java.lang.String getDbName(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the database name for the DatabaseKind set in the config
    
    Specified by:
    
    getDbName in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The name of the database
  - setDbName
```
public void setDbName(com.marklogic.hub.DatabaseKind kind,
                      java.lang.String dbName)
```
    Description copied from interface: HubConfig
    
    Sets the database name for the databaseKind on the hubconfig
    
    Specified by:
    
    setDbName in interface HubConfig
    
    dbName - The name desired for the database
  - getHttpName
```
public java.lang.String getHttpName(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the appserver name for the DatabaseKind set in the config
    
    Specified by:
    
    getHttpName in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The name of the App server
  - setHttpName
```
public void setHttpName(com.marklogic.hub.DatabaseKind kind,
                        java.lang.String httpName)
```
    Description copied from interface: HubConfig
    
    Sets the appserver name for the databaseKind on the hubconfig
    
    Specified by:
    
    setHttpName in interface HubConfig
    
    httpName - The name to set for the appserver
  - getForestsPerHost
```
public java.lang.Integer getForestsPerHost(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the number of forests per host for the DatabaseKind set in the config
    
    Specified by:
    
    getForestsPerHost in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The number of forests per host for this database
  - setForestsPerHost
```
public void setForestsPerHost(com.marklogic.hub.DatabaseKind kind,
                              java.lang.Integer forestsPerHost)
```
    Description copied from interface: HubConfig
    
    Sets the number of forests per host for the databaseKind on the hubconfig
    
    Specified by:
    
    setForestsPerHost in interface HubConfig
    
    forestsPerHost - The number of forests per host
  - getPort
```
public java.lang.Integer getPort(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the port number for the DatabaseKind set in the config
    
    Specified by:
    
    getPort in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The port set for the appserver connected to the database
  - setPort
```
public void setPort(com.marklogic.hub.DatabaseKind kind,
                    java.lang.Integer port)
```
    Description copied from interface: HubConfig
    
    Sets the port number for the databaseKind on the hubconfig
    
    Specified by:
    
    setPort in interface HubConfig
    
    port - The port number for the database appserver
  - getSslContext
```
public javax.net.ssl.SSLContext getSslContext(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the SSL Context for the DatabaseKind set in the config
    
    Specified by:
    
    getSslContext in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The SSLContext set for the database connection
  - setSslContext
```
public void setSslContext(com.marklogic.hub.DatabaseKind kind,
                          javax.net.ssl.SSLContext sslContext)
```
    Description copied from interface: HubConfig
    
    Sets the SSL Context for the DatabaseKind in the config
    
    Specified by:
    
    setSslContext in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    sslContext - - The SSLContext set for the database connection
  - getSslHostnameVerifier
```
public com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getSslHostnameVerifier(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the SSL hostname verifier object for the DatabaseKind in the hub config
    
    Specified by:
    
    getSslHostnameVerifier in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The SSL Hostname Verifier for the DatabaseKind in hubconfig
  - setSslHostnameVerifier
```
public void setSslHostnameVerifier(com.marklogic.hub.DatabaseKind kind,
                                   com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier sslHostnameVerifier)
```
    Description copied from interface: HubConfig
    
    Sets the SSL Hostname Verifier object for the DatabaseKind in the config
    
    Specified by:
    
    setSslHostnameVerifier in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    sslHostnameVerifier - - The SSL Hostname Verifier object for the database connection
  - getAuthMethod
```
public java.lang.String getAuthMethod(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the AuthMethod object for the DatabaseKind in the hub config
    
    Specified by:
    
    getAuthMethod in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The Auth Method for the DatabaseKind in hubconfig
  - setAuthMethod
```
public void setAuthMethod(com.marklogic.hub.DatabaseKind kind,
                          java.lang.String authMethod)
```
    Description copied from interface: HubConfig
    
    Sets the SSL Auth Method for the DatabaseKind in the config
    
    Specified by:
    
    setAuthMethod in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    authMethod - - The SSL Auth Method for the database connection
  - getTrustManager
```
public javax.net.ssl.X509TrustManager getTrustManager(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the TrustManager object for the DatabaseKind in the hub config
    
    Specified by:
    
    getTrustManager in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The TrustManager for the DatabaseKind in hubconfig
  - setTrustManager
```
public void setTrustManager(com.marklogic.hub.DatabaseKind kind,
                            javax.net.ssl.X509TrustManager trustManager)
```
    Description copied from interface: HubConfig
    
    Sets the Trust Manager for the DatabaseKind in the config
    
    Specified by:
    
    setTrustManager in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    trustManager - - The Trust Manager for the database connection
  - getScheme
```
@Deprecated
public java.lang.String getScheme(com.marklogic.hub.DatabaseKind kind)
```
    Deprecated.
    
    Description copied from interface: HubConfig
    
    Deprecated, as scheme was never usable when constructing a DatabaseClient.
    
    Specified by:
    
    getScheme in interface HubConfig
  - setScheme
```
@Deprecated
public void setScheme(com.marklogic.hub.DatabaseKind kind,
                                  java.lang.String scheme)
```
    Deprecated.
    
    Description copied from interface: HubConfig
    
    Deprecated, as scheme was never usable when constructing a DatabaseClient.
    
    Specified by:
    
    setScheme in interface HubConfig
  - getSimpleSsl
```
public boolean getSimpleSsl(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns if Simple SSL is set for the DatabaseKind in the hub config
    
    Specified by:
    
    getSimpleSsl in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    true if Simple SSL is set for the DatabaseKind in hubconfig
  - setSimpleSsl
```
public void setSimpleSsl(com.marklogic.hub.DatabaseKind kind,
                         java.lang.Boolean simpleSsl)
```
    Description copied from interface: HubConfig
    
    Sets if Simple SSL is to be used for the DatabaseKind in the config
    
    Specified by:
    
    setSimpleSsl in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
  - getCertFile
```
public java.lang.String getCertFile(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the SSL Cert file as a string for the DatabaseKind in the hub config
    
    Specified by:
    
    getCertFile in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The SSL Cert File as a string for the DatabaseKind in hubconfig
  - setCertFile
```
public void setCertFile(com.marklogic.hub.DatabaseKind kind,
                        java.lang.String certFile)
```
    Description copied from interface: HubConfig
    
    Sets the SSL Certfile to use for the DatabaseKind in the config
    
    Specified by:
    
    setCertFile in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    certFile - - The SSL Cert File as a string to be used for the database connection
  - getCertPassword
```
public java.lang.String getCertPassword(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the SSL Cert Password as a string for the DatabaseKind in the hub config
    
    Specified by:
    
    getCertPassword in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The SSL Cert Password for the DatabaseKind in hubconfig
  - setCertPass
```
public void setCertPass(com.marklogic.hub.DatabaseKind kind,
                        java.lang.String certPassword)
```
    Description copied from interface: HubConfig
    
    Sets the SSL Cert password for the DatabaseKind in the config
    
    Specified by:
    
    setCertPass in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    certPassword - - The SSL certificate password for the database connection
  - getExternalName
```
public java.lang.String getExternalName(com.marklogic.hub.DatabaseKind kind)
```
    Description copied from interface: HubConfig
    
    Returns the external name for the host for the DatabaseKind in the hub config
    
    Specified by:
    
    getExternalName in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The external name of the host for the DatabaseKind in hubconfig
  - setExternalName
```
public void setExternalName(com.marklogic.hub.DatabaseKind kind,
                            java.lang.String externalName)
```
    Description copied from interface: HubConfig
    
    Sets the external hostname for the DatabaseKind in the config
    
    Specified by:
    
    setExternalName in interface HubConfig
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
  - getFlowOperatorRoleName
```
public java.lang.String getFlowOperatorRoleName()
```
    Description copied from interface: HubConfig
    
    Get the roleName the hub uses
    
    Specified by:
    
    getFlowOperatorRoleName in interface HubConfig
    
    Returns:
    
    the name of the role the DHF uses
  - setFlowOperatorRoleName
```
public void setFlowOperatorRoleName(java.lang.String flowOperatorRoleName)
```
    Description copied from interface: HubConfig
    
    Set the role name that the hub uses
    
    Specified by:
    
    setFlowOperatorRoleName in interface HubConfig
    
    Parameters:
    
    flowOperatorRoleName - the name to use
  - getFlowDeveloperRoleName
```
public java.lang.String getFlowDeveloperRoleName()
```
    Description copied from interface: HubConfig
    
    Get the roleName the hub uses for developing flows
    
    Specified by:
    
    getFlowDeveloperRoleName in interface HubConfig
    
    Returns:
    
    the name of the role the DHF uses for developing flows
  - setFlowDeveloperRoleName
```
public void setFlowDeveloperRoleName(java.lang.String flowDeveloperRoleName)
```
    Description copied from interface: HubConfig
    
    Set the role name that the hub uses for developing flows
    
    Specified by:
    
    setFlowDeveloperRoleName in interface HubConfig
    
    Parameters:
    
    flowDeveloperRoleName - the name to use for developing flows
  - getMlUsername
```
public java.lang.String getMlUsername()
```
  - getMlPassword
```
public java.lang.String getMlPassword()
```
  - setHost
```
public void setHost(java.lang.String host)
```
    Overrides:
    
    setHost in class com.marklogic.hub.HubClientConfig
  - setMlUsername
```
public void setMlUsername(java.lang.String mlUsername)
```
  - setMlPassword
```
public void setMlPassword(java.lang.String mlPassword)
```
  - getIsProvisionedEnvironment
```
public java.lang.Boolean getIsProvisionedEnvironment()
```
    Description copied from interface: HubConfig
    
    Signifies if we are dealing with a provisioned environment.
    
    Specified by:
    
    getIsProvisionedEnvironment in interface HubConfig
    
    Returns:
    
    a Boolean.
  - setIsProvisionedEnvironment
```
public void setIsProvisionedEnvironment(boolean isProvisionedEnvironment)
```
    Specified by:
    
    setIsProvisionedEnvironment in interface HubConfig
  - getCustomForestPath
```
public java.lang.String getCustomForestPath()
```
    Description copied from interface: HubConfig
    
    Returns the path for the custom forests definition
    
    Specified by:
    
    getCustomForestPath in interface HubConfig
    
    Returns:
    
    path where the custom forests are as string
  - setCustomForestPath
```
public void setCustomForestPath(java.lang.String customForestPath)
```
  - getEntityModelPermissions
```
public java.lang.String getEntityModelPermissions()
```
    Description copied from interface: HubConfig
    
    Prior to 5.1.0, entities were assigned permissions returned by getModulePermissions. For 5.1.0 and later, this method should be used to know which permissions to assign to entity models.
    
    Specified by:
    
    getEntityModelPermissions in interface HubConfig
    
    Returns:
    
    a comma-delimited string of role1,capability1,role2,capability2 that defines the permissions to add to each entity model
  - getFlowPermissions
```
public java.lang.String getFlowPermissions()
```
    Description copied from interface: HubConfig
    
    Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions. For 5.2.0 and later, this method should be used to know which permissions to assign to flow document.
    
    Specified by:
    
    getFlowPermissions in interface HubConfig
    
    Returns:
    
    a comma-delimited string of role1,capability1,role2,capability2 that defines the permissions to add to each flow document
  - getMappingPermissions
```
public java.lang.String getMappingPermissions()
```
    Description copied from interface: HubConfig
    
    Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions. For 5.2.0 and later, this method should be used to know which permissions to assign to mapping document.
    
    Specified by:
    
    getMappingPermissions in interface HubConfig
    
    Returns:
    
    a comma-delimited string of role1,capability1,role2,capability2 that defines the permissions to add to each mapping document
  - getStepDefinitionPermissions
```
public java.lang.String getStepDefinitionPermissions()
```
    Description copied from interface: HubConfig
    
    Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions. For 5.2.0 and later, this method should be used to know which permissions to assign to step definition document.
    
    Specified by:
    
    getStepDefinitionPermissions in interface HubConfig
    
    Returns:
    
    a comma-delimited string of role1,capability1,role2,capability2 that defines the permissions to add to each step definition document
  - getJobPermissions
```
public java.lang.String getJobPermissions()
```
  - setJobPermissions
```
public void setJobPermissions(java.lang.String jobPermissions)
```
  - getProjectDir
```
@Deprecated
public java.lang.String getProjectDir()
```
    Deprecated.
    
    Description copied from interface: HubConfig
    
    Obtains the project directory as a string
    
    Specified by:
    
    getProjectDir in interface HubConfig
    
    Returns:
    
    project directory
  - setProjectDir
```
@Deprecated
public void setProjectDir(java.lang.String projectDir)
```
    Deprecated.
    
    Description copied from interface: HubConfig
    
    Sets the directory for the current project
    
    Specified by:
    
    setProjectDir in interface HubConfig
    
    Parameters:
    
    projectDir - - a string that represents the path to the project directory
  - setEntityModelPermissions
```
public void setEntityModelPermissions(java.lang.String entityModelPermissions)
```
  - setFlowPermissions
```
public void setFlowPermissions(java.lang.String flowPermissions)
```
  - setMappingPermissions
```
public void setMappingPermissions(java.lang.String mappingPermissions)
```
  - setStepDefinitionPermissions
```
public void setStepDefinitionPermissions(java.lang.String stepDefinitionPermissions)
```
  - getHubProject
```
public HubProject getHubProject()
```
    Description copied from interface: HubConfig
    
    Returns the HubProject associated with the HubConfig
    
    Specified by:
    
    getHubProject in interface HubConfig
    
    Returns:
    
    current hubProject associated with the HubConfig
  - setHubProject
```
public void setHubProject(HubProject hubProject)
```
  - initHubProject
```
public void initHubProject()
```
    Description copied from interface: HubConfig
    
    Initializes the hub project on disk
    
    Specified by:
    
    initHubProject in interface HubConfig
  - refreshProject
```
public void refreshProject()
```
    Description copied from interface: HubConfig
    
    Loads HubConfig object with values from gradle.properties (optionally overridden with gradle-(environment).properties). Once Spring creates HubConfig object and the project is initialized with HubConfig.createProject(String) you can use setter methods to change HubConfig properties and then call this method.
    
    Specified by:
    
    refreshProject in interface HubConfig
  - loadConfigurationFromProperties
```
public void loadConfigurationFromProperties(java.util.Properties userProperties,
                                            boolean loadGradleProperties)
```
    Use this when you need to apply properties, and you likely also want to load properties from Gradle files. As of 5.3.0, this is really only intended for use within QuickStart, which depends on getting properties from Gradle file. All other clients likely can just call applyProperties directly.
    
    Parameters:
    
    userProperties -
    
    loadGradleProperties -
  - getManageConfig
```
public com.marklogic.mgmt.ManageConfig getManageConfig()
```
    Overrides:
    
    getManageConfig in class com.marklogic.hub.HubClientConfig
  - getManageClient
```
public com.marklogic.mgmt.ManageClient getManageClient()
```
    Specified by:
    
    getManageClient in interface HubConfig
  - setManageClient
```
public void setManageClient(com.marklogic.mgmt.ManageClient manageClient)
```
  - getAdminConfig
```
public com.marklogic.mgmt.admin.AdminConfig getAdminConfig()
```
  - setAdminConfig
```
public void setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)
```
  - getAdminManager
```
public com.marklogic.mgmt.admin.AdminManager getAdminManager()
```
    Specified by:
    
    getAdminManager in interface HubConfig
  - setAdminManager
```
public void setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)
```
  - newAppServicesClient
```
public com.marklogic.client.DatabaseClient newAppServicesClient()
```
    Description copied from interface: HubConfig
    
    Creates a new DatabaseClient for accessing the AppServices app
    
    Specified by:
    
    newAppServicesClient in interface HubConfig
    
    Returns:
    
    - a DatabaseClient
  - newStagingClient
```
public com.marklogic.client.DatabaseClient newStagingClient()
```
    Description copied from interface: HubConfig
    
    Gets a new DatabaseClient that queries the staging database and appserver
    
    Specified by:
    
    newStagingClient in interface HubConfig
    
    Returns:
    
    A client that accesses the hub's staging appserver and staging database.
  - newReverseFlowClient
```
public com.marklogic.client.DatabaseClient newReverseFlowClient()
```
    Description copied from interface: HubConfig
    
    Gets a new DatabaseClient that queries the Final database using the staging appserver.
    
    Specified by:
    
    newReverseFlowClient in interface HubConfig
    
    Returns:
    
    A database client configured for fetching from final database, but using DHF's staging modules.
  - newFinalClient
```
public com.marklogic.client.DatabaseClient newFinalClient()
```
    Description copied from interface: HubConfig
    
    Gets a new DatabaseClient that queries the Final database and appserver
    
    Specified by:
    
    newFinalClient in interface HubConfig
    
    Returns:
    
    A client that accesses the hub's Final appserver and staging database.
  - newTraceDbClient
```
@Deprecated
public com.marklogic.client.DatabaseClient newTraceDbClient()
```
    Deprecated.
    
    Description copied from interface: HubConfig
    
    Use newJobDbClient instead. This function returns a client to the JOBS database.
    
    Specified by:
    
    newTraceDbClient in interface HubConfig
    
    Returns:
    
    - a DatabaseClient
  - getModulesDir
```
public java.nio.file.Path getModulesDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the modules directory
    
    Specified by:
    
    getModulesDir in interface HubConfig
    
    Returns:
    
    the path for the modules directory
  - getHubProjectDir
```
public java.nio.file.Path getHubProjectDir()
```
  - getHubPluginsDir
```
public java.nio.file.Path getHubPluginsDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the hub plugins directory
    
    Specified by:
    
    getHubPluginsDir in interface HubConfig
    
    Returns:
    
    the path for the hub plugins directory
  - getHubEntitiesDir
```
public java.nio.file.Path getHubEntitiesDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the hub entities directory
    
    Specified by:
    
    getHubEntitiesDir in interface HubConfig
    
    Returns:
    
    the path for the hub entities directory
  - getHubMappingsDir
```
public java.nio.file.Path getHubMappingsDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the hub mappings directory
    
    Specified by:
    
    getHubMappingsDir in interface HubConfig
    
    Returns:
    
    the path for the hub mappings directory
  - getStepDefinitionPath
```
public java.nio.file.Path getStepDefinitionPath(StepDefinition.StepDefinitionType type)
```
    Specified by:
    
    getStepDefinitionPath in interface HubConfig
  - getHubConfigDir
```
public java.nio.file.Path getHubConfigDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the hub's config directory
    
    Specified by:
    
    getHubConfigDir in interface HubConfig
    
    Returns:
    
    the path for the hub's config directory
  - getHubDatabaseDir
```
public java.nio.file.Path getHubDatabaseDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the hub's database directory
    
    Specified by:
    
    getHubDatabaseDir in interface HubConfig
    
    Returns:
    
    the path for the hub's database directory
  - getHubServersDir
```
public java.nio.file.Path getHubServersDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the hub servers directory
    
    Specified by:
    
    getHubServersDir in interface HubConfig
    
    Returns:
    
    the path for the hub servers database directory
  - getHubSecurityDir
```
public java.nio.file.Path getHubSecurityDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the hub's security directory
    
    Specified by:
    
    getHubSecurityDir in interface HubConfig
    
    Returns:
    
    the path for the hub's security directory
  - getUserSecurityDir
```
public java.nio.file.Path getUserSecurityDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the user security directory
    
    Specified by:
    
    getUserSecurityDir in interface HubConfig
    
    Returns:
    
    the path for the user security directory
  - getUserConfigDir
```
public java.nio.file.Path getUserConfigDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the user config directory
    
    Specified by:
    
    getUserConfigDir in interface HubConfig
    
    Returns:
    
    the path for the user config directory
  - getUserDatabaseDir
```
public java.nio.file.Path getUserDatabaseDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the user database directory
    
    Specified by:
    
    getUserDatabaseDir in interface HubConfig
    
    Returns:
    
    the path for the user database directory
  - getUserSchemasDir
```
public java.nio.file.Path getUserSchemasDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the user schemas directory
    
    Specified by:
    
    getUserSchemasDir in interface HubConfig
    
    Returns:
    
    the path for the user schemas directory
  - getEntityDatabaseDir
```
public java.nio.file.Path getEntityDatabaseDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the entity database directory
    
    Specified by:
    
    getEntityDatabaseDir in interface HubConfig
    
    Returns:
    
    the path for the entity's database directory
  - getFlowsDir
```
public java.nio.file.Path getFlowsDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the flows directory
    
    Specified by:
    
    getFlowsDir in interface HubConfig
    
    Returns:
    
    the path for the flows directory
  - getStepDefinitionsDir
```
public java.nio.file.Path getStepDefinitionsDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the step definitions directory
    
    Specified by:
    
    getStepDefinitionsDir in interface HubConfig
    
    Returns:
    
    the path for the step definitions directory
  - getUserServersDir
```
public java.nio.file.Path getUserServersDir()
```
    Description copied from interface: HubConfig
    
    Gets the path for the user servers directory
    
    Specified by:
    
    getUserServersDir in interface HubConfig
    
    Returns:
    
    the path for the user servers database directory
  - getAppConfig
```
public com.marklogic.appdeployer.AppConfig getAppConfig()
```
    Description copied from interface: HubConfig
    
    Returns the current AppConfig object attached to the HubConfig
    
    Specified by:
    
    getAppConfig in interface HubConfig
    
    Returns:
    
    Returns current AppConfig object set for HubConfig
  - setAppConfig
```
public void setAppConfig(com.marklogic.appdeployer.AppConfig config)
```
    Description copied from interface: HubConfig
    
    Sets the AppConfig for the current HubConfig
    
    Specified by:
    
    setAppConfig in interface HubConfig
    
    Parameters:
    
    config - AppConfig to associate with the HubConfig
  - setAppConfig
```
public void setAppConfig(com.marklogic.appdeployer.AppConfig config,
                         boolean skipUpdate)
```
    Description copied from interface: HubConfig
    
    Sets the AppConfig for the current HubConfig, with skipUpdate option
    
    Specified by:
    
    setAppConfig in interface HubConfig
    
    Parameters:
    
    config - - AppConfig to associate with the HubConfig
    
    skipUpdate - false to force update of AppConfig, true to skip it
  - getJarVersion
```
public java.lang.String getJarVersion()
```
    Description copied from interface: HubConfig
    
    Gets the current version of the DHF Jar
    
    Specified by:
    
    getJarVersion in interface HubConfig
    
    Returns:
    
    Version of DHF Jar file as string
  - getHubLogLevel
```
public java.lang.String getHubLogLevel()
```
    Description copied from interface: HubConfig
    
    Gets the current level of logging set for the data hub
    
    Specified by:
    
    getHubLogLevel in interface HubConfig
    
    Returns:
    
    Log level of the data hub config
  - addDhfPropertiesToCustomTokens
```
protected void addDhfPropertiesToCustomTokens(com.marklogic.appdeployer.AppConfig appConfig)
```
    Populates the custom tokens map in the given AppConfig object. For each field, if its value is set, then that value is stored in the custom tokens map. Else, an attempt is made to retrieve a value for the field from the Spring Environment. Thus, the expectation is that this class is used in a Spring context where a Spring Environment object is set.
    
    Parameters:
    
    appConfig -
  - initializeConfigDirs
```
protected void initializeConfigDirs(com.marklogic.appdeployer.AppConfig config)
```
    ml-app-deployer defaults to a single config path of src/main/ml-config. If that's still the only path present, it's overridden with the DHF defaults - src/main/hub-internal-config first, then src/main/ml-config second, with both of those being relative to the DHF project directory. But if the config paths have been customized - most likely via mlConfigPaths in gradle.properties - then this method just ensures that they're relative to the DHF project directory.
    
    Parameters:
    
    config - an AppConfig object
  - initializeModulePaths
```
protected void initializeModulePaths(com.marklogic.appdeployer.AppConfig config)
```
    Need to initialize every module path as being relative to the current project directory.
    
    Parameters:
    
    config - an AppConfig object
  - getInfo
```
public java.lang.String getInfo()
```
    Description copied from interface: HubConfig
    
    Gets information on a datahub configuration
    
    Specified by:
    
    getInfo in interface HubConfig
    
    Returns:
    
    information on the datahub configuration as a string
  - withPropertiesFromEnvironment
```
public HubConfig withPropertiesFromEnvironment(java.lang.String environment)
```
    It is not expected that a client would use this, as it would be partially re-inventing what the Gradle properties plugin does. But it is being preserved for backwards compatibility in case any clients prior to 4.1 were using HubConfigBuilder.withPropertiesFromEnvironment.
    
    Specified by:
    
    withPropertiesFromEnvironment in interface HubConfig
    
    Parameters:
    
    environment - a string name for environment
    
    Returns:
    
    a hubconfig object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - applyDefaultPropertyValues
```
public void applyDefaultPropertyValues()
```
    Applies values that, prior to 5.3.0, were stored in the dhf-defaults.properties file that was available from the classpath. Note that this only applies property values to "simple" properties of this class - it does not instantiate, but rather nulls out, the AppConfig, AdminConfig, ManageConfig, AdminManager, and ManageClient properties of this class. The expectation that is that applyProperties must be invoked in order for an instance of this class to be truly usable - in particular, so that a username/password can be provided so that connections can be made to various ML interfaces.
    
    Overrides:
    
    applyDefaultPropertyValues in class com.marklogic.hub.HubClientConfig
  - applyDefaultPermissionPropertyValues
```
public void applyDefaultPermissionPropertyValues()
```
    This is called by applyDefaultPropertyValues, but is separate for testing purposes.
  - initializePropertyConsumerMap
```
protected void initializePropertyConsumerMap()
```
    Defines functions for consuming properties from a PropertySource. This differs substantially from loadConfigurationFromProperties, as that function's behavior depends on whether a field has a value or not.
    
    Overrides:
    
    initializePropertyConsumerMap in class com.marklogic.hub.HubClientConfig
  - configureForDhs
```
public void configureForDhs()
```
    Overrides:
    
    configureForDhs in class com.marklogic.hub.HubClientConfig
  - enableSimpleSsl
```
public void enableSimpleSsl()
```
    Overrides:
    
    enableSimpleSsl in class com.marklogic.hub.HubClientConfig
  - disableSimpleSsl
```
public void disableSimpleSsl()
```
    Overrides:
    
    disableSimpleSsl in class com.marklogic.hub.HubClientConfig
  - newHubClient
```
public com.marklogic.hub.HubClient newHubClient()
```
    Specified by:
    
    newHubClient in interface HubConfig
    
    Returns:

Class HubConfigImpl

Field Summary

Fields inherited from interface com.marklogic.hub.HubConfig

Constructor Summary

Method Summary

Methods inherited from class com.marklogic.hub.HubClientConfig

Methods inherited from class java.lang.Object

Methods inherited from interface com.marklogic.hub.HubConfig

Field Detail

stagingHttpName

stagingForestsPerHost

finalHttpName

finalForestsPerHost

jobHttpName

jobForestsPerHost

modulesForestsPerHost

stagingTriggersForestsPerHost

finalTriggersForestsPerHost

stagingSchemasForestsPerHost

finalSchemasForestsPerHost

customForestPath

Constructor Detail

HubConfigImpl

HubConfigImpl

HubConfigImpl

HubConfigImpl

Method Detail

withDefaultProperties

withProperties

newAppServicesModulesClient

applyProperties

applyProperties

applyProperties

getHubPropertiesFromDb

requireHubProject

createProject

getHost

getDbName

setDbName

getHttpName

setHttpName

getForestsPerHost

setForestsPerHost

getPort

setPort

getSslContext

setSslContext

getSslHostnameVerifier

setSslHostnameVerifier

getAuthMethod

setAuthMethod

getTrustManager

setTrustManager

getScheme

setScheme

getSimpleSsl

setSimpleSsl

getCertFile

setCertFile

getCertPassword

setCertPass

getExternalName

setExternalName

getFlowOperatorRoleName

setFlowOperatorRoleName

getFlowDeveloperRoleName

setFlowDeveloperRoleName

getMlUsername

getMlPassword

setHost

setMlUsername

setMlPassword

getIsProvisionedEnvironment

setIsProvisionedEnvironment

getCustomForestPath

setCustomForestPath

getEntityModelPermissions

getFlowPermissions

getMappingPermissions

getStepDefinitionPermissions