com.marklogic.hub

Interface HubConfigBuilder

All Known Implementing Classes:

HubConfigBuilderImpl

public interface HubConfigBuilder

Helper interface that constructs a HubConfig object from a properties file or pre-existing config. To manipulate a HubConfig or build one from scratch HubConfig

Method Summary

Modifier and Type	Method and Description
HubConfig	build() Builds the HubConfig instance
static HubConfigBuilder	newHubConfigBuilder(java.lang.String projectDir) Returns a new HubConfigBuilder instance
HubConfigBuilder	withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig) Sets the AdminConfig for the HubConfig
HubConfigBuilder	withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager) Sets the AdminManager for the HubConfig
HubConfigBuilder	withAppConfig(com.marklogic.appdeployer.AppConfig appConfig) Sets the AppConfig for the HubConfig
HubConfigBuilder	withManageClient(com.marklogic.mgmt.ManageClient manageClient) Sets the ManageClient for the HubConfig
HubConfigBuilder	withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig) Sets the ManageConfig for the HubConfig
HubConfigBuilder	withProperties(java.util.Properties properties) Tells the builder to use the given properties.
HubConfigBuilder	withPropertiesFromEnvironment() Tells the builder to load properties from the gradle files in the project dir
HubConfigBuilder	withPropertiesFromEnvironment(java.lang.String environment) Tells the builder to load properties from the gradle files in the project dir but to look for an environment properties file with overrides

Method Detail

newHubConfigBuilder

static HubConfigBuilder newHubConfigBuilder(java.lang.String projectDir)

Returns a new HubConfigBuilder instance

Parameters:

projectDir - - the hub's project directory

Returns:

a new HubConfigBuilder

withPropertiesFromEnvironment

HubConfigBuilder withPropertiesFromEnvironment()

Tells the builder to load properties from the gradle files in the project dir

Returns:

the HubConfigBuilder instance

withPropertiesFromEnvironment

HubConfigBuilder withPropertiesFromEnvironment(java.lang.String environment)

Tells the builder to load properties from the gradle files in the project dir but to look for an environment properties file with overrides

Parameters:

environment - - the name of the environment to use (local,dev,qa,prod,...)

Returns:

the HubConfigBuilder instance

withProperties

HubConfigBuilder withProperties(java.util.Properties properties)

Tells the builder to use the given properties. If properties are also being loaded from the gradle files in the project dir, then these properties will be merged into the others taking precedence over the ones loaded from disk

Parameters:

properties - - A Properties object with properties set

Returns:

the HubConfigBuilder instance

withAppConfig

HubConfigBuilder withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)

Sets the AppConfig for the HubConfig

Parameters:

appConfig - - an AppConfig object

Returns:

the HubConfigBuilder instance

withAdminConfig

HubConfigBuilder withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)

Sets the AdminConfig for the HubConfig

Parameters:

adminConfig - - an AdminConfig object

Returns:

the HubConfigBuilder instance

withAdminManager

HubConfigBuilder withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)

Sets the AdminManager for the HubConfig

Parameters:

adminManager - - an AdminManager object

Returns:

the HubConfigBuilder instance

withManageConfig

HubConfigBuilder withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)

Sets the ManageConfig for the HubConfig

Parameters:

manageConfig - - a ManageConfig object

Returns:

the HubConfigBuilder instance

withManageClient

HubConfigBuilder withManageClient(com.marklogic.mgmt.ManageClient manageClient)

Sets the ManageClient for the HubConfig

Parameters:

manageClient - - a ManageClient

Returns:

the HubConfigBuilder instance

build

HubConfig build()

Builds the HubConfig instance

Returns:

the created HubConfig