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 |
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 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.
|
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.
|
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getIsHostLoadBalancer, getModulePermissions, getStagingTriggersDbName, newFinalClient, newJobDbClient, newModulesDbClient, newStagingClient
protected java.lang.String stagingHttpName
protected java.lang.Integer stagingForestsPerHost
protected java.lang.String finalHttpName
protected java.lang.Integer finalForestsPerHost
protected java.lang.String jobHttpName
protected java.lang.Integer jobForestsPerHost
protected java.lang.Integer modulesForestsPerHost
protected java.lang.Integer stagingTriggersForestsPerHost
protected java.lang.Integer finalTriggersForestsPerHost
protected java.lang.Integer stagingSchemasForestsPerHost
protected java.lang.Integer finalSchemasForestsPerHost
protected java.lang.String customForestPath
public HubConfigImpl()
public HubConfigImpl(HubProject hubProject)
hubProject
- public HubConfigImpl(java.lang.String host, java.lang.String mlUsername, java.lang.String mlPassword)
host
- mlUsername
- mlPassword
- public HubConfigImpl(java.lang.String host, java.lang.String mlUsername, java.lang.String mlPassword, java.lang.String stagingDbName, java.lang.String finalDbName)
host
- mlUsername
- mlPassword
- stagingDbName
- finalDbName
- @Deprecated public static HubConfigImpl withDefaultProperties()
public static HubConfigImpl withProperties(java.util.Properties props)
props
- public com.marklogic.client.DatabaseClient newAppServicesModulesClient()
newAppServicesModulesClient
in interface HubConfig
public void applyProperties(java.util.Properties properties)
applyProperties
in class com.marklogic.hub.HubClientConfig
properties
- public void applyProperties(com.marklogic.mgmt.util.PropertySource propertySource)
propertySource
- 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)
propertySource
- appConfigToReuse
- manageConfigToReuse
- adminConfigToReuse
- public java.util.Properties getHubPropertiesFromDb(com.marklogic.client.DatabaseClient client)
protected HubProject requireHubProject()
public void createProject(java.lang.String projectDirString)
HubConfig
createProject
in interface HubConfig
projectDirString
- The directory in which to find properties for a project.public java.lang.String getHost()
HubConfig
public java.lang.String getDbName(com.marklogic.hub.DatabaseKind kind)
HubConfig
public void setDbName(com.marklogic.hub.DatabaseKind kind, java.lang.String dbName)
HubConfig
public java.lang.String getHttpName(com.marklogic.hub.DatabaseKind kind)
HubConfig
getHttpName
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setHttpName(com.marklogic.hub.DatabaseKind kind, java.lang.String httpName)
HubConfig
setHttpName
in interface HubConfig
httpName
- The name to set for the appserverpublic java.lang.Integer getForestsPerHost(com.marklogic.hub.DatabaseKind kind)
HubConfig
getForestsPerHost
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setForestsPerHost(com.marklogic.hub.DatabaseKind kind, java.lang.Integer forestsPerHost)
HubConfig
setForestsPerHost
in interface HubConfig
forestsPerHost
- The number of forests per hostpublic java.lang.Integer getPort(com.marklogic.hub.DatabaseKind kind)
HubConfig
public void setPort(com.marklogic.hub.DatabaseKind kind, java.lang.Integer port)
HubConfig
public javax.net.ssl.SSLContext getSslContext(com.marklogic.hub.DatabaseKind kind)
HubConfig
getSslContext
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setSslContext(com.marklogic.hub.DatabaseKind kind, javax.net.ssl.SSLContext sslContext)
HubConfig
setSslContext
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBsslContext
- - The SSLContext set for the database connectionpublic com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getSslHostnameVerifier(com.marklogic.hub.DatabaseKind kind)
HubConfig
getSslHostnameVerifier
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setSslHostnameVerifier(com.marklogic.hub.DatabaseKind kind, com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier sslHostnameVerifier)
HubConfig
setSslHostnameVerifier
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBsslHostnameVerifier
- - The SSL Hostname Verifier object for the database connectionpublic java.lang.String getAuthMethod(com.marklogic.hub.DatabaseKind kind)
HubConfig
getAuthMethod
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setAuthMethod(com.marklogic.hub.DatabaseKind kind, java.lang.String authMethod)
HubConfig
setAuthMethod
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBauthMethod
- - The SSL Auth Method for the database connectionpublic javax.net.ssl.X509TrustManager getTrustManager(com.marklogic.hub.DatabaseKind kind)
HubConfig
getTrustManager
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setTrustManager(com.marklogic.hub.DatabaseKind kind, javax.net.ssl.X509TrustManager trustManager)
HubConfig
setTrustManager
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBtrustManager
- - The Trust Manager for the database connection@Deprecated public java.lang.String getScheme(com.marklogic.hub.DatabaseKind kind)
HubConfig
@Deprecated public void setScheme(com.marklogic.hub.DatabaseKind kind, java.lang.String scheme)
HubConfig
public boolean getSimpleSsl(com.marklogic.hub.DatabaseKind kind)
HubConfig
getSimpleSsl
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setSimpleSsl(com.marklogic.hub.DatabaseKind kind, java.lang.Boolean simpleSsl)
HubConfig
setSimpleSsl
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic java.lang.String getCertFile(com.marklogic.hub.DatabaseKind kind)
HubConfig
getCertFile
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setCertFile(com.marklogic.hub.DatabaseKind kind, java.lang.String certFile)
HubConfig
setCertFile
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBcertFile
- - The SSL Cert File as a string to be used for the database connectionpublic java.lang.String getCertPassword(com.marklogic.hub.DatabaseKind kind)
HubConfig
getCertPassword
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setCertPass(com.marklogic.hub.DatabaseKind kind, java.lang.String certPassword)
HubConfig
setCertPass
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBcertPassword
- - The SSL certificate password for the database connectionpublic java.lang.String getExternalName(com.marklogic.hub.DatabaseKind kind)
HubConfig
getExternalName
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setExternalName(com.marklogic.hub.DatabaseKind kind, java.lang.String externalName)
HubConfig
setExternalName
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic java.lang.String getFlowOperatorRoleName()
HubConfig
getFlowOperatorRoleName
in interface HubConfig
public void setFlowOperatorRoleName(java.lang.String flowOperatorRoleName)
HubConfig
setFlowOperatorRoleName
in interface HubConfig
flowOperatorRoleName
- the name to usepublic java.lang.String getFlowDeveloperRoleName()
HubConfig
getFlowDeveloperRoleName
in interface HubConfig
public void setFlowDeveloperRoleName(java.lang.String flowDeveloperRoleName)
HubConfig
setFlowDeveloperRoleName
in interface HubConfig
flowDeveloperRoleName
- the name to use for developing flowspublic java.lang.String getMlUsername()
public java.lang.String getMlPassword()
public void setHost(java.lang.String host)
setHost
in class com.marklogic.hub.HubClientConfig
public void setMlUsername(java.lang.String mlUsername)
public void setMlPassword(java.lang.String mlPassword)
public java.lang.Boolean getIsProvisionedEnvironment()
HubConfig
getIsProvisionedEnvironment
in interface HubConfig
public void setIsProvisionedEnvironment(boolean isProvisionedEnvironment)
setIsProvisionedEnvironment
in interface HubConfig
public java.lang.String getCustomForestPath()
HubConfig
getCustomForestPath
in interface HubConfig
public void setCustomForestPath(java.lang.String customForestPath)
public java.lang.String getEntityModelPermissions()
HubConfig
getEntityModelPermissions
in interface HubConfig
public java.lang.String getFlowPermissions()
HubConfig
getFlowPermissions
in interface HubConfig
public java.lang.String getMappingPermissions()
HubConfig
getMappingPermissions
in interface HubConfig
public java.lang.String getStepDefinitionPermissions()
HubConfig
getStepDefinitionPermissions
in interface HubConfig
public java.lang.String getJobPermissions()
public void setJobPermissions(java.lang.String jobPermissions)
@Deprecated public java.lang.String getProjectDir()
HubConfig
getProjectDir
in interface HubConfig
@Deprecated public void setProjectDir(java.lang.String projectDir)
HubConfig
setProjectDir
in interface HubConfig
projectDir
- - a string that represents the path to the project directorypublic void setEntityModelPermissions(java.lang.String entityModelPermissions)
public void setFlowPermissions(java.lang.String flowPermissions)
public void setMappingPermissions(java.lang.String mappingPermissions)
public void setStepDefinitionPermissions(java.lang.String stepDefinitionPermissions)
public HubProject getHubProject()
HubConfig
getHubProject
in interface HubConfig
public void setHubProject(HubProject hubProject)
public void initHubProject()
HubConfig
initHubProject
in interface HubConfig
public void refreshProject()
HubConfig
HubConfig.createProject(String)
you can use setter methods to change HubConfig properties
and then call this method.refreshProject
in interface HubConfig
public void loadConfigurationFromProperties(java.util.Properties userProperties, boolean loadGradleProperties)
userProperties
- loadGradleProperties
- public com.marklogic.mgmt.ManageConfig getManageConfig()
getManageConfig
in class com.marklogic.hub.HubClientConfig
public com.marklogic.mgmt.ManageClient getManageClient()
getManageClient
in interface HubConfig
public void setManageClient(com.marklogic.mgmt.ManageClient manageClient)
public com.marklogic.mgmt.admin.AdminConfig getAdminConfig()
public void setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)
public com.marklogic.mgmt.admin.AdminManager getAdminManager()
getAdminManager
in interface HubConfig
public void setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)
public com.marklogic.client.DatabaseClient newAppServicesClient()
HubConfig
newAppServicesClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newStagingClient()
HubConfig
newStagingClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newReverseFlowClient()
HubConfig
newReverseFlowClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newFinalClient()
HubConfig
newFinalClient
in interface HubConfig
@Deprecated public com.marklogic.client.DatabaseClient newTraceDbClient()
HubConfig
newTraceDbClient
in interface HubConfig
public java.nio.file.Path getModulesDir()
HubConfig
getModulesDir
in interface HubConfig
public java.nio.file.Path getHubProjectDir()
public java.nio.file.Path getHubPluginsDir()
HubConfig
getHubPluginsDir
in interface HubConfig
public java.nio.file.Path getHubEntitiesDir()
HubConfig
getHubEntitiesDir
in interface HubConfig
public java.nio.file.Path getHubMappingsDir()
HubConfig
getHubMappingsDir
in interface HubConfig
public java.nio.file.Path getStepDefinitionPath(StepDefinition.StepDefinitionType type)
getStepDefinitionPath
in interface HubConfig
public java.nio.file.Path getHubConfigDir()
HubConfig
getHubConfigDir
in interface HubConfig
public java.nio.file.Path getHubDatabaseDir()
HubConfig
getHubDatabaseDir
in interface HubConfig
public java.nio.file.Path getHubServersDir()
HubConfig
getHubServersDir
in interface HubConfig
public java.nio.file.Path getHubSecurityDir()
HubConfig
getHubSecurityDir
in interface HubConfig
public java.nio.file.Path getUserSecurityDir()
HubConfig
getUserSecurityDir
in interface HubConfig
public java.nio.file.Path getUserConfigDir()
HubConfig
getUserConfigDir
in interface HubConfig
public java.nio.file.Path getUserDatabaseDir()
HubConfig
getUserDatabaseDir
in interface HubConfig
public java.nio.file.Path getUserSchemasDir()
HubConfig
getUserSchemasDir
in interface HubConfig
public java.nio.file.Path getEntityDatabaseDir()
HubConfig
getEntityDatabaseDir
in interface HubConfig
public java.nio.file.Path getFlowsDir()
HubConfig
getFlowsDir
in interface HubConfig
public java.nio.file.Path getStepDefinitionsDir()
HubConfig
getStepDefinitionsDir
in interface HubConfig
public java.nio.file.Path getUserServersDir()
HubConfig
getUserServersDir
in interface HubConfig
public com.marklogic.appdeployer.AppConfig getAppConfig()
HubConfig
getAppConfig
in interface HubConfig
public void setAppConfig(com.marklogic.appdeployer.AppConfig config)
HubConfig
setAppConfig
in interface HubConfig
config
- AppConfig to associate with the HubConfigpublic void setAppConfig(com.marklogic.appdeployer.AppConfig config, boolean skipUpdate)
HubConfig
setAppConfig
in interface HubConfig
config
- - AppConfig to associate with the HubConfigskipUpdate
- false to force update of AppConfig, true to skip itpublic java.lang.String getJarVersion()
HubConfig
getJarVersion
in interface HubConfig
public java.lang.String getHubLogLevel()
HubConfig
getHubLogLevel
in interface HubConfig
protected void addDhfPropertiesToCustomTokens(com.marklogic.appdeployer.AppConfig appConfig)
appConfig
- protected void initializeConfigDirs(com.marklogic.appdeployer.AppConfig config)
config
- an AppConfig objectprotected void initializeModulePaths(com.marklogic.appdeployer.AppConfig config)
config
- an AppConfig objectpublic java.lang.String getInfo()
HubConfig
public HubConfig withPropertiesFromEnvironment(java.lang.String environment)
withPropertiesFromEnvironment
in interface HubConfig
environment
- a string name for environmentpublic java.lang.String toString()
toString
in class java.lang.Object
public void applyDefaultPropertyValues()
applyDefaultPropertyValues
in class com.marklogic.hub.HubClientConfig
public void applyDefaultPermissionPropertyValues()
protected void initializePropertyConsumerMap()
initializePropertyConsumerMap
in class com.marklogic.hub.HubClientConfig
public void configureForDhs()
configureForDhs
in class com.marklogic.hub.HubClientConfig
public void enableSimpleSsl()
enableSimpleSsl
in class com.marklogic.hub.HubClientConfig
public void disableSimpleSsl()
disableSimpleSsl
in class com.marklogic.hub.HubClientConfig
public com.marklogic.hub.HubClient newHubClient()
newHubClient
in interface HubConfig