HubProject (marklogic-data-hub 5.4.2 API)

All Known Implementing Classes:

HubProjectImpl
```
public interface HubProject
```
Creates and gathers information about a hub project. This handles what is initially created on disk for the project.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String HUB_CONFIG_DIR

static java.lang.String PATH_PREFIX

static java.lang.String USER_CONFIG_DIR

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`HUB_CONFIG_DIR`
`static java.lang.String`	`PATH_PREFIX`
`static java.lang.String`	`USER_CONFIG_DIR`

Method Summary

All Methods Instance Methods Abstract 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
`void`	`exportProject(java.io.OutputStream outputStream)` Exports the project content to output stream
`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)`
`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()` Deprecated.
`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.lang.String`	`getProjectName()` Returns the name of the project
`java.nio.file.Path`	`getStepDefinitionPath(StepDefinition.StepDefinitionType type)` Gets the path for the hub step directory by step type
`java.nio.file.Path`	`getStepDefinitionsDir()` Gets the path for the hub step-definitions directory
`java.io.File`	`getStepFile(StepDefinition.StepDefinitionType stepType, java.lang.String stepName)`
`java.nio.file.Path`	`getStepsPath()`
`java.nio.file.Path`	`getStepsPath(StepDefinition.StepDefinitionType 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()` Deprecated.
`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()` Deprecated.
`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
`void`	`setUserModulesDeployTimestampFile(java.lang.String userModulesDeployTimestampFile)`
`void`	`upgradeProject(FlowManager flowManager)` Performs an upgrade to a pre-4.0 project by copying folders to their new positions as defined in hubproject.

- Field Detail
  - PATH_PREFIX
```
static final java.lang.String PATH_PREFIX
```
    See Also:
    
    Constant Field Values
  - HUB_CONFIG_DIR
```
static final java.lang.String HUB_CONFIG_DIR
```
    See Also:
    
    Constant Field Values
  - USER_CONFIG_DIR
```
static final java.lang.String USER_CONFIG_DIR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getProjectDirString
```
java.lang.String getProjectDirString()
```
    Gets the string used to originally make the project
    
    Returns:
    
    The directory string.
  - getHubPluginsDir
```
java.nio.file.Path getHubPluginsDir()
```
    Gets the path for the hub plugins directory
    
    Returns:
    
    the path for the hub plugins directory
  - getStepDefinitionsDir
```
java.nio.file.Path getStepDefinitionsDir()
```
    Gets the path for the hub step-definitions directory
    
    Returns:
    
    the path for the hub step-definitions directory
  - getHubEntitiesDir
```
java.nio.file.Path getHubEntitiesDir()
```
    Gets the path for the hub entities directory
    
    Returns:
    
    the path for the hub entities directory
  - getLegacyHubEntitiesDir
```
java.nio.file.Path getLegacyHubEntitiesDir()
```
    Gets the legacy path for the hub entities directory
    
    Returns:
    
    the legacy path for the hub entities directory
  - getHubMappingsDir
```
java.nio.file.Path getHubMappingsDir()
```
    Gets the path for the hub mappings directory
    
    Returns:
    
    the path for the hub mappings directory
  - getLegacyHubMappingsDir
```
java.nio.file.Path getLegacyHubMappingsDir()
```
    Gets the legacy path for the hub mappings directory
    
    Returns:
    
    the legacy path for the hub mappings directory
  - getStepDefinitionPath
```
java.nio.file.Path getStepDefinitionPath(StepDefinition.StepDefinitionType type)
```
    Gets the path for the hub step directory by step type
    
    Parameters:
    
    type - - a Step type
    
    Returns:
    
    the path for the hub steps directory
  - getHubConfigDir
```
java.nio.file.Path getHubConfigDir()
```
    Gets the path for the hub's config directory
    
    Returns:
    
    the path for the hub's config directory
  - getHubDatabaseDir
```
java.nio.file.Path getHubDatabaseDir()
```
    Gets the path for the hub's database directory
    
    Returns:
    
    the path for the hub's database directory
  - getHubServersDir
```
java.nio.file.Path getHubServersDir()
```
    Gets the path for the hub servers directory
    
    Returns:
    
    the path for the hub servers database directory
  - getHubSecurityDir
```
java.nio.file.Path getHubSecurityDir()
```
    Gets the path for the hub's security directory
    
    Returns:
    
    the path for the hub's security directory
  - getHubTriggersDir
```
java.nio.file.Path getHubTriggersDir()
```
    Gets the path for the hub's triggers directory
    
    Returns:
    
    the path for the hub's triggers directory
  - getUserConfigDir
```
java.nio.file.Path getUserConfigDir()
```
    Gets the path for the user config directory
    
    Returns:
    
    the path for the user config directory
  - getUserSecurityDir
```
java.nio.file.Path getUserSecurityDir()
```
    Gets the path for the user security directory
    
    Returns:
    
    the path for the user security directory
  - getUserDatabaseDir
```
java.nio.file.Path getUserDatabaseDir()
```
    Gets the path for the user database directory
    
    Returns:
    
    the path for the user database directory
  - getUserSchemasDir
```
java.nio.file.Path getUserSchemasDir()
```
    Gets the path for the user schemas directory
    
    Returns:
    
    the path for the user schemas directory
  - getUserServersDir
```
java.nio.file.Path getUserServersDir()
```
    Gets the path for the user servers directory
    
    Returns:
    
    the path for the user servers database directory
  - getEntityConfigDir
```
java.nio.file.Path getEntityConfigDir()
```
    Gets the path for the entity's config directory
    
    Returns:
    
    the path for the entity's config directory
  - getEntityDatabaseDir
```
java.nio.file.Path getEntityDatabaseDir()
```
    Gets the path for the entity database directory
    
    Returns:
    
    the path for the entity's database directory
  - getFlowsDir
```
java.nio.file.Path getFlowsDir()
```
    Gets the path for the flows directory
    
    Returns:
    
    the path for the flows directory
  - getHubStagingModulesDir
```
@Deprecated
java.nio.file.Path getHubStagingModulesDir()
```
    Deprecated.
    
    Gets the path for the hub staging modules
    
    Returns:
    
    the path for the hub staging modules
  - getUserStagingModulesDir
```
@Deprecated
java.nio.file.Path getUserStagingModulesDir()
```
    Deprecated.
    
    Gets the path for the user staging modules
    
    Returns:
    
    the path for the user staging modules
  - getModulesDir
```
java.nio.file.Path getModulesDir()
```
    Gets the path for the modules directory
    
    Returns:
    
    the path for the modules directory
  - getUserFinalModulesDir
```
@Deprecated
java.nio.file.Path getUserFinalModulesDir()
```
    Deprecated.
    
    Gets the path for the user final modules
    
    Returns:
    
    the path for the user final modules
  - getCustomModulesDir
```
java.nio.file.Path getCustomModulesDir()
```
    Gets the path for the custom modules directory
    
    Returns:
    
    the path for the custom modules directory
  - getCustomMappingFunctionsDir
```
java.nio.file.Path getCustomMappingFunctionsDir()
```
    Returns:
    
    the path of the directory for the user to store mapping function library modules
  - isInitialized
```
boolean isInitialized()
```
    Checks if the project has been initialized or not
    
    Returns:
    
    true if initialized, false if not
  - init
```
void init(java.util.Map<java.lang.String,java.lang.String> customTokens)
```
    Initializes a directory as a hub project directory. This means putting certain files and folders in place.
    
    Parameters:
    
    customTokens - - some custom tokens to start with
  - upgradeProject
```
void upgradeProject(FlowManager flowManager)
             throws java.io.IOException
```
    Performs an upgrade to a pre-4.0 project by copying folders to their new positions as defined in hubproject.
    
    Throws:
    
    java.io.IOException - if problem happens with the on-disk project.
  - exportProject
```
void exportProject(java.io.File location)
```
    Exports the project content to disk
  - exportProject
```
void exportProject(java.io.OutputStream outputStream)
```
    Exports the project content to output stream
  - getProjectName
```
java.lang.String getProjectName()
```
    Returns the name of the project
  - getHubModulesDeployTimestampFile
```
java.lang.String getHubModulesDeployTimestampFile()
```
  - getUserModulesDeployTimestampFile
```
java.lang.String getUserModulesDeployTimestampFile()
```
  - setUserModulesDeployTimestampFile
```
void setUserModulesDeployTimestampFile(java.lang.String userModulesDeployTimestampFile)
```
  - getEntityDir
```
java.nio.file.Path getEntityDir(java.lang.String entityName)
```
  - getMappingDir
```
java.nio.file.Path getMappingDir(java.lang.String mappingName)
```
  - getLegacyMappingDir
```
java.nio.file.Path getLegacyMappingDir(java.lang.String mappingName)
```
  - getCustomModuleDir
```
java.nio.file.Path getCustomModuleDir(java.lang.String stepName,
                                      java.lang.String stepType)
```
  - getProjectDir
```
java.nio.file.Path getProjectDir()
```
    Returns the base directory for this project
    
    Returns:
    
    the project's directory as a Path
  - createProject
```
void createProject(java.lang.String projectDirString)
```
  - getStepsPath
```
java.nio.file.Path getStepsPath()
```
    Returns:
    
    the directory containing steps, as defined in the 5.3.0 release
  - getStepsPath
```
java.nio.file.Path getStepsPath(StepDefinition.StepDefinitionType type)
```
    Parameters:
    
    type -
    
    Returns:
    
    the step-type-specific subdirectory of the steps directory (e.g. steps/mapping), as defined in the 5.3.0 release
  - getStepFile
```
java.io.File getStepFile(StepDefinition.StepDefinitionType stepType,
                         java.lang.String stepName)
```
    Parameters:
    
    stepType -
    
    stepName -
    
    Returns:
    
    a File corresponding to a step of the given type and name

Interface HubProject

Field Summary

Method Summary

Field Detail

PATH_PREFIX

HUB_CONFIG_DIR

USER_CONFIG_DIR

Method Detail

getProjectDirString

getHubPluginsDir

getStepDefinitionsDir

getHubEntitiesDir

getLegacyHubEntitiesDir

getHubMappingsDir

getLegacyHubMappingsDir

getStepDefinitionPath

getHubConfigDir

getHubDatabaseDir

getHubServersDir

getHubSecurityDir

getHubTriggersDir

getUserConfigDir

getUserSecurityDir

getUserDatabaseDir

getUserSchemasDir

getUserServersDir

getEntityConfigDir

getEntityDatabaseDir

getFlowsDir

getHubStagingModulesDir

getUserStagingModulesDir

getModulesDir

getUserFinalModulesDir

getCustomModulesDir

getCustomMappingFunctionsDir

isInitialized

init

upgradeProject

exportProject

exportProject

getProjectName

getHubModulesDeployTimestampFile

getUserModulesDeployTimestampFile

setUserModulesDeployTimestampFile

getEntityDir

getMappingDir

getLegacyMappingDir

getCustomModuleDir

getProjectDir

createProject

getStepsPath

getStepsPath

getStepFile