HubProjectImpl (marklogic-data-hub 5.2.3 API)

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

All Implemented Interfaces:: HubProject

@Component
public class HubProjectImpl
extends java.lang.Object
implements HubProject

Class for creating a hub Project

Field Summary

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

Fields inherited from interface com.marklogic.hub.HubProject
HUB_CONFIG_DIR, PATH_PREFIX, USER_CONFIG_DIR

Constructor Summary

Constructors
Constructor and Description

HubProjectImpl()

Constructors
Constructor and Description
`HubProjectImpl()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`createProject(java.lang.String projectDirString)`
`void`	`exportProject(java.io.File location)` Exports the project content to disk
`java.nio.file.Path`	`getCustomMappingFunctionsDir()`
`java.nio.file.Path`	`getCustomModuleDir(java.lang.String stepName, java.lang.String stepType)`
`java.nio.file.Path`	`getCustomModulesDir()` Gets the path for the custom modules directory
`java.nio.file.Path`	`getEntityConfigDir()` Gets the path for the entity's config directory
`java.nio.file.Path`	`getEntityDatabaseDir()` Gets the path for the entity database directory
`java.nio.file.Path`	`getEntityDir(java.lang.String entityName)` Deprecated.
`java.nio.file.Path`	`getFlowsDir()` Gets the path for the flows directory
`java.nio.file.Path`	`getHubConfigDir()` Gets the path for the hub's config directory
`java.nio.file.Path`	`getHubDatabaseDir()` Gets the path for the hub's database directory
`java.nio.file.Path`	`getHubEntitiesDir()` Gets the path for the hub entities directory
`java.nio.file.Path`	`getHubMappingsDir()` Gets the path for the hub mappings directory
`java.lang.String`	`getHubModulesDeployTimestampFile()`
`java.nio.file.Path`	`getHubPluginsDir()` Gets the path for the hub plugins directory
`java.nio.file.Path`	`getHubSecurityDir()` Gets the path for the hub's security directory
`java.nio.file.Path`	`getHubServersDir()` Gets the path for the hub servers directory
`java.nio.file.Path`	`getHubStagingModulesDir()` Gets the path for the hub staging modules
`java.nio.file.Path`	`getHubTriggersDir()` Gets the path for the hub's triggers directory
`java.nio.file.Path`	`getLegacyHubEntitiesDir()` Gets the legacy path for the hub entities directory
`java.nio.file.Path`	`getLegacyHubMappingsDir()` Gets the legacy path for the hub mappings directory
`java.nio.file.Path`	`getLegacyMappingDir(java.lang.String mappingName)`
`java.nio.file.Path`	`getMappingDir(java.lang.String mappingName)`
`java.nio.file.Path`	`getModulesDir()` Gets the path for the modules directory
`java.nio.file.Path`	`getProjectDir()` Returns the base directory for this project
`java.lang.String`	`getProjectDirString()` Gets the string used to originally make the project
`java.nio.file.Path`	`getStepDefinitionsDir()` Gets the path for the hub step-definitions directory
`java.nio.file.Path`	`getStepsDirByType(StepDefinition.StepDefinitionType type)` Gets the path for the hub step directory by step type
`java.nio.file.Path`	`getUserConfigDir()` Gets the path for the user config directory
`java.nio.file.Path`	`getUserDatabaseDir()` Gets the path for the user database directory
`java.nio.file.Path`	`getUserFinalModulesDir()` Gets the path for the user final modules
`java.lang.String`	`getUserModulesDeployTimestampFile()`
`java.nio.file.Path`	`getUserSchemasDir()` Gets the path for the user schemas directory
`java.nio.file.Path`	`getUserSecurityDir()` Gets the path for the user security directory
`java.nio.file.Path`	`getUserServersDir()` Gets the path for the user servers directory
`java.nio.file.Path`	`getUserStagingModulesDir()` Gets the path for the user staging modules
`protected boolean`	`hasEmptyRangeElementIndexArray(com.fasterxml.jackson.databind.node.ObjectNode db)`
`void`	`init(java.util.Map<java.lang.String,java.lang.String> customTokens)` Initializes a directory as a hub project directory.
`boolean`	`isInitialized()` Checks if the project has been initialized or not
`protected void`	`removeEmptyRangeElementIndexArrayFromFinalDatabaseFile()` This method uses warn-level log messages to ensure they appear when upgrading a project via Gradle.
`void`	`setUserModulesDeployTimestampFile(java.lang.String userModulesDeployTimestampFile)`
`protected void`	`upgradeFlows()`
`void`	`upgradeProject()` Performs an upgrade to a pre-4.0 project by copying folders to their new positions as defined in hubproject.

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

- Field Detail
  - ENTITY_CONFIG_DIR
```
public static final java.lang.String ENTITY_CONFIG_DIR
```
    See Also:
    
    Constant Field Values
  - MODULES_DIR
```
public static final java.lang.String MODULES_DIR
```
    See Also:
    
    Constant Field Values
  - USER_SCHEMAS_DIR
```
public static final java.lang.String USER_SCHEMAS_DIR
```
    See Also:
    
    Constant Field Values
  - logger
```
protected final org.slf4j.Logger logger
```
- Constructor Detail
  - HubProjectImpl
```
public HubProjectImpl()
```
- Method Detail
  - getProjectDirString
```
public java.lang.String getProjectDirString()
```
    Description copied from interface: HubProject
    
    Gets the string used to originally make the project
    
    Specified by:
    
    getProjectDirString in interface HubProject
    
    Returns:
    
    The directory string.
  - createProject
```
public void createProject(java.lang.String projectDirString)
```
    Specified by:
    
    createProject in interface HubProject
  - getHubPluginsDir
```
public java.nio.file.Path getHubPluginsDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub plugins directory
    
    Specified by:
    
    getHubPluginsDir in interface HubProject
    
    Returns:
    
    the path for the hub plugins directory
  - getStepDefinitionsDir
```
public java.nio.file.Path getStepDefinitionsDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub step-definitions directory
    
    Specified by:
    
    getStepDefinitionsDir in interface HubProject
    
    Returns:
    
    the path for the hub step-definitions directory
  - getStepsDirByType
```
public java.nio.file.Path getStepsDirByType(StepDefinition.StepDefinitionType type)
```
    Description copied from interface: HubProject
    
    Gets the path for the hub step directory by step type
    
    Specified by:
    
    getStepsDirByType in interface HubProject
    
    Parameters:
    
    type - - a Step type
    
    Returns:
    
    the path for the hub steps directory
  - getHubEntitiesDir
```
public java.nio.file.Path getHubEntitiesDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub entities directory
    
    Specified by:
    
    getHubEntitiesDir in interface HubProject
    
    Returns:
    
    the path for the hub entities directory
  - getHubMappingsDir
```
public java.nio.file.Path getHubMappingsDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub mappings directory
    
    Specified by:
    
    getHubMappingsDir in interface HubProject
    
    Returns:
    
    the path for the hub mappings directory
  - getLegacyHubEntitiesDir
```
public java.nio.file.Path getLegacyHubEntitiesDir()
```
    Description copied from interface: HubProject
    
    Gets the legacy path for the hub entities directory
    
    Specified by:
    
    getLegacyHubEntitiesDir in interface HubProject
    
    Returns:
    
    the legacy path for the hub entities directory
  - getLegacyHubMappingsDir
```
public java.nio.file.Path getLegacyHubMappingsDir()
```
    Description copied from interface: HubProject
    
    Gets the legacy path for the hub mappings directory
    
    Specified by:
    
    getLegacyHubMappingsDir in interface HubProject
    
    Returns:
    
    the legacy path for the hub mappings directory
  - getHubConfigDir
```
public java.nio.file.Path getHubConfigDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub's config directory
    
    Specified by:
    
    getHubConfigDir in interface HubProject
    
    Returns:
    
    the path for the hub's config directory
  - getHubDatabaseDir
```
public java.nio.file.Path getHubDatabaseDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub's database directory
    
    Specified by:
    
    getHubDatabaseDir in interface HubProject
    
    Returns:
    
    the path for the hub's database directory
  - getHubServersDir
```
public java.nio.file.Path getHubServersDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub servers directory
    
    Specified by:
    
    getHubServersDir in interface HubProject
    
    Returns:
    
    the path for the hub servers database directory
  - getHubSecurityDir
```
public java.nio.file.Path getHubSecurityDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub's security directory
    
    Specified by:
    
    getHubSecurityDir in interface HubProject
    
    Returns:
    
    the path for the hub's security directory
  - getHubTriggersDir
```
public java.nio.file.Path getHubTriggersDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub's triggers directory
    
    Specified by:
    
    getHubTriggersDir in interface HubProject
    
    Returns:
    
    the path for the hub's triggers directory
  - getUserConfigDir
```
public java.nio.file.Path getUserConfigDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the user config directory
    
    Specified by:
    
    getUserConfigDir in interface HubProject
    
    Returns:
    
    the path for the user config directory
  - getUserSecurityDir
```
public java.nio.file.Path getUserSecurityDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the user security directory
    
    Specified by:
    
    getUserSecurityDir in interface HubProject
    
    Returns:
    
    the path for the user security directory
  - getUserDatabaseDir
```
public java.nio.file.Path getUserDatabaseDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the user database directory
    
    Specified by:
    
    getUserDatabaseDir in interface HubProject
    
    Returns:
    
    the path for the user database directory
  - getUserSchemasDir
```
public java.nio.file.Path getUserSchemasDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the user schemas directory
    
    Specified by:
    
    getUserSchemasDir in interface HubProject
    
    Returns:
    
    the path for the user schemas directory
  - getUserServersDir
```
public java.nio.file.Path getUserServersDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the user servers directory
    
    Specified by:
    
    getUserServersDir in interface HubProject
    
    Returns:
    
    the path for the user servers database directory
  - getEntityConfigDir
```
public java.nio.file.Path getEntityConfigDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the entity's config directory
    
    Specified by:
    
    getEntityConfigDir in interface HubProject
    
    Returns:
    
    the path for the entity's config directory
  - getEntityDatabaseDir
```
public java.nio.file.Path getEntityDatabaseDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the entity database directory
    
    Specified by:
    
    getEntityDatabaseDir in interface HubProject
    
    Returns:
    
    the path for the entity's database directory
  - getFlowsDir
```
public java.nio.file.Path getFlowsDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the flows directory
    
    Specified by:
    
    getFlowsDir in interface HubProject
    
    Returns:
    
    the path for the flows directory
  - getHubStagingModulesDir
```
public java.nio.file.Path getHubStagingModulesDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the hub staging modules
    
    Specified by:
    
    getHubStagingModulesDir in interface HubProject
    
    Returns:
    
    the path for the hub staging modules
  - getUserStagingModulesDir
```
public java.nio.file.Path getUserStagingModulesDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the user staging modules
    
    Specified by:
    
    getUserStagingModulesDir in interface HubProject
    
    Returns:
    
    the path for the user staging modules
  - getModulesDir
```
public java.nio.file.Path getModulesDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the modules directory
    
    Specified by:
    
    getModulesDir in interface HubProject
    
    Returns:
    
    the path for the modules directory
  - getUserFinalModulesDir
```
public java.nio.file.Path getUserFinalModulesDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the user final modules
    
    Specified by:
    
    getUserFinalModulesDir in interface HubProject
    
    Returns:
    
    the path for the user final modules
  - getCustomModulesDir
```
public java.nio.file.Path getCustomModulesDir()
```
    Description copied from interface: HubProject
    
    Gets the path for the custom modules directory
    
    Specified by:
    
    getCustomModulesDir in interface HubProject
    
    Returns:
    
    the path for the custom modules directory
  - getCustomMappingFunctionsDir
```
public java.nio.file.Path getCustomMappingFunctionsDir()
```
    Specified by:
    
    getCustomMappingFunctionsDir in interface HubProject
    
    Returns:
    
    the path of the directory for the user to store mapping function library modules
  - isInitialized
```
public boolean isInitialized()
```
    Description copied from interface: HubProject
    
    Checks if the project has been initialized or not
    
    Specified by:
    
    isInitialized in interface HubProject
    
    Returns:
    
    true if initialized, false if not
  - init
```
public void init(java.util.Map<java.lang.String,java.lang.String> customTokens)
```
    Description copied from interface: HubProject
    
    Initializes a directory as a hub project directory. This means putting certain files and folders in place.
    
    Specified by:
    
    init in interface HubProject
    
    Parameters:
    
    customTokens - - some custom tokens to start with
  - upgradeProject
```
public void upgradeProject()
                    throws java.io.IOException
```
    Description copied from interface: HubProject
    
    Performs an upgrade to a pre-4.0 project by copying folders to their new positions as defined in hubproject.
    
    Specified by:
    
    upgradeProject in interface HubProject
    
    Throws:
    
    java.io.IOException - if problem happens with the on-disk project.
  - exportProject
```
public void exportProject(java.io.File location)
```
    Description copied from interface: HubProject
    
    Exports the project content to disk
    
    Specified by:
    
    exportProject in interface HubProject
  - upgradeFlows
```
protected void upgradeFlows()
```
  - removeEmptyRangeElementIndexArrayFromFinalDatabaseFile
```
protected void removeEmptyRangeElementIndexArrayFromFinalDatabaseFile()
```
    This method uses warn-level log messages to ensure they appear when upgrading a project via Gradle.
  - hasEmptyRangeElementIndexArray
```
protected boolean hasEmptyRangeElementIndexArray(com.fasterxml.jackson.databind.node.ObjectNode db)
```
  - getHubModulesDeployTimestampFile
```
public java.lang.String getHubModulesDeployTimestampFile()
```
    Specified by:
    
    getHubModulesDeployTimestampFile in interface HubProject
  - getUserModulesDeployTimestampFile
```
public java.lang.String getUserModulesDeployTimestampFile()
```
    Specified by:
    
    getUserModulesDeployTimestampFile in interface HubProject
  - setUserModulesDeployTimestampFile
```
public void setUserModulesDeployTimestampFile(java.lang.String userModulesDeployTimestampFile)
```
    Specified by:
    
    setUserModulesDeployTimestampFile in interface HubProject
  - getEntityDir
```
@Deprecated
public java.nio.file.Path getEntityDir(java.lang.String entityName)
```
    Deprecated.
    
    Specified by:
    
    getEntityDir in interface HubProject
  - getMappingDir
```
public java.nio.file.Path getMappingDir(java.lang.String mappingName)
```
    Specified by:
    
    getMappingDir in interface HubProject
  - getLegacyMappingDir
```
public java.nio.file.Path getLegacyMappingDir(java.lang.String mappingName)
```
    Specified by:
    
    getLegacyMappingDir in interface HubProject
  - getCustomModuleDir
```
public java.nio.file.Path getCustomModuleDir(java.lang.String stepName,
                                             java.lang.String stepType)
```
    Specified by:
    
    getCustomModuleDir in interface HubProject
  - getProjectDir
```
public java.nio.file.Path getProjectDir()
```
    Description copied from interface: HubProject
    
    Returns the base directory for this project
    
    Specified by:
    
    getProjectDir in interface HubProject
    
    Returns:
    
    the project's directory as a Path

Class HubProjectImpl

Field Summary

Fields inherited from interface com.marklogic.hub.HubProject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENTITY_CONFIG_DIR

MODULES_DIR

USER_SCHEMAS_DIR

logger

Constructor Detail

HubProjectImpl

Method Detail

getProjectDirString

createProject

getHubPluginsDir

getStepDefinitionsDir

getStepsDirByType

getHubEntitiesDir

getHubMappingsDir

getLegacyHubEntitiesDir

getLegacyHubMappingsDir

getHubConfigDir

getHubDatabaseDir

getHubServersDir

getHubSecurityDir

getHubTriggersDir

getUserConfigDir

getUserSecurityDir

getUserDatabaseDir

getUserSchemasDir

getUserServersDir

getEntityConfigDir

getEntityDatabaseDir

getFlowsDir

getHubStagingModulesDir

getUserStagingModulesDir

getModulesDir

getUserFinalModulesDir

getCustomModulesDir

getCustomMappingFunctionsDir

isInitialized

init

upgradeProject

exportProject

upgradeFlows

removeEmptyRangeElementIndexArrayFromFinalDatabaseFile

hasEmptyRangeElementIndexArray

getHubModulesDeployTimestampFile

getUserModulesDeployTimestampFile

setUserModulesDeployTimestampFile

getEntityDir

getMappingDir

getLegacyMappingDir

getCustomModuleDir

getProjectDir