com.marklogic.hub.impl

Class HubConfigBuilderImpl

java.lang.Object

com.marklogic.hub.impl.HubConfigBuilderImpl

All Implemented Interfaces:

HubConfigBuilder

public class HubConfigBuilderImpl
extends java.lang.Object
implements HubConfigBuilder

A class for building a HubConfig class. Create a HubConfig instance like so:

     HubConfig hubConfig = HubConfigBuilder.newHubConfigBuilder("/path/to/your/project")
         .withPropertiesFromEnvironment("local")
         .build();

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HubConfig	build() Builds the HubConfig 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

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.HubConfigBuilder

newHubConfigBuilder

Constructor Detail

HubConfigBuilderImpl

public HubConfigBuilderImpl(java.lang.String projectDir)

Method Detail

withPropertiesFromEnvironment

public HubConfigBuilder withPropertiesFromEnvironment()

Description copied from interface: HubConfigBuilder

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

Specified by:

withPropertiesFromEnvironment in interface HubConfigBuilder

Returns:

the HubConfigBuilder instance

withPropertiesFromEnvironment

public HubConfigBuilder withPropertiesFromEnvironment(java.lang.String environment)

Description copied from interface: HubConfigBuilder

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

Specified by:

withPropertiesFromEnvironment in interface HubConfigBuilder

Parameters:

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

Returns:

the HubConfigBuilder instance

withProperties

public HubConfigBuilder withProperties(java.util.Properties properties)

Description copied from interface: HubConfigBuilder

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

Specified by:

withProperties in interface HubConfigBuilder

Parameters:

properties - - A Properties object with properties set

Returns:

the HubConfigBuilder instance

withAppConfig

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

Description copied from interface: HubConfigBuilder

Sets the AppConfig for the HubConfig

Specified by:

withAppConfig in interface HubConfigBuilder

Parameters:

appConfig - - an AppConfig object

Returns:

the HubConfigBuilder instance

withAdminConfig

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

Description copied from interface: HubConfigBuilder

Sets the AdminConfig for the HubConfig

Specified by:

withAdminConfig in interface HubConfigBuilder

Parameters:

adminConfig - - an AdminConfig object

Returns:

the HubConfigBuilder instance

withAdminManager

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

Description copied from interface: HubConfigBuilder

Sets the AdminManager for the HubConfig

Specified by:

withAdminManager in interface HubConfigBuilder

Parameters:

adminManager - - an AdminManager object

Returns:

the HubConfigBuilder instance

withManageConfig

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

Description copied from interface: HubConfigBuilder

Sets the ManageConfig for the HubConfig

Specified by:

withManageConfig in interface HubConfigBuilder

Parameters:

manageConfig - - a ManageConfig object

Returns:

the HubConfigBuilder instance

withManageClient

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

Description copied from interface: HubConfigBuilder

Sets the ManageClient for the HubConfig

Specified by:

withManageClient in interface HubConfigBuilder

Parameters:

manageClient - - a ManageClient

Returns:

the HubConfigBuilder instance

build

public HubConfig build()

Description copied from interface: HubConfigBuilder

Builds the HubConfig instance

Specified by:

build in interface HubConfigBuilder

Returns:

the created HubConfig