DataHub (marklogic-data-hub 5.4.2 API)

All Known Implementing Classes:

DataHubImpl
```
public interface DataHub
```
Handles creation and orchastration of DHF with a MarkLogic server. Includes installs, version validation, updates, and the init of a DHF project.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearDatabase(java.lang.String database)` Clears the database of all documents
`void`	`clearUserModules()` Removes user's modules from the modules db
`void`	`deleteDocument(java.lang.String uri, com.marklogic.hub.DatabaseKind databaseKind)` Deletes document based on supplied doc uri in supplied database
`FlowRunner`	`getFlowRunner()` Creates and returns the FlowRunner object using the datahub's autowired hubconfig
`java.lang.String`	`getPortInUseBy(com.marklogic.hub.DatabaseKind kind)` Returns name of what is using the port
`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 Must be run as a user with sufficient privileges to install a data hub.
`void`	`install(HubDeployStatusListener listener)` Installs the data hub configuration and server-side config files into MarkLogic Must be run as a user with sufficient privileges to install a data hub.
`InstallInfo`	`isInstalled()` Determines if the data hub is installed in MarkLogic
`boolean`	`isPortInUse(com.marklogic.hub.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
`java.util.Map<java.lang.String,java.lang.Object>`	`runPreInstallCheck()` Runs the pre-install check for the datahub populating the object with variables necessary to perform the install.
`void`	`setPortInUseBy(com.marklogic.hub.DatabaseKind kind, java.lang.String usedBy)` Sets what appserver name is using the port
`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`	`uninstall()` Uninstalls the data hub configuration, server-side config files and final databases and servers from MarkLogic Must be run as a user with sufficient privileges to install a data hub.
`void`	`uninstall(HubDeployStatusListener listener)` Uninstalls the data hub configuration, server-side config files and final databases and servers from MarkLogic Must be run as a user with sufficient privileges to install a data hub.
`void`	`updateIndexes()` Updates the indexes in the database based on the project Must be run as a user with flow-developer-role or equivalent
`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.

- Method Detail
  - clearDatabase
```
void clearDatabase(java.lang.String database)
```
    Clears the database of all documents
    
    Parameters:
    
    database - - the name of the database in string form
  - isInstalled
```
InstallInfo isInstalled()
```
    Determines if the data hub is installed in MarkLogic
    
    Returns:
    
    true if installed, false otherwise
  - isServerVersionValid
```
boolean isServerVersionValid(java.lang.String versionString)
```
    Validates the MarkLogic server to ensure compatibility with the hub
    
    Parameters:
    
    versionString - - the version of the server to validate
    
    Returns:
    
    true if valid, false otherwise
    
    Throws:
    
    ServerValidationException - if the server is not compatible
  - initProject
```
void initProject()
```
    Initializes the project on disk, creates scaffold project code
  - clearUserModules
```
void clearUserModules()
```
    Removes user's modules from the modules db
  - deleteDocument
```
void deleteDocument(java.lang.String uri,
                    com.marklogic.hub.DatabaseKind databaseKind)
```
    Deletes document based on supplied doc uri in supplied database
    
    Parameters:
    
    uri - - document uri
    
    databaseKind - - database type
  - runPreInstallCheck
```
java.util.Map<java.lang.String,java.lang.Object> runPreInstallCheck()
```
    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.
    
    Returns:
    
    - a hashmap of the results of the preinstall check
  - install
```
void install()
```
    Installs the data hub configuration and server-side config files into MarkLogic Must be run as a user with sufficient privileges to install a data hub.
  - install
```
void install(HubDeployStatusListener listener)
```
    Installs the data hub configuration and server-side config files into MarkLogic Must be run as a user with sufficient privileges to install a data hub.
    
    Parameters:
    
    listener - - the callback method to receive status updates
  - updateIndexes
```
void updateIndexes()
```
    Updates the indexes in the database based on the project Must be run as a user with flow-developer-role or equivalent
  - uninstall
```
void uninstall()
```
    Uninstalls the data hub configuration, server-side config files and final databases and servers from MarkLogic Must be run as a user with sufficient privileges to install a data hub.
  - uninstall
```
void uninstall(HubDeployStatusListener listener)
```
    Uninstalls the data hub configuration, server-side config files and final databases and servers from MarkLogic Must be run as a user with sufficient privileges to install a data hub.
    
    Parameters:
    
    listener - - the callback method to receive status updates
  - isSafeToInstall
```
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.
    
    Returns:
    
    boolean - if not, returns false, if safe to proceed ahead returns true
  - isPortInUse
```
boolean isPortInUse(com.marklogic.hub.DatabaseKind kind)
```
    Checks to see if the port is in use
    
    Parameters:
    
    kind - - the DatabaseKind enum value (ex STAGING or JOB)
    
    Returns:
    
    true if the port is in use, false if it is not
  - setPortInUseBy
```
void setPortInUseBy(com.marklogic.hub.DatabaseKind kind,
                    java.lang.String usedBy)
```
    Sets what appserver name is using the port
    
    Parameters:
    
    kind - - the DatabaseKind enum value (ex STAGING or JOB)
    
    usedBy - - string name of what is using the port
  - getPortInUseBy
```
java.lang.String getPortInUseBy(com.marklogic.hub.DatabaseKind kind)
```
    Returns name of what is using the port
    
    Parameters:
    
    kind - - the DatabaseKind enum value (ex STAGING or JOB)
    
    Returns:
    
    name of who using the port
  - isServerVersionOk
```
boolean isServerVersionOk()
```
    Checks to see if the datahub and server versions are compatible
    
    Returns:
    
    true if the server version matches, false if it does not
  - setServerVersionOk
```
void setServerVersionOk(boolean serverVersionOk)
```
    Sets true or false if the server version is okay with this version of DHF
    
    Parameters:
    
    serverVersionOk - - true if it compatible or false if it is not
  - getServerVersion
```
java.lang.String getServerVersion()
```
    Returns the string presentation of the server version, eg: "9.03-1"
    
    Returns:
    
    server version as a string, eg: "9.03-1"
  - setServerVersion
```
void setServerVersion(java.lang.String serverVersion)
```
    Sets the server version holder on the datahub object - currently unused
    
    Parameters:
    
    serverVersion - - server version as a string, eg: "9.03-1"
  - upgradeHub
```
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.
    
    Returns:
    
    true or false based on success of the upgrade
  - getFlowRunner
```
FlowRunner getFlowRunner()
```
    Creates and returns the FlowRunner object using the datahub's autowired hubconfig
    
    Returns:
    
    FlowRunner object with current hubconfig already set

Interface DataHub

Method Summary

Method Detail

clearDatabase

isInstalled

isServerVersionValid

initProject

clearUserModules

deleteDocument

runPreInstallCheck

install

install

updateIndexes

uninstall

uninstall

isSafeToInstall

isPortInUse

setPortInUseBy

getPortInUseBy

isServerVersionOk

setServerVersionOk

getServerVersion

setServerVersion

upgradeHub

getFlowRunner