com.marklogic.hub.impl

Class HubConfigImpl

java.lang.Object

com.marklogic.hub.impl.HubConfigImpl

All Implemented Interfaces:

HubConfig

public class HubConfigImpl
extends java.lang.Object
implements HubConfig

Field Summary

Fields

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

Fields inherited from interface com.marklogic.hub.HubConfig

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 Summary

Constructors

Constructor and Description
HubConfigImpl()
HubConfigImpl(java.lang.String projectDir)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.marklogic.hub.HubConfig

create

Field Detail

stagingDbName

protected java.lang.String stagingDbName

stagingHttpName

protected java.lang.String stagingHttpName

stagingForestsPerHost

protected java.lang.Integer stagingForestsPerHost

stagingPort

protected java.lang.Integer stagingPort

stagingAuthMethod

protected java.lang.String stagingAuthMethod

finalDbName

protected java.lang.String finalDbName

finalHttpName

protected java.lang.String finalHttpName

finalForestsPerHost

protected java.lang.Integer finalForestsPerHost

finalPort

protected java.lang.Integer finalPort

finalAuthMethod

protected java.lang.String finalAuthMethod

traceDbName

protected java.lang.String traceDbName

traceHttpName

protected java.lang.String traceHttpName

traceForestsPerHost

protected java.lang.Integer traceForestsPerHost

tracePort

protected java.lang.Integer tracePort

traceAuthMethod

protected java.lang.String traceAuthMethod

jobDbName

protected java.lang.String jobDbName

jobHttpName

protected java.lang.String jobHttpName

jobForestsPerHost

protected java.lang.Integer jobForestsPerHost

jobPort

protected java.lang.Integer jobPort

jobAuthMethod

protected java.lang.String jobAuthMethod

modulesDbName

protected java.lang.String modulesDbName

modulesForestsPerHost

protected java.lang.Integer modulesForestsPerHost

triggersDbName

protected java.lang.String triggersDbName

triggersForestsPerHost

protected java.lang.Integer triggersForestsPerHost

schemasDbName

protected java.lang.String schemasDbName

schemasForestsPerHost

protected java.lang.Integer schemasForestsPerHost

customForestPath

protected java.lang.String customForestPath

modulePermissions

protected java.lang.String modulePermissions

Constructor Detail

HubConfigImpl

public HubConfigImpl()

HubConfigImpl

public HubConfigImpl(java.lang.String projectDir)

Method Detail

getHost

public java.lang.String getHost()

Description copied from interface: HubConfig

Gets the hostname of the AppConfig

Specified by:

getHost in interface HubConfig

Returns:

name of host

getDbName

public java.lang.String getDbName(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(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(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(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(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(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(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(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(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(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(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(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(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(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

getScheme

public java.lang.String getScheme(DatabaseKind kind)

Description copied from interface: HubConfig

Returns the SSL Scheme as string for the DatabaseKind in the hub config

Specified by:

getScheme in interface HubConfig

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

Returns:

The SSL Scheme for the DatabaseKind in hubconfig

setScheme

public void setScheme(DatabaseKind kind,
                      java.lang.String scheme)

Description copied from interface: HubConfig

Sets the SSL Scheme for the DatabaseKind in the config

Specified by:

setScheme in interface HubConfig

Parameters:

kind - - DatabaseKind enum, eg: STAGING or JOB

scheme - - The SSL Scheme for the database connection

getSimpleSsl

public boolean getSimpleSsl(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(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(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(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(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(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(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(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

getHubRoleName

public java.lang.String getHubRoleName()

Description copied from interface: HubConfig

Get the roleName the hub uses

Specified by:

getHubRoleName in interface HubConfig

Returns:

the name of the role the DHF uses

setHubRoleName

public void setHubRoleName(java.lang.String hubRoleName)

Description copied from interface: HubConfig

Set the role name that the hub uses

Specified by:

setHubRoleName in interface HubConfig

Parameters:

hubRoleName - the name to use

getHubUserName

public java.lang.String getHubUserName()

Description copied from interface: HubConfig

Get the current marklogic user name the hub uses

Specified by:

getHubUserName in interface HubConfig

Returns:

the username

setHubUserName

public void setHubUserName(java.lang.String hubUserName)

Description copied from interface: HubConfig

Sets the username for the hub to use in MarkLogic

Specified by:

setHubUserName in interface HubConfig

Parameters:

hubUserName - - username to use

getLoadBalancerHosts

public java.lang.String[] getLoadBalancerHosts()

Description copied from interface: HubConfig

Gets a string array of hosts

Specified by:

getLoadBalancerHosts in interface HubConfig

Returns:

String array of hosts

setLoadBalancerHosts

public void setLoadBalancerHosts(java.lang.String[] loadBalancerHosts)

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)

getModulePermissions

public java.lang.String getModulePermissions()

Description copied from interface: HubConfig

Gets the permissions used to execute a module in string form

Specified by:

getModulePermissions in interface HubConfig

Returns:

a string reprsenting the marklogic permissions for a module

setModulePermissions

public void setModulePermissions(java.lang.String modulePermissions)

getProjectDir

public java.lang.String getProjectDir()

Description copied from interface: HubConfig

Obtains the project directory as a string

Specified by:

getProjectDir in interface HubConfig

Returns:

project directory

setProjectDir

public void setProjectDir(java.lang.String projectDir)

Specified by:

setProjectDir in interface HubConfig

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

initHubProject

public void initHubProject()

Description copied from interface: HubConfig

Initializes the hub project on disk

Specified by:

initHubProject in interface HubConfig

getHubModulesDeployTimestampFile

public java.lang.String getHubModulesDeployTimestampFile()

Description copied from interface: HubConfig

Returns the last deployed timestamp file for the hub config and modules

Specified by:

getHubModulesDeployTimestampFile in interface HubConfig

Returns:

string of what's located in the timestamp file

getUserModulesDeployTimestampFile

public java.lang.String getUserModulesDeployTimestampFile()

Description copied from interface: HubConfig

Returns the last deployed timestamp file for the user modules

Specified by:

getUserModulesDeployTimestampFile in interface HubConfig

Returns:

string of what's located in the timestamp file

getUserContentDeployTimestampFile

public java.io.File getUserContentDeployTimestampFile()

loadConfigurationFromProperties

public void loadConfigurationFromProperties(java.util.Properties environmentProperties)

getManageConfig

public com.marklogic.mgmt.ManageConfig getManageConfig()

setManageConfig

public void setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)

getManageClient

public com.marklogic.mgmt.ManageClient getManageClient()

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

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

Creates a new DatabaseClient for accessing the Staging database

Specified by:

newStagingClient in interface HubConfig

Returns:

- a DatabaseClient

newStagingClient

public com.marklogic.client.DatabaseClient newStagingClient(java.lang.String databaseName)

Description copied from interface: HubConfig

Creates a new DatabaseClient for accessing the Staging database

Specified by:

newStagingClient in interface HubConfig

Parameters:

databaseName - - the name of the database for the staging Client to use

newFinalClient

public com.marklogic.client.DatabaseClient newFinalClient()

Description copied from interface: HubConfig

Creates a new DatabaseClient for accessing the Final database

Specified by:

newFinalClient in interface HubConfig

Returns:

- a DatabaseClient

newJobDbClient

public com.marklogic.client.DatabaseClient newJobDbClient()

Description copied from interface: HubConfig

Creates a new DatabaseClient for accessing the Job database

Specified by:

newJobDbClient in interface HubConfig

Returns:

- a DatabaseClient

newTraceDbClient

public com.marklogic.client.DatabaseClient newTraceDbClient()

Description copied from interface: HubConfig

Creates a new DatabaseClient for accessing the Trace database

Specified by:

newTraceDbClient in interface HubConfig

Returns:

- a DatabaseClient

newModulesDbClient

public com.marklogic.client.DatabaseClient newModulesDbClient()

Description copied from interface: HubConfig

Creates a new DatabaseClient for accessing the Hub Modules database

Specified by:

newModulesDbClient in interface HubConfig

Returns:

- a DatabaseClient

getHubPluginsDir

public java.nio.file.Path getHubPluginsDir()

Description copied from interface: HubConfig

Gets the path for the entity database directory

Specified by:

getHubPluginsDir in interface HubConfig

Returns:

the path for the entity's database directory

getHubEntitiesDir

public java.nio.file.Path getHubEntitiesDir()

Description copied from interface: HubConfig

Gets the path for the hub plugins directory

Specified by:

getHubEntitiesDir in interface HubConfig

Returns:

the path for the hub plugins directory

getHubConfigDir

public java.nio.file.Path getHubConfigDir()

Description copied from interface: HubConfig

Gets the path for the hub's entities directory

Specified by:

getHubConfigDir in interface HubConfig

Returns:

the path for the hub's entities directory

getHubDatabaseDir

public java.nio.file.Path getHubDatabaseDir()

Description copied from interface: HubConfig

Gets the path for the hub's config directory

Specified by:

getHubDatabaseDir in interface HubConfig

Returns:

the path for the hub's config directory

getHubServersDir

public java.nio.file.Path getHubServersDir()

Description copied from interface: HubConfig

Gets the path for the hub's database directory

Specified by:

getHubServersDir in interface HubConfig

Returns:

the path for the hub's database directory

getHubSecurityDir

public java.nio.file.Path getHubSecurityDir()

Description copied from interface: HubConfig

Gets the path for the hub servers directory

Specified by:

getHubSecurityDir in interface HubConfig

Returns:

the path for the hub servers database directory

getUserSecurityDir

public java.nio.file.Path getUserSecurityDir()

Description copied from interface: HubConfig

Gets the path for the user config directory

Specified by:

getUserSecurityDir in interface HubConfig

Returns:

the path for the user config directory

getUserConfigDir

public java.nio.file.Path getUserConfigDir()

Description copied from interface: HubConfig

Gets the path for the entity database directory

Specified by:

getUserConfigDir in interface HubConfig

Returns:

the path for the entity's database directory

getUserDatabaseDir

public java.nio.file.Path getUserDatabaseDir()

Description copied from interface: HubConfig

Gets the path for the user security directory

Specified by:

getUserDatabaseDir in interface HubConfig

Returns:

the path for the user security 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

getUserServersDir

public java.nio.file.Path getUserServersDir()

Description copied from interface: HubConfig

Gets the path for the entity database directory

Specified by:

getUserServersDir in interface HubConfig

Returns:

the path for the entity's 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 App Config 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 App Config 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