DataHubImpl (marklogic-data-hub 5.1.0 API)

java.lang.Object
- com.marklogic.hub.impl.DataHubImpl

All Implemented Interfaces:: DataHub

@Component
public class DataHubImpl
extends java.lang.Object
implements DataHub

Field Summary

Fields
Modifier and Type Field and Description

protected org.slf4j.Logger logger

static java.lang.String MIN_UPGRADE_VERSION

Fields
Modifier and Type	Field and Description
`protected org.slf4j.Logger`	`logger`
`static java.lang.String`	`MIN_UPGRADE_VERSION`

Constructor Summary

Constructors
Constructor and Description

DataHubImpl()

Constructors
Constructor and Description
`DataHubImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.List<com.marklogic.appdeployer.command.Command>`	`buildCommandListForDeployingToDhs()`
`java.util.Map<java.lang.String,java.util.List<com.marklogic.appdeployer.command.Command>>`	`buildCommandMap()`
`java.util.List<com.marklogic.appdeployer.command.Command>`	`buildListOfCommands()`
`protected java.util.regex.Pattern`	`buildPatternForDatabasesToUpdateIndexesFor()` In a provisioned environment, only the databases defined by this pattern can be updated.
`void`	`clearDatabase(java.lang.String database)` Clears the database of all documents
`void`	`clearUserModules()` Removes user's modules from the modules db
`protected com.marklogic.mgmt.resource.appservers.ServerManager`	`constructServerManager(com.marklogic.mgmt.ManageClient manageClient, HubConfig hubConfig)` Need to account for the group name in case the user has overridden the name of the "Default" group.
`void`	`deleteDocument(java.lang.String uri, DatabaseKind databaseKind)` Deletes document based on supplied doc uri in supplied database
`void`	`deployToDhs(HubDeployStatusListener listener)` Install user project files into a DHS instance.
`protected void`	`disableSomeCmaUsage(com.marklogic.appdeployer.AppConfig appConfig)` Turns off CMA for some resources that have bbugs in ML 9.0-7/8.
`FlowRunner`	`getFlowRunner()` Creates and returns the FlowRunner object using the datahub's autowired hubconfig
`java.lang.String`	`getPortInUseBy(DatabaseKind kind)` Returns name of what is using the port
`java.util.List<com.marklogic.appdeployer.command.Command>`	`getSecurityCommandList()`
`java.lang.String`	`getServerVersion()` Returns the string presentation of the server version, eg: "9.03-1"
`void`	`initProject()` Initializes the project on disk, creates scaffold project code
`void`	`install()` Installs the data hub configuration and server-side config files into MarkLogic
`void`	`install(HubDeployStatusListener listener)` Installs the data hub configuration and server-side config files into MarkLogic
`InstallInfo`	`isInstalled()` Determines if the data hub is installed in MarkLogic
`boolean`	`isPortInUse(DatabaseKind kind)` Checks to see if the port is in use
`boolean`	`isSafeToInstall()` Checks to make sure all the versions and database in a valid configuration with version check Must be run as a user with sufficient privileges to install a data hub.
`boolean`	`isServerVersionOk()` Checks to see if the datahub and server versions are compatible
`boolean`	`isServerVersionValid(java.lang.String versionString)` Validates the MarkLogic server to ensure compatibility with the hub
`protected void`	`prepareAppConfigForDeployingToDhs(HubConfig hubConfig)`
`protected void`	`prepareProjectBeforeUpgrading(HubProject hubProject, java.lang.String currentDhfVersion)` The expectation is that a user has upgraded build.gradle to use a newer version of DHF but has not yet updated mlDHFVersion in gradle.properties.
`java.util.HashMap<java.lang.String,java.lang.Boolean>`	`runPreInstallCheck()` Runs the pre-install check for the datahub populating the object with variables necessary to perform the install.
`void`	`setHubConfig(HubConfigImpl hubConfig)`
`protected void`	`setKnownValuesForDhsDeployment(HubConfig hubConfig)` Per DHFPROD-2897, these are known values in a DHS installation that can be set so that they override any changes the user may have made for their on-premise installation.
`void`	`setPortInUseBy(DatabaseKind kind, java.lang.String usedBy)` Sets what appserver name is using the port
`void`	`setServerManager(com.marklogic.mgmt.resource.appservers.ServerManager manager)`
`void`	`setServerVersion(java.lang.String serverVersion)` Sets the server version holder on the datahub object - currently unused
`void`	`setServerVersionOk(boolean serverVersionOk)` Sets true or false if the server version is okay with this version of DHF
`void`	`setVersions(Versions versions)`
`void`	`uninstall()` Uninstalls the data hub configuration and server-side config files from MarkLogic
`void`	`uninstall(HubDeployStatusListener listener)` Uninstalls the data hub configuration and server-side config files from MarkLogic
`void`	`updateIndexes()` Note that this differs from how "mlUpdateIndexes" works in ml-gradle.
`boolean`	`upgradeHub()` Upgrades the installed datahub on the server to this version of the DataHub Must be run as a user with sufficient privileges to install a data hub.
`void`	`wireClient()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected final org.slf4j.Logger logger
```
  - MIN_UPGRADE_VERSION
```
public static java.lang.String MIN_UPGRADE_VERSION
```
- Constructor Detail
  - DataHubImpl
```
public DataHubImpl()
```
- Method Detail
  - wireClient
```
@PostConstruct
public void wireClient()
```
  - constructServerManager
```
protected com.marklogic.mgmt.resource.appservers.ServerManager constructServerManager(com.marklogic.mgmt.ManageClient manageClient,
                                                                                      HubConfig hubConfig)
```
    Need to account for the group name in case the user has overridden the name of the "Default" group.
    
    Parameters:
    
    manageClient - manageClient object
    
    hubConfig - hubConfig object
    
    Returns:
    
    constructed ServerManager object
  - clearDatabase
```
public void clearDatabase(java.lang.String database)
```
    Description copied from interface: DataHub
    
    Clears the database of all documents
    
    Specified by:
    
    clearDatabase in interface DataHub
    
    Parameters:
    
    database - - the name of the database in string form
  - setServerManager
```
public void setServerManager(com.marklogic.mgmt.resource.appservers.ServerManager manager)
```
  - getFlowRunner
```
public FlowRunner getFlowRunner()
```
    Description copied from interface: DataHub
    
    Creates and returns the FlowRunner object using the datahub's autowired hubconfig
    
    Specified by:
    
    getFlowRunner in interface DataHub
    
    Returns:
    
    FlowRunner object with current hubconfig already set
  - isInstalled
```
public InstallInfo isInstalled()
                        throws org.springframework.web.client.ResourceAccessException
```
    Description copied from interface: DataHub
    
    Determines if the data hub is installed in MarkLogic
    
    Specified by:
    
    isInstalled in interface DataHub
    
    Returns:
    
    true if installed, false otherwise
    
    Throws:
    
    org.springframework.web.client.ResourceAccessException
  - isServerVersionValid
```
public boolean isServerVersionValid(java.lang.String versionString)
```
    Description copied from interface: DataHub
    
    Validates the MarkLogic server to ensure compatibility with the hub
    
    Specified by:
    
    isServerVersionValid in interface DataHub
    
    Parameters:
    
    versionString - - the version of the server to validate
    
    Returns:
    
    true if valid, false otherwise
  - initProject
```
public void initProject()
```
    Description copied from interface: DataHub
    
    Initializes the project on disk, creates scaffold project code
    
    Specified by:
    
    initProject in interface DataHub
  - clearUserModules
```
public void clearUserModules()
```
    Description copied from interface: DataHub
    
    Removes user's modules from the modules db
    
    Specified by:
    
    clearUserModules in interface DataHub
  - deleteDocument
```
public void deleteDocument(java.lang.String uri,
                           DatabaseKind databaseKind)
```
    Description copied from interface: DataHub
    
    Deletes document based on supplied doc uri in supplied database
    
    Specified by:
    
    deleteDocument in interface DataHub
    
    Parameters:
    
    uri - - document uri
    
    databaseKind - - database type
  - buildListOfCommands
```
public java.util.List<com.marklogic.appdeployer.command.Command> buildListOfCommands()
```
  - getSecurityCommandList
```
public java.util.List<com.marklogic.appdeployer.command.Command> getSecurityCommandList()
```
  - runPreInstallCheck
```
public java.util.HashMap<java.lang.String,java.lang.Boolean> runPreInstallCheck()
```
    Description copied from interface: DataHub
    
    Runs the pre-install check for the datahub populating the object with variables necessary to perform the install. This is used for running install. Must be run as a user with sufficient privileges to install a data hub.
    
    Specified by:
    
    runPreInstallCheck in interface DataHub
    
    Returns:
    
    - a hashmap of the results of the preinstall check
  - install
```
public void install()
```
    Installs the data hub configuration and server-side config files into MarkLogic
    
    Specified by:
    
    install in interface DataHub
  - install
```
public void install(HubDeployStatusListener listener)
```
    Installs the data hub configuration and server-side config files into MarkLogic
    
    Specified by:
    
    install in interface DataHub
    
    Parameters:
    
    listener - - the callback method to receive status updates
  - disableSomeCmaUsage
```
protected void disableSomeCmaUsage(com.marklogic.appdeployer.AppConfig appConfig)
```
    Turns off CMA for some resources that have bbugs in ML 9.0-7/8.
    
    Parameters:
    
    appConfig -
  - deployToDhs
```
public void deployToDhs(HubDeployStatusListener listener)
```
    Description copied from interface: DataHub
    
    Install user project files into a DHS instance. Does not install any DHF resources or modules, as those are assumed to be installed by DHS.
    
    Specified by:
    
    deployToDhs in interface DataHub
  - prepareAppConfigForDeployingToDhs
```
protected void prepareAppConfigForDeployingToDhs(HubConfig hubConfig)
```
  - setKnownValuesForDhsDeployment
```
protected void setKnownValuesForDhsDeployment(HubConfig hubConfig)
```
    Per DHFPROD-2897, these are known values in a DHS installation that can be set so that they override any changes the user may have made for their on-premise installation.
    
    Parameters:
    
    hubConfig -
  - buildCommandListForDeployingToDhs
```
protected java.util.List<com.marklogic.appdeployer.command.Command> buildCommandListForDeployingToDhs()
```
  - updateIndexes
```
public void updateIndexes()
```
    Note that this differs from how "mlUpdateIndexes" works in ml-gradle. This is not stripping out any "non-index" properties from each payload - it's just updating every database. This does however disable forest creation which speeds up the process so that the only calls made are to update the databases.
    
    Specified by:
    
    updateIndexes in interface DataHub
  - buildPatternForDatabasesToUpdateIndexesFor
```
protected java.util.regex.Pattern buildPatternForDatabasesToUpdateIndexesFor()
```
    In a provisioned environment, only the databases defined by this pattern can be updated.
    
    Returns:
    
    database name pattern
  - uninstall
```
public void uninstall()
```
    Uninstalls the data hub configuration and server-side config files from MarkLogic
    
    Specified by:
    
    uninstall in interface DataHub
  - uninstall
```
public void uninstall(HubDeployStatusListener listener)
```
    Uninstalls the data hub configuration and server-side config files from MarkLogic
    
    Specified by:
    
    uninstall in interface DataHub
    
    Parameters:
    
    listener - - the callback method to receive status updates
  - buildCommandMap
```
public java.util.Map<java.lang.String,java.util.List<com.marklogic.appdeployer.command.Command>> buildCommandMap()
```
  - isSafeToInstall
```
public boolean isSafeToInstall()
```
    Description copied from interface: DataHub
    
    Checks to make sure all the versions and database in a valid configuration with version check Must be run as a user with sufficient privileges to install a data hub.
    
    Specified by:
    
    isSafeToInstall in interface DataHub
    
    Returns:
    
    boolean - if not, returns false, if safe to proceed ahead returns true
  - isPortInUse
```
public boolean isPortInUse(DatabaseKind kind)
```
    Description copied from interface: DataHub
    
    Checks to see if the port is in use
    
    Specified by:
    
    isPortInUse in interface DataHub
    
    Parameters:
    
    kind - - the DatabaseKind enum value (ex STAGING or JOB)
    
    Returns:
    
    true if the port is in use, false if it is not
  - setPortInUseBy
```
public void setPortInUseBy(DatabaseKind kind,
                           java.lang.String usedBy)
```
    Description copied from interface: DataHub
    
    Sets what appserver name is using the port
    
    Specified by:
    
    setPortInUseBy in interface DataHub
    
    Parameters:
    
    kind - - the DatabaseKind enum value (ex STAGING or JOB)
    
    usedBy - - string name of what is using the port
  - getPortInUseBy
```
public java.lang.String getPortInUseBy(DatabaseKind kind)
```
    Description copied from interface: DataHub
    
    Returns name of what is using the port
    
    Specified by:
    
    getPortInUseBy in interface DataHub
    
    Parameters:
    
    kind - - the DatabaseKind enum value (ex STAGING or JOB)
    
    Returns:
    
    name of who using the port
  - isServerVersionOk
```
public boolean isServerVersionOk()
```
    Description copied from interface: DataHub
    
    Checks to see if the datahub and server versions are compatible
    
    Specified by:
    
    isServerVersionOk in interface DataHub
    
    Returns:
    
    true if the server version matches, false if it does not
  - setServerVersionOk
```
public void setServerVersionOk(boolean serverVersionOk)
```
    Description copied from interface: DataHub
    
    Sets true or false if the server version is okay with this version of DHF
    
    Specified by:
    
    setServerVersionOk in interface DataHub
    
    Parameters:
    
    serverVersionOk - - true if it compatible or false if it is not
  - getServerVersion
```
public java.lang.String getServerVersion()
```
    Description copied from interface: DataHub
    
    Returns the string presentation of the server version, eg: "9.03-1"
    
    Specified by:
    
    getServerVersion in interface DataHub
    
    Returns:
    
    server version as a string, eg: "9.03-1"
  - setServerVersion
```
public void setServerVersion(java.lang.String serverVersion)
```
    Description copied from interface: DataHub
    
    Sets the server version holder on the datahub object - currently unused
    
    Specified by:
    
    setServerVersion in interface DataHub
    
    Parameters:
    
    serverVersion - - server version as a string, eg: "9.03-1"
  - upgradeHub
```
public boolean upgradeHub()
                   throws CantUpgradeException
```
    Description copied from interface: DataHub
    
    Upgrades the installed datahub on the server to this version of the DataHub Must be run as a user with sufficient privileges to install a data hub.
    
    Specified by:
    
    upgradeHub in interface DataHub
    
    Returns:
    
    true or false based on success of the upgrade
    
    Throws:
    
    CantUpgradeException - - exception thrown when an upgrade can't happen
  - prepareProjectBeforeUpgrading
```
protected void prepareProjectBeforeUpgrading(HubProject hubProject,
                                             java.lang.String currentDhfVersion)
                                      throws java.io.IOException
```
    The expectation is that a user has upgraded build.gradle to use a newer version of DHF but has not yet updated mlDHFVersion in gradle.properties. Thus, the value of mlDHFVersion is expected to be passed in here so that the backup path of hub-internal-config has the current version of DHF in its name.
    
    Parameters:
    
    hubProject -
    
    currentDhfVersion -
    
    Throws:
    
    java.io.IOException
  - setHubConfig
```
public void setHubConfig(HubConfigImpl hubConfig)
```
  - setVersions
```
public void setVersions(Versions versions)
```

Class DataHubImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

MIN_UPGRADE_VERSION

Constructor Detail

DataHubImpl

Method Detail

wireClient

constructServerManager

clearDatabase

setServerManager

getFlowRunner

isInstalled

isServerVersionValid

initProject

clearUserModules

deleteDocument

buildListOfCommands

getSecurityCommandList

runPreInstallCheck

install

install

disableSomeCmaUsage

deployToDhs

prepareAppConfigForDeployingToDhs

setKnownValuesForDhsDeployment

buildCommandListForDeployingToDhs

updateIndexes

buildPatternForDatabasesToUpdateIndexesFor

uninstall

uninstall

buildCommandMap

isSafeToInstall

isPortInUse

setPortInUseBy

getPortInUseBy

isServerVersionOk

setServerVersionOk

getServerVersion

setServerVersion

upgradeHub

prepareProjectBeforeUpgrading

setHubConfig

setVersions