Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
customForestPath |
protected java.lang.String |
finalAuthMethod |
protected java.lang.String |
finalDbName |
protected java.lang.Integer |
finalForestsPerHost |
protected java.lang.String |
finalHttpName |
protected java.lang.Integer |
finalPort |
protected java.lang.String |
jobAuthMethod |
protected java.lang.String |
jobDbName |
protected java.lang.Integer |
jobForestsPerHost |
protected java.lang.String |
jobHttpName |
protected java.lang.Integer |
jobPort |
protected java.lang.String |
modulePermissions |
protected java.lang.String |
modulesDbName |
protected java.lang.Integer |
modulesForestsPerHost |
protected java.lang.String |
schemasDbName |
protected java.lang.Integer |
schemasForestsPerHost |
protected java.lang.String |
stagingAuthMethod |
protected java.lang.String |
stagingDbName |
protected java.lang.Integer |
stagingForestsPerHost |
protected java.lang.String |
stagingHttpName |
protected java.lang.Integer |
stagingPort |
protected java.lang.String |
traceAuthMethod |
protected java.lang.String |
traceDbName |
protected java.lang.Integer |
traceForestsPerHost |
protected java.lang.String |
traceHttpName |
protected java.lang.Integer |
tracePort |
protected java.lang.String |
triggersDbName |
protected java.lang.Integer |
triggersForestsPerHost |
DEFAULT_AUTH_METHOD, DEFAULT_CUSTOM_FOREST_PATH, DEFAULT_FINAL_NAME, DEFAULT_FINAL_PORT, DEFAULT_FORESTS_PER_HOST, DEFAULT_JOB_NAME, DEFAULT_JOB_PORT, DEFAULT_MODULES_DB_NAME, DEFAULT_ROLE_NAME, DEFAULT_SCHEMAS_DB_NAME, DEFAULT_SCHEME, DEFAULT_STAGING_NAME, DEFAULT_STAGING_PORT, DEFAULT_TRACE_NAME, DEFAULT_TRACE_PORT, DEFAULT_TRIGGERS_DB_NAME, DEFAULT_USER_NAME, ENTITY_CONFIG_DIR, FINAL_ENTITY_QUERY_OPTIONS_FILE, HUB_CONFIG_DIR, HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES, STAGING_ENTITY_QUERY_OPTIONS_FILE, USER_CONFIG_DIR, USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES, USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
Constructor and Description |
---|
HubConfigImpl() |
HubConfigImpl(java.lang.String projectDir) |
Modifier and Type | Method and Description |
---|---|
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(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.nio.file.Path |
getEntityDatabaseDir()
Gets the path for the entity database directory
|
java.lang.String |
getExternalName(DatabaseKind kind)
Returns the external name for the host for the DatabaseKind in the hub config
|
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 entities directory
|
java.nio.file.Path |
getHubDatabaseDir()
Gets the path for the hub's config directory
|
java.nio.file.Path |
getHubEntitiesDir()
Gets the path for the hub plugins 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 entity database directory
|
HubProject |
getHubProject()
Returns the HubProject associated with the HubConfig
|
java.lang.String |
getHubRoleName()
Get the roleName the hub uses
|
java.nio.file.Path |
getHubSecurityDir()
Gets the path for the hub servers directory
|
java.nio.file.Path |
getHubServersDir()
Gets the path for the hub's database directory
|
java.lang.String |
getHubUserName()
Get the current marklogic user name the hub uses
|
java.lang.String |
getJarVersion()
Gets the current version of the DHF Jar
|
java.lang.String[] |
getLoadBalancerHosts()
Gets a string array of hosts
|
com.marklogic.mgmt.ManageClient |
getManageClient() |
com.marklogic.mgmt.ManageConfig |
getManageConfig() |
java.lang.String |
getModulePermissions()
Gets the permissions used to execute a module in string form
|
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)
Returns the SSL Scheme as string for the DatabaseKind in the hub config
|
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.nio.file.Path |
getUserConfigDir()
Gets the path for the entity database directory
|
java.io.File |
getUserContentDeployTimestampFile() |
java.nio.file.Path |
getUserDatabaseDir()
Gets the path for the user security directory
|
java.lang.String |
getUserModulesDeployTimestampFile()
Returns the last deployed timestamp file for the user modules
|
java.nio.file.Path |
getUserSecurityDir()
Gets the path for the user config directory
|
java.nio.file.Path |
getUserServersDir()
Gets the path for the entity database directory
|
void |
initHubProject()
Initializes the hub project on disk
|
void |
loadConfigurationFromProperties(java.util.Properties environmentProperties) |
com.marklogic.client.DatabaseClient |
newAppServicesClient()
Creates a new DatabaseClient for accessing the AppServices app
|
com.marklogic.client.DatabaseClient |
newFinalClient()
Creates a new DatabaseClient for accessing the Final database
|
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 |
newStagingClient()
Creates a new DatabaseClient for accessing the Staging database
|
com.marklogic.client.DatabaseClient |
newStagingClient(java.lang.String databaseName)
Creates a new DatabaseClient for accessing the Staging database
|
com.marklogic.client.DatabaseClient |
newTraceDbClient()
Creates a new DatabaseClient for accessing the Trace database
|
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 App Config for the current HubConfig
|
void |
setAppConfig(com.marklogic.appdeployer.AppConfig config,
boolean skipUpdate)
Sets the App Config 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 |
setCustomForestPath(java.lang.String customForestPath) |
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 |
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 |
setHubRoleName(java.lang.String hubRoleName)
Set the role name that the hub uses
|
void |
setHubUserName(java.lang.String hubUserName)
Sets the username for the hub to use in MarkLogic
|
void |
setLoadBalancerHosts(java.lang.String[] loadBalancerHosts) |
void |
setManageClient(com.marklogic.mgmt.ManageClient manageClient) |
void |
setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig) |
void |
setModulePermissions(java.lang.String modulePermissions) |
void |
setPort(DatabaseKind kind,
java.lang.Integer port)
Sets the port number for the databaseKind on the hubconfig
|
void |
setProjectDir(java.lang.String projectDir) |
void |
setScheme(DatabaseKind kind,
java.lang.String scheme)
Sets the SSL Scheme for the DatabaseKind in the config
|
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 sslHostnameVerifier)
Sets the SSL Hostname Verifier object for the DatabaseKind in the config
|
protected java.lang.String stagingDbName
protected java.lang.String stagingHttpName
protected java.lang.Integer stagingForestsPerHost
protected java.lang.Integer stagingPort
protected java.lang.String stagingAuthMethod
protected java.lang.String finalDbName
protected java.lang.String finalHttpName
protected java.lang.Integer finalForestsPerHost
protected java.lang.Integer finalPort
protected java.lang.String finalAuthMethod
protected java.lang.String traceDbName
protected java.lang.String traceHttpName
protected java.lang.Integer traceForestsPerHost
protected java.lang.Integer tracePort
protected java.lang.String traceAuthMethod
protected java.lang.String jobDbName
protected java.lang.String jobHttpName
protected java.lang.Integer jobForestsPerHost
protected java.lang.Integer jobPort
protected java.lang.String jobAuthMethod
protected java.lang.String modulesDbName
protected java.lang.Integer modulesForestsPerHost
protected java.lang.String triggersDbName
protected java.lang.Integer triggersForestsPerHost
protected java.lang.String schemasDbName
protected java.lang.Integer schemasForestsPerHost
protected java.lang.String customForestPath
protected java.lang.String modulePermissions
public HubConfigImpl()
public HubConfigImpl(java.lang.String projectDir)
public java.lang.String getHost()
HubConfig
public java.lang.String getDbName(DatabaseKind kind)
HubConfig
public void setDbName(DatabaseKind kind, java.lang.String dbName)
HubConfig
public java.lang.String getHttpName(DatabaseKind kind)
HubConfig
getHttpName
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setHttpName(DatabaseKind kind, java.lang.String httpName)
HubConfig
setHttpName
in interface HubConfig
httpName
- The name to set for the appserverpublic java.lang.Integer getForestsPerHost(DatabaseKind kind)
HubConfig
getForestsPerHost
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setForestsPerHost(DatabaseKind kind, java.lang.Integer forestsPerHost)
HubConfig
setForestsPerHost
in interface HubConfig
forestsPerHost
- The number of forests per hostpublic java.lang.Integer getPort(DatabaseKind kind)
HubConfig
public void setPort(DatabaseKind kind, java.lang.Integer port)
HubConfig
public javax.net.ssl.SSLContext getSslContext(DatabaseKind kind)
HubConfig
getSslContext
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setSslContext(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(DatabaseKind kind)
HubConfig
getSslHostnameVerifier
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setSslHostnameVerifier(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(DatabaseKind kind)
HubConfig
getAuthMethod
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setAuthMethod(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 java.lang.String getScheme(DatabaseKind kind)
HubConfig
public void setScheme(DatabaseKind kind, java.lang.String scheme)
HubConfig
public boolean getSimpleSsl(DatabaseKind kind)
HubConfig
getSimpleSsl
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setSimpleSsl(DatabaseKind kind, java.lang.Boolean simpleSsl)
HubConfig
setSimpleSsl
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic java.lang.String getCertFile(DatabaseKind kind)
HubConfig
getCertFile
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setCertFile(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(DatabaseKind kind)
HubConfig
getCertPassword
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setCertPass(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(DatabaseKind kind)
HubConfig
getExternalName
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setExternalName(DatabaseKind kind, java.lang.String externalName)
HubConfig
setExternalName
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic java.lang.String getHubRoleName()
HubConfig
getHubRoleName
in interface HubConfig
public void setHubRoleName(java.lang.String hubRoleName)
HubConfig
setHubRoleName
in interface HubConfig
hubRoleName
- the name to usepublic java.lang.String getHubUserName()
HubConfig
getHubUserName
in interface HubConfig
public void setHubUserName(java.lang.String hubUserName)
HubConfig
setHubUserName
in interface HubConfig
hubUserName
- - username to usepublic java.lang.String[] getLoadBalancerHosts()
HubConfig
getLoadBalancerHosts
in interface HubConfig
public void setLoadBalancerHosts(java.lang.String[] loadBalancerHosts)
public java.lang.String getCustomForestPath()
HubConfig
getCustomForestPath
in interface HubConfig
public void setCustomForestPath(java.lang.String customForestPath)
public java.lang.String getModulePermissions()
HubConfig
getModulePermissions
in interface HubConfig
public void setModulePermissions(java.lang.String modulePermissions)
public java.lang.String getProjectDir()
HubConfig
getProjectDir
in interface HubConfig
public void setProjectDir(java.lang.String projectDir)
setProjectDir
in interface HubConfig
public HubProject getHubProject()
HubConfig
getHubProject
in interface HubConfig
public void initHubProject()
HubConfig
initHubProject
in interface HubConfig
public java.lang.String getHubModulesDeployTimestampFile()
HubConfig
getHubModulesDeployTimestampFile
in interface HubConfig
public java.lang.String getUserModulesDeployTimestampFile()
HubConfig
getUserModulesDeployTimestampFile
in interface HubConfig
public java.io.File getUserContentDeployTimestampFile()
public void loadConfigurationFromProperties(java.util.Properties environmentProperties)
public com.marklogic.mgmt.ManageConfig getManageConfig()
public void setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)
public com.marklogic.mgmt.ManageClient getManageClient()
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()
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 newStagingClient(java.lang.String databaseName)
HubConfig
newStagingClient
in interface HubConfig
databaseName
- - the name of the database for the staging Client to usepublic com.marklogic.client.DatabaseClient newFinalClient()
HubConfig
newFinalClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newJobDbClient()
HubConfig
newJobDbClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newTraceDbClient()
HubConfig
newTraceDbClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newModulesDbClient()
HubConfig
newModulesDbClient
in interface HubConfig
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 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 getEntityDatabaseDir()
HubConfig
getEntityDatabaseDir
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