public interface HubConfig
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_FINAL_NAME |
static java.lang.Integer |
DEFAULT_FINAL_PORT |
static java.lang.Integer |
DEFAULT_FORESTS_PER_HOST |
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_SCHEMAS_DB_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_TRACE_NAME |
static java.lang.Integer |
DEFAULT_TRACE_PORT |
static java.lang.String |
DEFAULT_TRIGGERS_DB_NAME |
static java.lang.String |
DEFAULT_USER_NAME |
static java.lang.String |
ENTITY_CONFIG_DIR |
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 |
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 |
Modifier and Type | Method and Description |
---|---|
static HubConfig |
create(java.lang.String projectDir)
Creates and returns a hubconfig object for a project directory
|
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
|
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.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
|
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 |
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 |
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 |
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 stagingSslHostnameVerifier)
Sets the SSL Hostname Verifier object for the DatabaseKind in the config
|
static final java.lang.String HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
static final java.lang.String USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
static final java.lang.String USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES
static final java.lang.String HUB_CONFIG_DIR
static final java.lang.String USER_CONFIG_DIR
static final java.lang.String ENTITY_CONFIG_DIR
static final java.lang.String STAGING_ENTITY_QUERY_OPTIONS_FILE
static final java.lang.String FINAL_ENTITY_QUERY_OPTIONS_FILE
static final java.lang.String DEFAULT_STAGING_NAME
static final java.lang.String DEFAULT_FINAL_NAME
static final java.lang.String DEFAULT_TRACE_NAME
static final java.lang.String DEFAULT_JOB_NAME
static final java.lang.String DEFAULT_MODULES_DB_NAME
static final java.lang.String DEFAULT_TRIGGERS_DB_NAME
static final java.lang.String DEFAULT_SCHEMAS_DB_NAME
static final java.lang.String DEFAULT_ROLE_NAME
static final java.lang.String DEFAULT_USER_NAME
static final java.lang.Integer DEFAULT_STAGING_PORT
static final java.lang.Integer DEFAULT_FINAL_PORT
static final java.lang.Integer DEFAULT_TRACE_PORT
static final java.lang.Integer DEFAULT_JOB_PORT
static final java.lang.String DEFAULT_AUTH_METHOD
static final java.lang.String DEFAULT_SCHEME
static final java.lang.Integer DEFAULT_FORESTS_PER_HOST
static final java.lang.String DEFAULT_CUSTOM_FOREST_PATH
java.lang.String getHost()
static HubConfig create(java.lang.String projectDir)
projectDir
- - string path to the project directoryjava.lang.String getDbName(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setDbName(DatabaseKind kind, java.lang.String dbName)
kind-
- DatabaseKind enum, eg: STAGING or JOBdbName
- The name desired for the databasejava.lang.String getHttpName(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setHttpName(DatabaseKind kind, java.lang.String httpName)
kind-
- DatabaseKind enum, eg: STAGING or JOBhttpName
- The name to set for the appserverjava.lang.Integer getForestsPerHost(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setForestsPerHost(DatabaseKind kind, java.lang.Integer forestsPerHost)
kind-
- DatabaseKind enum, eg: STAGING or JOBforestsPerHost
- The number of forests per hostjava.lang.Integer getPort(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setPort(DatabaseKind kind, java.lang.Integer port)
kind-
- DatabaseKind enum, eg: STAGING or JOBport
- The port number for the database appserverjavax.net.ssl.SSLContext getSslContext(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setSslContext(DatabaseKind kind, javax.net.ssl.SSLContext sslContext)
kind
- - DatabaseKind enum, eg: STAGING or JOBsslContext
- - The SSLContext set for the database connectionvoid setSslHostnameVerifier(DatabaseKind kind, com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier)
kind
- - DatabaseKind enum, eg: STAGING or JOBstagingSslHostnameVerifier
- - The SSL Hostname Verifier object for the database connectioncom.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getSslHostnameVerifier(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBjava.lang.String getAuthMethod(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setAuthMethod(DatabaseKind kind, java.lang.String authMethod)
kind
- - DatabaseKind enum, eg: STAGING or JOBauthMethod
- - The SSL Auth Method for the database connectionjava.lang.String getScheme(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setScheme(DatabaseKind kind, java.lang.String scheme)
kind
- - DatabaseKind enum, eg: STAGING or JOBscheme
- - The SSL Scheme for the database connectionboolean getSimpleSsl(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setSimpleSsl(DatabaseKind kind, java.lang.Boolean simpleSsl)
kind
- - DatabaseKind enum, eg: STAGING or JOBsimpleSsl-
- true if you want to use Simple SSL, false if you don'tjava.lang.String getCertFile(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setCertFile(DatabaseKind kind, java.lang.String certFile)
kind
- - DatabaseKind enum, eg: STAGING or JOBcertFile
- - The SSL Cert File as a string to be used for the database connectionjava.lang.String getCertPassword(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setCertPass(DatabaseKind kind, java.lang.String certPassword)
kind
- - DatabaseKind enum, eg: STAGING or JOBcertPassword
- - The SSL certificate password for the database connectionjava.lang.String getExternalName(DatabaseKind kind)
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setExternalName(DatabaseKind kind, java.lang.String externalName)
kind
- - DatabaseKind enum, eg: STAGING or JOBexternalName-
- The external host name for the database connectionjava.lang.String getHubRoleName()
void setHubRoleName(java.lang.String hubRoleName)
hubRoleName
- the name to usejava.lang.String getHubUserName()
void setHubUserName(java.lang.String hubUserName)
hubUserName
- - username to usejava.lang.String[] getLoadBalancerHosts()
java.lang.String getCustomForestPath()
java.lang.String getModulePermissions()
java.lang.String getProjectDir()
void setProjectDir(java.lang.String projectDir)
projectDir
- HubProject getHubProject()
void initHubProject()
java.lang.String getHubModulesDeployTimestampFile()
java.lang.String getUserModulesDeployTimestampFile()
com.marklogic.client.DatabaseClient newAppServicesClient()
com.marklogic.client.DatabaseClient newStagingClient()
com.marklogic.client.DatabaseClient newStagingClient(java.lang.String databaseName)
databaseName
- - the name of the database for the staging Client to usecom.marklogic.client.DatabaseClient newFinalClient()
com.marklogic.client.DatabaseClient newJobDbClient()
com.marklogic.client.DatabaseClient newTraceDbClient()
com.marklogic.client.DatabaseClient newModulesDbClient()
java.nio.file.Path getHubPluginsDir()
java.nio.file.Path getHubEntitiesDir()
java.nio.file.Path getHubConfigDir()
java.nio.file.Path getHubDatabaseDir()
java.nio.file.Path getHubServersDir()
java.nio.file.Path getHubSecurityDir()
java.nio.file.Path getUserConfigDir()
java.nio.file.Path getUserSecurityDir()
java.nio.file.Path getUserDatabaseDir()
java.nio.file.Path getUserServersDir()
java.nio.file.Path getEntityDatabaseDir()
com.marklogic.appdeployer.AppConfig getAppConfig()
void setAppConfig(com.marklogic.appdeployer.AppConfig config)
config
- AppConfig to associate with the HubConfigvoid setAppConfig(com.marklogic.appdeployer.AppConfig config, boolean skipUpdate)
config
- - AppConfig to associate with the HubConfigskipUpdate
- false to force update of AppConfig, true to skip itjava.lang.String getJarVersion()