HubConfig (marklogic-data-hub 5.2.6 API)

All Known Implementing Classes:

HubConfigImpl
```
public interface HubConfig
```
An interface to set, manage and recall the Data Hub's Configuration. HubConfig has a singleton scope so set everything you want at the start of the application and and then call refreshProject() to wire up all clients and load the properties from gradle.properties (optionally overridden with gradle-{env}.properties).

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_AUTH_METHOD`
`static java.lang.String`	`DEFAULT_CUSTOM_FOREST_PATH`
`static java.lang.String`	`DEFAULT_DEVELOPER_ROLE_NAME`
`static java.lang.String`	`DEFAULT_DEVELOPER_USER_NAME`
`static java.lang.String`	`DEFAULT_FINAL_NAME`
`static java.lang.Integer`	`DEFAULT_FINAL_PORT`
`static java.lang.String`	`DEFAULT_FINAL_SCHEMAS_DB_NAME`
`static java.lang.String`	`DEFAULT_FINAL_TRIGGERS_DB_NAME`
`static java.lang.Integer`	`DEFAULT_FORESTS_PER_HOST`
`static java.lang.String`	`DEFAULT_HUB_LOG_LEVEL`
`static java.lang.String`	`DEFAULT_JOB_NAME`
`static java.lang.Integer`	`DEFAULT_JOB_PORT`
`static java.lang.String`	`DEFAULT_MODULES_DB_NAME`
`static java.lang.String`	`DEFAULT_ROLE_NAME`
`static java.lang.String`	`DEFAULT_SCHEME`
`static java.lang.String`	`DEFAULT_STAGING_NAME`
`static java.lang.Integer`	`DEFAULT_STAGING_PORT`
`static java.lang.String`	`DEFAULT_STAGING_SCHEMAS_DB_NAME`
`static java.lang.String`	`DEFAULT_STAGING_TRIGGERS_DB_NAME`
`static java.lang.String`	`DEFAULT_USER_NAME`
`static java.lang.String`	`ENTITY_CONFIG_DIR`
`static java.lang.String`	`EXP_FINAL_ENTITY_QUERY_OPTIONS_FILE`
`static java.lang.String`	`EXP_STAGING_ENTITY_QUERY_OPTIONS_FILE`
`static java.lang.String`	`FINAL_ENTITY_DATABASE_FILE`
`static java.lang.String`	`FINAL_ENTITY_QUERY_OPTIONS_FILE`
`static java.lang.String`	`HUB_CONFIG_DIR`
`static java.lang.String`	`HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES`
`static java.lang.String`	`PATH_PREFIX`
`static java.lang.String`	`PII_PROTECTED_PATHS_FILE`
`static java.lang.String`	`PII_QUERY_ROLESET_FILE`
`static java.lang.String`	`STAGING_ENTITY_DATABASE_FILE`
`static java.lang.String`	`STAGING_ENTITY_QUERY_OPTIONS_FILE`
`static java.lang.String`	`USER_CONFIG_DIR`
`static java.lang.String`	`USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES`
`static java.lang.String`	`USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`createProject(java.lang.String projectDirString)` Initializes the java application state to a specific location.
`com.marklogic.appdeployer.AppConfig`	`getAppConfig()` Returns the current AppConfig object attached to the HubConfig
`java.lang.String`	`getAuthMethod(DatabaseKind kind)` Returns the AuthMethod object for the DatabaseKind in the hub config
`java.lang.String`	`getCertFile(DatabaseKind kind)` Returns the SSL Cert file as a string for the DatabaseKind in the hub config
`java.lang.String`	`getCertPassword(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(DatabaseKind kind)` Returns the database name for the DatabaseKind set in the config
`java.lang.String`	`getDHFVersion()` Gets the current version of the project properties file is targeting
`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(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`	`getFlowDeveloperUserName()` Get the current marklogic user name the hub uses to develop flows
`java.lang.String`	`getFlowOperatorRoleName()` Get the roleName the hub uses
`java.lang.String`	`getFlowOperatorUserName()` Get the current marklogic user name 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(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(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.lang.String`	`getHubModulesDeployTimestampFile()` Returns the last deployed timestamp file for the hub config and modules
`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`	`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`	`getIsHostLoadBalancer()` Signifies if the host is a load balancer host.
`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`	`getLoadBalancerHost()` Gets a string of load balancer host
`java.lang.String`	`getMappingPermissions()` Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions.
`java.lang.String`	`getModulePermissions()` Gets the permissions used to execute a module in string form
`java.nio.file.Path`	`getModulesDir()` Gets the path for the modules directory
`java.lang.Integer`	`getPort(DatabaseKind kind)` Returns the port number for the DatabaseKind set in the config
`java.lang.String`	`getProjectDir()` Obtains the project directory as a string
`java.lang.String`	`getScheme(DatabaseKind kind)` Deprecated.
`boolean`	`getSimpleSsl(DatabaseKind kind)` Returns if Simple SSL is set for the DatabaseKind in the hub config
`javax.net.ssl.SSLContext`	`getSslContext(DatabaseKind kind)` Returns the SSL Context for the DatabaseKind set in the config
`com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier`	`getSslHostnameVerifier(DatabaseKind kind)` Returns the SSL hostname verifier object for the DatabaseKind in the hub config
`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
`java.nio.file.Path`	`getStepsDirByType(StepDefinition.StepDefinitionType type)`
`javax.net.ssl.X509TrustManager`	`getTrustManager(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.lang.String`	`getUserModulesDeployTimestampFile()` Returns the last deployed timestamp file for the user modules
`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
`com.marklogic.client.DatabaseClient`	`newAppServicesClient()` Creates a new DatabaseClient for accessing the AppServices app
`com.marklogic.client.DatabaseClient`	`newFinalClient()` Gets a new DatabaseClient that queries the Final database using the final appserver.
`com.marklogic.client.DatabaseClient`	`newJobDbClient()` Creates a new DatabaseClient for accessing the Job database
`com.marklogic.client.DatabaseClient`	`newModulesDbClient()` Creates a new DatabaseClient for accessing the Hub Modules database
`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`	`newStagingClient(java.lang.String dbName)` 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).
`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(DatabaseKind kind, java.lang.String authMethod)` Sets the SSL Auth Method for the DatabaseKind in the config
`void`	`setCertFile(DatabaseKind kind, java.lang.String certFile)` Sets the SSL Certfile to use for the DatabaseKind in the config
`void`	`setCertPass(DatabaseKind kind, java.lang.String certPassword)` Sets the SSL Cert password for the DatabaseKind in the config
`void`	`setDbName(DatabaseKind kind, java.lang.String dbName)` Sets the database name for the databaseKind on the hubconfig
`void`	`setExternalName(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`	`setFlowDeveloperUserName(java.lang.String flowDeveloperUserName)` Sets the username for the hub to use in MarkLogic for developing flows
`void`	`setFlowOperatorRoleName(java.lang.String flowOperatorRoleName)` Set the role name that the hub uses
`void`	`setFlowOperatorUserName(java.lang.String flowOperatorUserName)` Sets the username for the hub to use in MarkLogic
`void`	`setForestsPerHost(DatabaseKind kind, java.lang.Integer forestsPerHost)` Sets the number of forests per host for the databaseKind on the hubconfig
`void`	`setHttpName(DatabaseKind kind, java.lang.String httpName)` Sets the appserver name for the databaseKind on the hubconfig
`void`	`setIsProvisionedEnvironment(boolean isProvisionedEnvironment)`
`void`	`setPort(DatabaseKind kind, java.lang.Integer port)` Sets the port number for the databaseKind on the hubconfig
`void`	`setProjectDir(java.lang.String projectDir)` Sets the directory for the current project
`void`	`setScheme(DatabaseKind kind, java.lang.String scheme)` Deprecated.
`void`	`setSimpleSsl(DatabaseKind kind, java.lang.Boolean simpleSsl)` Sets if Simple SSL is to be used for the DatabaseKind in the config
`void`	`setSslContext(DatabaseKind kind, javax.net.ssl.SSLContext sslContext)` Sets the SSL Context for the DatabaseKind in the config
`void`	`setSslHostnameVerifier(DatabaseKind kind, com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier)` Sets the SSL Hostname Verifier object for the DatabaseKind in the config
`void`	`setTrustManager(DatabaseKind kind, javax.net.ssl.X509TrustManager trustManager)` Sets the Trust Manager for the DatabaseKind in the config
`HubConfig`	`withPropertiesFromEnvironment(java.lang.String environment)` In a non-Gradle environment, a client can use this to load properties from a "gradle-(environment).properties" file, similar to how the Gradle properties plugin would process such a file in a Gradle context.

- Field Detail
  - HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
```
static final java.lang.String HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
```
static final java.lang.String USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES
```
static final java.lang.String USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - PATH_PREFIX
```
static final java.lang.String PATH_PREFIX
```
    See Also:
    
    Constant Field Values
  - HUB_CONFIG_DIR
```
static final java.lang.String HUB_CONFIG_DIR
```
    See Also:
    
    Constant Field Values
  - USER_CONFIG_DIR
```
static final java.lang.String USER_CONFIG_DIR
```
    See Also:
    
    Constant Field Values
  - ENTITY_CONFIG_DIR
```
static final java.lang.String ENTITY_CONFIG_DIR
```
    See Also:
    
    Constant Field Values
  - STAGING_ENTITY_QUERY_OPTIONS_FILE
```
static final java.lang.String STAGING_ENTITY_QUERY_OPTIONS_FILE
```
    See Also:
    
    Constant Field Values
  - FINAL_ENTITY_QUERY_OPTIONS_FILE
```
static final java.lang.String FINAL_ENTITY_QUERY_OPTIONS_FILE
```
    See Also:
    
    Constant Field Values
  - EXP_STAGING_ENTITY_QUERY_OPTIONS_FILE
```
static final java.lang.String EXP_STAGING_ENTITY_QUERY_OPTIONS_FILE
```
    See Also:
    
    Constant Field Values
  - EXP_FINAL_ENTITY_QUERY_OPTIONS_FILE
```
static final java.lang.String EXP_FINAL_ENTITY_QUERY_OPTIONS_FILE
```
    See Also:
    
    Constant Field Values
  - STAGING_ENTITY_DATABASE_FILE
```
static final java.lang.String STAGING_ENTITY_DATABASE_FILE
```
    See Also:
    
    Constant Field Values
  - FINAL_ENTITY_DATABASE_FILE
```
static final java.lang.String FINAL_ENTITY_DATABASE_FILE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STAGING_NAME
```
static final java.lang.String DEFAULT_STAGING_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FINAL_NAME
```
static final java.lang.String DEFAULT_FINAL_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_JOB_NAME
```
static final java.lang.String DEFAULT_JOB_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MODULES_DB_NAME
```
static final java.lang.String DEFAULT_MODULES_DB_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STAGING_TRIGGERS_DB_NAME
```
static final java.lang.String DEFAULT_STAGING_TRIGGERS_DB_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FINAL_TRIGGERS_DB_NAME
```
static final java.lang.String DEFAULT_FINAL_TRIGGERS_DB_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STAGING_SCHEMAS_DB_NAME
```
static final java.lang.String DEFAULT_STAGING_SCHEMAS_DB_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FINAL_SCHEMAS_DB_NAME
```
static final java.lang.String DEFAULT_FINAL_SCHEMAS_DB_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ROLE_NAME
```
static final java.lang.String DEFAULT_ROLE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_USER_NAME
```
static final java.lang.String DEFAULT_USER_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEVELOPER_ROLE_NAME
```
static final java.lang.String DEFAULT_DEVELOPER_ROLE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEVELOPER_USER_NAME
```
static final java.lang.String DEFAULT_DEVELOPER_USER_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STAGING_PORT
```
static final java.lang.Integer DEFAULT_STAGING_PORT
```
  - DEFAULT_FINAL_PORT
```
static final java.lang.Integer DEFAULT_FINAL_PORT
```
  - DEFAULT_JOB_PORT
```
static final java.lang.Integer DEFAULT_JOB_PORT
```
  - DEFAULT_AUTH_METHOD
```
static final java.lang.String DEFAULT_AUTH_METHOD
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HUB_LOG_LEVEL
```
static final java.lang.String DEFAULT_HUB_LOG_LEVEL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SCHEME
```
static final java.lang.String DEFAULT_SCHEME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FORESTS_PER_HOST
```
static final java.lang.Integer DEFAULT_FORESTS_PER_HOST
```
  - DEFAULT_CUSTOM_FOREST_PATH
```
static final java.lang.String DEFAULT_CUSTOM_FOREST_PATH
```
    See Also:
    
    Constant Field Values
  - PII_QUERY_ROLESET_FILE
```
static final java.lang.String PII_QUERY_ROLESET_FILE
```
    See Also:
    
    Constant Field Values
  - PII_PROTECTED_PATHS_FILE
```
static final java.lang.String PII_PROTECTED_PATHS_FILE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getHost
```
java.lang.String getHost()
```
    Gets the hostname of the AppConfig
    
    Returns:
    
    name of host
  - getDbName
```
java.lang.String getDbName(DatabaseKind kind)
```
    Returns the database name for the DatabaseKind set in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The name of the database
  - setDbName
```
void setDbName(DatabaseKind kind,
               java.lang.String dbName)
```
    Sets the database name for the databaseKind on the hubconfig
    
    Parameters:
    
    kind- - DatabaseKind enum, eg: STAGING or JOB
    
    dbName - The name desired for the database
  - getHttpName
```
java.lang.String getHttpName(DatabaseKind kind)
```
    Returns the appserver name for the DatabaseKind set in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The name of the App server
  - setHttpName
```
void setHttpName(DatabaseKind kind,
                 java.lang.String httpName)
```
    Sets the appserver name for the databaseKind on the hubconfig
    
    Parameters:
    
    kind- - DatabaseKind enum, eg: STAGING or JOB
    
    httpName - The name to set for the appserver
  - getForestsPerHost
```
java.lang.Integer getForestsPerHost(DatabaseKind kind)
```
    Returns the number of forests per host for the DatabaseKind set in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The number of forests per host for this database
  - setForestsPerHost
```
void setForestsPerHost(DatabaseKind kind,
                       java.lang.Integer forestsPerHost)
```
    Sets the number of forests per host for the databaseKind on the hubconfig
    
    Parameters:
    
    kind- - DatabaseKind enum, eg: STAGING or JOB
    
    forestsPerHost - The number of forests per host
  - getPort
```
java.lang.Integer getPort(DatabaseKind kind)
```
    Returns the port number for the DatabaseKind set in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The port set for the appserver connected to the database
  - setPort
```
void setPort(DatabaseKind kind,
             java.lang.Integer port)
```
    Sets the port number for the databaseKind on the hubconfig
    
    Parameters:
    
    kind- - DatabaseKind enum, eg: STAGING or JOB
    
    port - The port number for the database appserver
  - getSslContext
```
javax.net.ssl.SSLContext getSslContext(DatabaseKind kind)
```
    Returns the SSL Context for the DatabaseKind set in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The SSLContext set for the database connection
  - setSslContext
```
void setSslContext(DatabaseKind kind,
                   javax.net.ssl.SSLContext sslContext)
```
    Sets the SSL Context for the DatabaseKind in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    sslContext - - The SSLContext set for the database connection
  - setSslHostnameVerifier
```
void setSslHostnameVerifier(DatabaseKind kind,
                            com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier)
```
    Sets the SSL Hostname Verifier object for the DatabaseKind in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    stagingSslHostnameVerifier - - The SSL Hostname Verifier object for the database connection
  - getSslHostnameVerifier
```
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getSslHostnameVerifier(DatabaseKind kind)
```
    Returns the SSL hostname verifier object for the DatabaseKind in the hub config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The SSL Hostname Verifier for the DatabaseKind in hubconfig
  - getAuthMethod
```
java.lang.String getAuthMethod(DatabaseKind kind)
```
    Returns the AuthMethod object for the DatabaseKind in the hub config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The Auth Method for the DatabaseKind in hubconfig
  - setAuthMethod
```
void setAuthMethod(DatabaseKind kind,
                   java.lang.String authMethod)
```
    Sets the SSL Auth Method for the DatabaseKind in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    authMethod - - The SSL Auth Method for the database connection
  - getTrustManager
```
javax.net.ssl.X509TrustManager getTrustManager(DatabaseKind kind)
```
    Returns the TrustManager object for the DatabaseKind in the hub config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The TrustManager for the DatabaseKind in hubconfig
  - setTrustManager
```
void setTrustManager(DatabaseKind kind,
                     javax.net.ssl.X509TrustManager trustManager)
```
    Sets the Trust Manager for the DatabaseKind in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    trustManager - - The Trust Manager for the database connection
  - getScheme
```
@Deprecated
java.lang.String getScheme(DatabaseKind kind)
```
    Deprecated.
    
    Deprecated, as scheme was never usable when constructing a DatabaseClient.
  - setScheme
```
@Deprecated
void setScheme(DatabaseKind kind,
                           java.lang.String scheme)
```
    Deprecated.
    
    Deprecated, as scheme was never usable when constructing a DatabaseClient.
  - getSimpleSsl
```
boolean getSimpleSsl(DatabaseKind kind)
```
    Returns if Simple SSL is set for the DatabaseKind in the hub config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    true if Simple SSL is set for the DatabaseKind in hubconfig
  - setSimpleSsl
```
void setSimpleSsl(DatabaseKind kind,
                  java.lang.Boolean simpleSsl)
```
    Sets if Simple SSL is to be used for the DatabaseKind in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    simpleSsl- - true if you want to use Simple SSL, false if you don't
  - getCertFile
```
java.lang.String getCertFile(DatabaseKind kind)
```
    Returns the SSL Cert file as a string for the DatabaseKind in the hub config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The SSL Cert File as a string for the DatabaseKind in hubconfig
  - setCertFile
```
void setCertFile(DatabaseKind kind,
                 java.lang.String certFile)
```
    Sets the SSL Certfile to use for the DatabaseKind in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    certFile - - The SSL Cert File as a string to be used for the database connection
  - getCertPassword
```
java.lang.String getCertPassword(DatabaseKind kind)
```
    Returns the SSL Cert Password as a string for the DatabaseKind in the hub config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The SSL Cert Password for the DatabaseKind in hubconfig
  - setCertPass
```
void setCertPass(DatabaseKind kind,
                 java.lang.String certPassword)
```
    Sets the SSL Cert password for the DatabaseKind in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    certPassword - - The SSL certificate password for the database connection
  - getExternalName
```
java.lang.String getExternalName(DatabaseKind kind)
```
    Returns the external name for the host for the DatabaseKind in the hub config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    Returns:
    
    The external name of the host for the DatabaseKind in hubconfig
  - setExternalName
```
void setExternalName(DatabaseKind kind,
                     java.lang.String externalName)
```
    Sets the external hostname for the DatabaseKind in the config
    
    Parameters:
    
    kind - - DatabaseKind enum, eg: STAGING or JOB
    
    externalName- - The external host name for the database connection
  - getFlowOperatorRoleName
```
java.lang.String getFlowOperatorRoleName()
```
    Get the roleName the hub uses
    
    Returns:
    
    the name of the role the DHF uses
  - setFlowOperatorRoleName
```
void setFlowOperatorRoleName(java.lang.String flowOperatorRoleName)
```
    Set the role name that the hub uses
    
    Parameters:
    
    flowOperatorRoleName - the name to use
  - getFlowOperatorUserName
```
java.lang.String getFlowOperatorUserName()
```
    Get the current marklogic user name the hub uses
    
    Returns:
    
    the username
  - setFlowOperatorUserName
```
void setFlowOperatorUserName(java.lang.String flowOperatorUserName)
```
    Sets the username for the hub to use in MarkLogic
    
    Parameters:
    
    flowOperatorUserName - - username to use
  - getFlowDeveloperRoleName
```
java.lang.String getFlowDeveloperRoleName()
```
    Get the roleName the hub uses for developing flows
    
    Returns:
    
    the name of the role the DHF uses for developing flows
  - setFlowDeveloperRoleName
```
void setFlowDeveloperRoleName(java.lang.String flowDeveloperRoleName)
```
    Set the role name that the hub uses for developing flows
    
    Parameters:
    
    flowDeveloperRoleName - the name to use for developing flows
  - getFlowDeveloperUserName
```
java.lang.String getFlowDeveloperUserName()
```
    Get the current marklogic user name the hub uses to develop flows
    
    Returns:
    
    the username
  - setFlowDeveloperUserName
```
void setFlowDeveloperUserName(java.lang.String flowDeveloperUserName)
```
    Sets the username for the hub to use in MarkLogic for developing flows
    
    Parameters:
    
    flowDeveloperUserName - - username to use
  - getLoadBalancerHost
```
java.lang.String getLoadBalancerHost()
```
    Gets a string of load balancer host
    
    Returns:
    
    String of load balancer host
  - getIsHostLoadBalancer
```
java.lang.Boolean getIsHostLoadBalancer()
```
    Signifies if the host is a load balancer host.
    
    Returns:
    
    a Boolean.
  - getIsProvisionedEnvironment
```
java.lang.Boolean getIsProvisionedEnvironment()
```
    Signifies if we are dealing with a provisioned environment.
    
    Returns:
    
    a Boolean.
  - setIsProvisionedEnvironment
```
void setIsProvisionedEnvironment(boolean isProvisionedEnvironment)
```
  - getCustomForestPath
```
java.lang.String getCustomForestPath()
```
    Returns the path for the custom forests definition
    
    Returns:
    
    path where the custom forests are as string
  - getModulePermissions
```
java.lang.String getModulePermissions()
```
    Gets the permissions used to execute a module in string form
    
    Returns:
    
    a comma-delimited string of role1,capability1,role2,capability2 that defines the permissions to add to each module
  - getEntityModelPermissions
```
java.lang.String getEntityModelPermissions()
```
    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.
    
    Returns:
    
    a comma-delimited string of role1,capability1,role2,capability2 that defines the permissions to add to each entity model
  - getFlowPermissions
```
java.lang.String getFlowPermissions()
```
    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.
    
    Returns:
    
    a comma-delimited string of role1,capability1,role2,capability2 that defines the permissions to add to each flow document
  - getMappingPermissions
```
java.lang.String getMappingPermissions()
```
    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.
    
    Returns:
    
    a comma-delimited string of role1,capability1,role2,capability2 that defines the permissions to add to each mapping document
  - getStepDefinitionPermissions
```
java.lang.String getStepDefinitionPermissions()
```
    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.
    
    Returns:
    
    a comma-delimited string of role1,capability1,role2,capability2 that defines the permissions to add to each step definition document
  - getProjectDir
```
java.lang.String getProjectDir()
```
    Obtains the project directory as a string
    
    Returns:
    
    project directory
  - setProjectDir
```
void setProjectDir(java.lang.String projectDir)
```
    Sets the directory for the current project
    
    Parameters:
    
    projectDir - - a string that represents the path to the project directory
  - getHubProject
```
HubProject getHubProject()
```
    Returns the HubProject associated with the HubConfig
    
    Returns:
    
    current hubProject associated with the HubConfig
  - initHubProject
```
void initHubProject()
```
    Initializes the hub project on disk
  - getHubModulesDeployTimestampFile
```
java.lang.String getHubModulesDeployTimestampFile()
```
    Returns the last deployed timestamp file for the hub config and modules
    
    Returns:
    
    string of what's located in the timestamp file
  - getUserModulesDeployTimestampFile
```
java.lang.String getUserModulesDeployTimestampFile()
```
    Returns the last deployed timestamp file for the user modules
    
    Returns:
    
    string of what's located in the timestamp file
  - newAppServicesClient
```
com.marklogic.client.DatabaseClient newAppServicesClient()
```
    Creates a new DatabaseClient for accessing the AppServices app
    
    Returns:
    
    - a DatabaseClient
  - newJobDbClient
```
com.marklogic.client.DatabaseClient newJobDbClient()
```
    Creates a new DatabaseClient for accessing the Job database
    
    Returns:
    
    - a DatabaseClient
  - newTraceDbClient
```
@Deprecated
com.marklogic.client.DatabaseClient newTraceDbClient()
```
    Deprecated.
    
    Use newJobDbClient instead. This function returns a client to the JOBS database.
    
    Returns:
    
    - a DatabaseClient
  - newModulesDbClient
```
com.marklogic.client.DatabaseClient newModulesDbClient()
```
    Creates a new DatabaseClient for accessing the Hub Modules database
    
    Returns:
    
    - a DatabaseClient
  - getModulesDir
```
java.nio.file.Path getModulesDir()
```
    Gets the path for the modules directory
    
    Returns:
    
    the path for the modules directory
  - getHubPluginsDir
```
java.nio.file.Path getHubPluginsDir()
```
    Gets the path for the hub plugins directory
    
    Returns:
    
    the path for the hub plugins directory
  - getHubEntitiesDir
```
java.nio.file.Path getHubEntitiesDir()
```
    Gets the path for the hub entities directory
    
    Returns:
    
    the path for the hub entities directory
  - getHubMappingsDir
```
java.nio.file.Path getHubMappingsDir()
```
    Gets the path for the hub mappings directory
    
    Returns:
    
    the path for the hub mappings directory
  - getStepsDirByType
```
java.nio.file.Path getStepsDirByType(StepDefinition.StepDefinitionType type)
```
  - getHubConfigDir
```
java.nio.file.Path getHubConfigDir()
```
    Gets the path for the hub's config directory
    
    Returns:
    
    the path for the hub's config directory
  - getHubDatabaseDir
```
java.nio.file.Path getHubDatabaseDir()
```
    Gets the path for the hub's database directory
    
    Returns:
    
    the path for the hub's database directory
  - getHubServersDir
```
java.nio.file.Path getHubServersDir()
```
    Gets the path for the hub servers directory
    
    Returns:
    
    the path for the hub servers database directory
  - getHubSecurityDir
```
java.nio.file.Path getHubSecurityDir()
```
    Gets the path for the hub's security directory
    
    Returns:
    
    the path for the hub's security directory
  - getUserConfigDir
```
java.nio.file.Path getUserConfigDir()
```
    Gets the path for the user config directory
    
    Returns:
    
    the path for the user config directory
  - getUserSecurityDir
```
java.nio.file.Path getUserSecurityDir()
```
    Gets the path for the user security directory
    
    Returns:
    
    the path for the user security directory
  - getUserDatabaseDir
```
java.nio.file.Path getUserDatabaseDir()
```
    Gets the path for the user database directory
    
    Returns:
    
    the path for the user database directory
  - getUserSchemasDir
```
java.nio.file.Path getUserSchemasDir()
```
    Gets the path for the user schemas directory
    
    Returns:
    
    the path for the user schemas directory
  - getUserServersDir
```
java.nio.file.Path getUserServersDir()
```
    Gets the path for the user servers directory
    
    Returns:
    
    the path for the user servers database directory
  - getEntityDatabaseDir
```
java.nio.file.Path getEntityDatabaseDir()
```
    Gets the path for the entity database directory
    
    Returns:
    
    the path for the entity's database directory
  - getFlowsDir
```
java.nio.file.Path getFlowsDir()
```
    Gets the path for the flows directory
    
    Returns:
    
    the path for the flows directory
  - getStepDefinitionsDir
```
java.nio.file.Path getStepDefinitionsDir()
```
    Gets the path for the step definitions directory
    
    Returns:
    
    the path for the step definitions directory
  - getAppConfig
```
com.marklogic.appdeployer.AppConfig getAppConfig()
```
    Returns the current AppConfig object attached to the HubConfig
    
    Returns:
    
    Returns current AppConfig object set for HubConfig
  - setAppConfig
```
void setAppConfig(com.marklogic.appdeployer.AppConfig config)
```
    Sets the AppConfig for the current HubConfig
    
    Parameters:
    
    config - AppConfig to associate with the HubConfig
  - setAppConfig
```
void setAppConfig(com.marklogic.appdeployer.AppConfig config,
                  boolean skipUpdate)
```
    Sets the AppConfig for the current HubConfig, with skipUpdate option
    
    Parameters:
    
    config - - AppConfig to associate with the HubConfig
    
    skipUpdate - false to force update of AppConfig, true to skip it
  - getJarVersion
```
java.lang.String getJarVersion()
```
    Gets the current version of the DHF Jar
    
    Returns:
    
    Version of DHF Jar file as string
  - getDHFVersion
```
java.lang.String getDHFVersion()
```
    Gets the current version of the project properties file is targeting
    
    Returns:
    
    Version of DHF that the project properties file is targeting
  - getHubLogLevel
```
java.lang.String getHubLogLevel()
```
    Gets the current level of logging set for the data hub
    
    Returns:
    
    Log level of the data hub config
  - newStagingClient
```
com.marklogic.client.DatabaseClient newStagingClient()
```
    Gets a new DatabaseClient that queries the staging database and appserver
    
    Returns:
    
    A client that accesses the hub's staging appserver and staging database.
  - newStagingClient
```
com.marklogic.client.DatabaseClient newStagingClient(java.lang.String dbName)
```
    Gets a new DatabaseClient that queries the staging database and appserver
    
    Parameters:
    
    dbName - the name of the database
    
    Returns:
    
    A client that accesses the hub's staging appserver and the database passed as param.
  - newReverseFlowClient
```
com.marklogic.client.DatabaseClient newReverseFlowClient()
```
    Gets a new DatabaseClient that queries the Final database using the staging appserver.
    
    Returns:
    
    A database client configured for fetching from final database, but using DHF's staging modules.
  - newFinalClient
```
com.marklogic.client.DatabaseClient newFinalClient()
```
    Gets a new DatabaseClient that queries the Final database using the final appserver. and final modules database. (Future, will be same behavior as newReverseFlowClient when modules databases are merged.)
    
    Returns:
    
    A DatabaseClient
  - getInfo
```
java.lang.String getInfo()
```
    Gets information on a datahub configuration
    
    Returns:
    
    information on the datahub configuration as a string
  - createProject
```
void createProject(java.lang.String projectDirString)
```
    Initializes the java application state to a specific location. A properties file is expected to be found in this directory.
    
    Parameters:
    
    projectDirString - The directory in which to find properties for a project.
  - withPropertiesFromEnvironment
```
HubConfig withPropertiesFromEnvironment(java.lang.String environment)
```
    In a non-Gradle environment, a client can use this to load properties from a "gradle-(environment).properties" file, similar to how the Gradle properties plugin would process such a file in a Gradle context.
    
    Parameters:
    
    environment - - The name of the environment to use (local,dev,qa,prod,...)
    
    Returns:
    
    A HubConfig
  - refreshProject
```
void refreshProject()
```
    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 createProject(String) you can use setter methods to change HubConfig properties and then call this method.

Interface HubConfig

Field Summary

Method Summary

Field Detail

HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES

USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES

USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES

PATH_PREFIX

HUB_CONFIG_DIR

USER_CONFIG_DIR

ENTITY_CONFIG_DIR

STAGING_ENTITY_QUERY_OPTIONS_FILE

FINAL_ENTITY_QUERY_OPTIONS_FILE

EXP_STAGING_ENTITY_QUERY_OPTIONS_FILE

EXP_FINAL_ENTITY_QUERY_OPTIONS_FILE

STAGING_ENTITY_DATABASE_FILE

FINAL_ENTITY_DATABASE_FILE

DEFAULT_STAGING_NAME

DEFAULT_FINAL_NAME

DEFAULT_JOB_NAME

DEFAULT_MODULES_DB_NAME

DEFAULT_STAGING_TRIGGERS_DB_NAME

DEFAULT_FINAL_TRIGGERS_DB_NAME

DEFAULT_STAGING_SCHEMAS_DB_NAME

DEFAULT_FINAL_SCHEMAS_DB_NAME

DEFAULT_ROLE_NAME

DEFAULT_USER_NAME

DEFAULT_DEVELOPER_ROLE_NAME

DEFAULT_DEVELOPER_USER_NAME

DEFAULT_STAGING_PORT

DEFAULT_FINAL_PORT

DEFAULT_JOB_PORT

DEFAULT_AUTH_METHOD

DEFAULT_HUB_LOG_LEVEL

DEFAULT_SCHEME

DEFAULT_FORESTS_PER_HOST

DEFAULT_CUSTOM_FOREST_PATH

PII_QUERY_ROLESET_FILE

PII_PROTECTED_PATHS_FILE

Method Detail

getHost

getDbName

setDbName

getHttpName

setHttpName

getForestsPerHost

setForestsPerHost

getPort

setPort

getSslContext

setSslContext

setSslHostnameVerifier

getSslHostnameVerifier

getAuthMethod

setAuthMethod

getTrustManager

setTrustManager

getScheme

setScheme

getSimpleSsl

setSimpleSsl

getCertFile

setCertFile

getCertPassword

setCertPass

getExternalName

setExternalName

getFlowOperatorRoleName

setFlowOperatorRoleName

getFlowOperatorUserName

setFlowOperatorUserName

getFlowDeveloperRoleName

setFlowDeveloperRoleName

getFlowDeveloperUserName

setFlowDeveloperUserName

getLoadBalancerHost

getIsHostLoadBalancer

getIsProvisionedEnvironment

setIsProvisionedEnvironment

getCustomForestPath