Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W 

A

AbstractStepDefinition - Class in com.marklogic.hub.step
 
AbstractStepDefinition() - Constructor for class com.marklogic.hub.step.AbstractStepDefinition
 
accept(File) - Method in class com.marklogic.hub.deploy.util.HubFileFilter
 
accept(Set<Resource>) - Method in class com.marklogic.hub.deploy.util.ModuleWatchingConsumer
 
acceptFile(String) - Method in class com.marklogic.hub.step.impl.FileCollector
 
addDefinition(String, DefinitionType) - Method in class com.marklogic.hub.entity.DefinitionsType
 
addDhfPropertiesToCustomTokens(AppConfig) - Method in class com.marklogic.hub.impl.HubConfigImpl
Populates the custom tokens map in the given AppConfig object.
addEntityConfigToConfigDirs(HubProject, AppConfig) - Method in class com.marklogic.hub.deploy.HubDeployer
Because the hub-internal-config directory is excluded, the staging database won't be updated unless the user has a staging-database.json file in their ml-config directory.
addExistingFields(Fragment, Fragment) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
addExistingFieldsAndRangeFieldIndexes(String, ResourceManager) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
addExistingPathNamespaces(Fragment, Fragment) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
addExistingRangeFieldIndexes(Fragment, Fragment) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
addExistingRangePathIndexes(Fragment, Fragment) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
addStepToFlow(String, String, String) - Method in interface com.marklogic.hub.dataservices.FlowService
Invokes the addStepToFlow operation on the database server
addStepToFlow(String, String, String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
addSubProperties(HubEntity, List<HubEntity>, String) - Method in class com.marklogic.hub.impl.EntityManagerImpl
Adds "sub" properties - i.e.
addToCollections(ObjectNode, JsonNode, String) - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
For any step, ensure that the stepName is in the collections array.
adjustPayloadBeforeSavingResource(CommandContext, File, String) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
afterPropertiesSet() - Method in class com.marklogic.hub.impl.DataHubImpl
 
ApplicationConfig - Class in com.marklogic.hub
Spring configuration for accessing DHF components, along with a single HubConfigImpl use.
ApplicationConfig() - Constructor for class com.marklogic.hub.ApplicationConfig
 
applyDefaultPermissionPropertyValues() - Method in class com.marklogic.hub.impl.HubConfigImpl
This is called by applyDefaultPropertyValues, but is separate for testing purposes.
applyDefaultPropertyValues() - Method in class com.marklogic.hub.impl.HubConfigImpl
Applies values that, prior to 5.3.0, were stored in the dhf-defaults.properties file that was available from the classpath.
applyHubCentralZipToProject(HubProject, File) - Method in class com.marklogic.hub.hubcentral.HubCentralManager
 
applyProperties(Properties) - Method in class com.marklogic.hub.impl.HubConfigImpl
Applies properties in the given properties to this instance.
applyProperties(PropertySource) - Method in class com.marklogic.hub.impl.HubConfigImpl
Applies properties in the given property source to this instance.
applyProperties(PropertySource, AppConfig, ManageConfig, AdminConfig) - Method in class com.marklogic.hub.impl.HubConfigImpl
Applies properties in the given property source to this instance.
areForestsExistent(DatabaseKind) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
areForestsExistent(DatabaseKind) - Method in interface com.marklogic.hub.InstallInfo
Checks to see if the forests are present and accessible
ArtifactService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
awaitCompletion() - Method in interface com.marklogic.hub.flow.FlowRunner
Blocks until the flow execution is complete.
awaitCompletion(long, TimeUnit) - Method in interface com.marklogic.hub.flow.FlowRunner
Blocks until the flow execution is complete.
awaitCompletion() - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
awaitCompletion(long, TimeUnit) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
awaitCompletion() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
awaitCompletion(long, TimeUnit) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
awaitCompletion() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Blocks until the job is complete.
awaitCompletion(long, TimeUnit) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Blocks until the job is complete.
awaitCompletion() - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
awaitCompletion(long, TimeUnit) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
awaitCompletion() - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
awaitCompletion(long, TimeUnit) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
awaitCompletion() - Method in interface com.marklogic.hub.step.StepRunner
Blocks until the step execution is complete.
awaitCompletion(long, TimeUnit) - Method in interface com.marklogic.hub.step.StepRunner
Blocks until the step execution is complete.

B

baseUri - Variable in class com.marklogic.hub.entity.InfoType
 
build() - Method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
buildCommandMap() - Method in class com.marklogic.hub.impl.DataHubImpl
 
buildCommandsForDeployingToReplica() - Method in class com.marklogic.hub.impl.DataHubImpl
 
buildCommandsForDeveloper(HubConfig) - Method in class com.marklogic.hub.deploy.HubDeployer
 
buildCommandsForReplica(HubConfig) - Method in class com.marklogic.hub.deploy.HubDeployer
 
buildCommandsForSecurityAdmin() - Method in class com.marklogic.hub.deploy.HubDeployer
 
buildFlowFromDefaultFlow(Map<String, String>) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
buildFlowInputs() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
buildFlowOptions() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
buildGranularPrivileges(ManageClient) - Method in class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
 
buildListOfCommands() - Method in class com.marklogic.hub.impl.DataHubImpl
 
buildMetadata(String, String) - Method in class com.marklogic.hub.deploy.commands.LoadHubArtifactsCommand
As of 5.2.0, artifact permissions are separate from module permissions.
buildMetadata(String, String) - Method in class com.marklogic.hub.deploy.commands.LoadUserArtifactsCommand
As of 5.2.0, artifact permissions are separate from module permissions.
buildPatternForDatabasesToUpdateIndexesFor() - Method in class com.marklogic.hub.deploy.HubDeployer
In a provisioned environment, only the databases defined by this pattern can be updated.
buildPatternForDatabasesToUpdateIndexesFor() - Method in class com.marklogic.hub.impl.DataHubImpl
In a provisioned environment, only the databases defined by this pattern can be updated.
buildPrettyWriter() - Method in class com.marklogic.hub.hubcentral.HubCentralManager
 
buildStepArtifact(JsonNode, Mapping, String) - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
Extracted for easy unit testing; has no dependencies on anything other than the inputs.
buildStepConfig(StringBuilder) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
BulkUtil - Class in com.marklogic.hub.dataservices
 
BulkUtil() - Constructor for class com.marklogic.hub.dataservices.BulkUtil
 

C

CacheBusterDocumentFileProcessor - Class in com.marklogic.client.ext.file
 
CacheBusterDocumentFileProcessor() - Constructor for class com.marklogic.client.ext.file.CacheBusterDocumentFileProcessor
 
calculateMatchingActivity(String) - Method in interface com.marklogic.hub.dataservices.MasteringService
Invokes the calculateMatchingActivity operation on the database server
calculateMergingActivity(String) - Method in interface com.marklogic.hub.dataservices.MasteringService
Calculates tangential information about a merging step to provide configuration insights.
CANCELED_PREFIX - Static variable in enum com.marklogic.hub.flow.impl.JobStatus
 
clear() - Method in class com.marklogic.hub.legacy.collector.DiskQueue
 
clear() - Method in class com.marklogic.hub.util.DiskQueue
 
clearUserArtifacts() - Method in interface com.marklogic.hub.dataservices.ArtifactService
Invokes the clearUserArtifacts operation on the database server
clearUserArtifacts() - Method in class com.marklogic.hub.impl.DataHubImpl
 
clearUserData() - Method in class com.marklogic.hub.impl.DataHubImpl
Clear "user data", which is anything that's not a user or hub artifact.
clearUserData(String, String) - Method in class com.marklogic.hub.impl.DataHubImpl
 
clearUserModules() - Method in interface com.marklogic.hub.DataHub
Removes user's modules from the modules db
clearUserModules() - Method in class com.marklogic.hub.impl.DataHubImpl
 
clearUserModules(List<String>) - Method in class com.marklogic.hub.impl.DataHubImpl
 
clearUserSchemas() - Method in class com.marklogic.hub.impl.DataHubImpl
 
close() - Method in class com.marklogic.hub.legacy.collector.DiskQueue
 
close() - Method in class com.marklogic.hub.util.DiskQueue
 
cmaShouldBeUsed(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployHubAmpsCommand
 
cmaShouldBeUsed(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployHubQueryRolesetsCommand
 
CodeFormat - Enum in com.marklogic.hub.legacy.flow
 
collation - Variable in class com.marklogic.hub.entity.ItemType
 
collation - Variable in class com.marklogic.hub.entity.PropertyType
 
com.marklogic.client.ext.file - package com.marklogic.client.ext.file
 
com.marklogic.client.ext.modulesloader.impl - package com.marklogic.client.ext.modulesloader.impl
 
com.marklogic.hub - package com.marklogic.hub
 
com.marklogic.hub.dataservices - package com.marklogic.hub.dataservices
 
com.marklogic.hub.deploy - package com.marklogic.hub.deploy
 
com.marklogic.hub.deploy.commands - package com.marklogic.hub.deploy.commands
 
com.marklogic.hub.deploy.util - package com.marklogic.hub.deploy.util
 
com.marklogic.hub.entity - package com.marklogic.hub.entity
 
com.marklogic.hub.error - package com.marklogic.hub.error
 
com.marklogic.hub.ext.mlunittest - package com.marklogic.hub.ext.mlunittest
 
com.marklogic.hub.flow - package com.marklogic.hub.flow
 
com.marklogic.hub.flow.impl - package com.marklogic.hub.flow.impl
 
com.marklogic.hub.hubcentral - package com.marklogic.hub.hubcentral
 
com.marklogic.hub.hubcentral.conversion - package com.marklogic.hub.hubcentral.conversion
 
com.marklogic.hub.impl - package com.marklogic.hub.impl
 
com.marklogic.hub.legacy - package com.marklogic.hub.legacy
 
com.marklogic.hub.legacy.collector - package com.marklogic.hub.legacy.collector
 
com.marklogic.hub.legacy.collector.impl - package com.marklogic.hub.legacy.collector.impl
 
com.marklogic.hub.legacy.flow - package com.marklogic.hub.legacy.flow
 
com.marklogic.hub.legacy.flow.impl - package com.marklogic.hub.legacy.flow.impl
 
com.marklogic.hub.legacy.impl - package com.marklogic.hub.legacy.impl
 
com.marklogic.hub.legacy.job - package com.marklogic.hub.legacy.job
 
com.marklogic.hub.legacy.job.impl - package com.marklogic.hub.legacy.job.impl
 
com.marklogic.hub.legacy.validate - package com.marklogic.hub.legacy.validate
 
com.marklogic.hub.legacy.validate.impl - package com.marklogic.hub.legacy.validate.impl
 
com.marklogic.hub.mapping - package com.marklogic.hub.mapping
 
com.marklogic.hub.provenance - package com.marklogic.hub.provenance
 
com.marklogic.hub.step - package com.marklogic.hub.step
 
com.marklogic.hub.step.impl - package com.marklogic.hub.step.impl
 
com.marklogic.hub.util - package com.marklogic.hub.util
 
com.marklogic.hub.util.json - package com.marklogic.hub.util.json
 
CommandLineFlowInputs - Class in com.marklogic.hub.impl
Defines command-line-specific inputs for running a flow.
CommandLineFlowInputs() - Constructor for class com.marklogic.hub.impl.CommandLineFlowInputs
 
compare(String, String) - Static method in class com.marklogic.hub.impl.Versions
 
COMPLETED_PREFIX - Static variable in enum com.marklogic.hub.flow.impl.JobStatus
 
COMPLETED_WITH_ERRORS_PREFIX - Static variable in enum com.marklogic.hub.flow.impl.JobStatus
 
completedItems - Variable in class com.marklogic.hub.legacy.flow.RunFlowResponse
 
completedItems - Variable in class com.marklogic.hub.step.ResponseHolder
 
ConceptService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
configureForDhs() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
configureStopOnError(Flow, Map<String, Object>) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
To support the "failHard" parameter in CommandLineFlowInputs, this method checks for stopOnError in the options map.
constructServerManager(HubConfig) - Method in class com.marklogic.hub.impl.DataHubImpl
Need to account for the group name in case the user has overridden the name of the "Default" group.
ContentPlugin(DatabaseClient) - Constructor for class com.marklogic.hub.impl.ScaffoldingImpl.ContentPlugin
 
convertArtifactToJson(Object) - Static method in class com.marklogic.hub.util.json.JSONUtils
 
convertEntityModels() - Method in class com.marklogic.hub.hubcentral.conversion.HubCentralConverter
Convert the entity model files in a user's local project.
convertFlows() - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
Convert the flow files in a user's local project.
convertMapToJsonString(Map<String, Object>) - Method in class com.marklogic.hub.util.json.JSONObject
Converts a Map (String, Object) to a Json String
convertModelFilesToEntityDefinitions(List<HubEntity>) - Method in class com.marklogic.hub.impl.EntityManagerImpl
An entity model file can contain one to many entity definitions.
convertUserArtifacts() - Method in class com.marklogic.hub.hubcentral.conversion.HubCentralConverter
Convert the entity model, flow and mapping files in a user's local project.
copy(InputStream, File) - Static method in class com.marklogic.hub.util.FileUtil
 
copyJobDataToResponse(RunFlowResponse, RunFlowResponse) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
create() - Static method in interface com.marklogic.hub.InstallInfo
Creates and returns an installinfo object
create(DatabaseClient) - Static method in interface com.marklogic.hub.legacy.job.LegacyJobManager
Creates and returns a LegacyJobManager object
create(DatabaseClient) - Static method in interface com.marklogic.hub.legacy.LegacyDebugging
Creates and returns a debugging object
create(DatabaseClient) - Static method in interface com.marklogic.hub.legacy.LegacyTracing
Creates and returns a tracing object
create(DatabaseClient) - Static method in interface com.marklogic.hub.legacy.validate.EntitiesValidator
Creates and returns a an EntityValidator object
create(String) - Static method in interface com.marklogic.hub.mapping.Mapping
Creates an in-memory default instance of a mapping given a name
create(String, HubEntity) - Static method in interface com.marklogic.hub.mapping.Mapping
Creates an in-memory default instance of a mapping given a name
create(String, StepDefinition.StepDefinitionType) - Static method in interface com.marklogic.hub.step.StepDefinition
Creates an in-memory default instance of a Step given a name and a type
createCustomModule(String, String) - Method in interface com.marklogic.hub.impl.Scaffolding
Creates a custom module given a string stepName
createCustomModule(String, String, String) - Method in interface com.marklogic.hub.impl.Scaffolding
Creates a custom module given a string stepName
createCustomModule(String, String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createCustomModule(String, String, String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createCustomRewriters() - Method in interface com.marklogic.hub.dataservices.SystemService
Creates custom rewriter modules for the staging and job app servers
createCustomRewriters() - Method in class com.marklogic.hub.deploy.commands.LoadHubModulesCommand
 
CreatedByStepFixer - Class in com.marklogic.hub.util
Bulk API-based program for fixed the datahubCreatedByStep metadata value so that, when possible, it is a step name instead of a step definition name.
CreatedByStepFixer(HubClient) - Constructor for class com.marklogic.hub.util.CreatedByStepFixer
 
createDefaultFlow(String) - Method in interface com.marklogic.hub.impl.Scaffolding
Create default flow with all the default steps
createDefaultFlow(String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createDraftModel(JsonNode) - Method in interface com.marklogic.hub.dataservices.ConceptService
Create a new draft model, resulting in a new Concept descriptor.
createDraftModel(JsonNode) - Method in interface com.marklogic.hub.dataservices.ModelsService
Create a new draft model, resulting in a new entity descriptor with a primary entity type in it.
createEntity(String) - Method in interface com.marklogic.hub.impl.Scaffolding
Creates an entity given a string name
createEntity(String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createEntityNameFileMap(List<File>) - Static method in class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
createFlow(String, String) - Method in interface com.marklogic.hub.dataservices.FlowService
Invokes the createFlow operation on the database server
createFlow(String) - Method in interface com.marklogic.hub.FlowManager
Creates a flow
createFlow(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
createFlowFromJSON(String) - Method in interface com.marklogic.hub.FlowManager
Creates a flow from a given JSON string
createFlowFromJSON(JsonNode) - Method in interface com.marklogic.hub.FlowManager
Creates a flow from a given JsonNode
createFlowFromJSON(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
createFlowFromJSON(JsonNode) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
CreateGranularPrivilegesCommand - Class in com.marklogic.hub.deploy.commands
Command for creating granular privileges after the resources that these privileges depend on have been created.
CreateGranularPrivilegesCommand(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
 
CreateGranularPrivilegesCommand(HubConfig, List<String>) - Constructor for class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
 
createLegacyFlow(String, String, FlowType, CodeFormat, DataFormat) - Method in interface com.marklogic.hub.impl.Scaffolding
Creates a flow for an entity with Entity Services model as default
createLegacyFlow(String, String, FlowType, CodeFormat, DataFormat, boolean) - Method in interface com.marklogic.hub.impl.Scaffolding
Creates a flow for an entity with an additional option for using Entity Services
createLegacyFlow(String, String, FlowType, CodeFormat, DataFormat, boolean, String) - Method in interface com.marklogic.hub.impl.Scaffolding
Creates a flow for an entity with an additional option for using Entity Services
createLegacyFlow(String, String, FlowType, CodeFormat, DataFormat) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createLegacyFlow(String, String, FlowType, CodeFormat, DataFormat, boolean) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createLegacyFlow(String, String, FlowType, CodeFormat, DataFormat, boolean, String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createLegacyMappingDir(String) - Method in interface com.marklogic.hub.impl.Scaffolding
Creates a legacy mapping given a string name
createLegacyMappingDir(String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createMapping(String) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
createMapping(String, String) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
createMapping(String) - Method in interface com.marklogic.hub.MappingManager
Creates a mapping given a string name
createMapping(String, String) - Method in interface com.marklogic.hub.MappingManager
Creates a mapping given a string name
createMappingDir(String) - Method in interface com.marklogic.hub.impl.Scaffolding
Creates a mapping given a string name
createMappingDir(String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createMappingFromJSON(String) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
createMappingFromJSON(JsonNode) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
createMappingFromJSON(String) - Method in interface com.marklogic.hub.MappingManager
Creates a mapping from a given JSON string
createMappingFromJSON(JsonNode) - Method in interface com.marklogic.hub.MappingManager
Creates a mapping from a given JsonNode
createProject(String) - Method in interface com.marklogic.hub.HubConfig
Initializes the java application state to a specific location.
createProject(String) - Method in interface com.marklogic.hub.HubProject
 
createProject(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
createProject(String) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
createStepArtifact(String, JsonNode) - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
 
createStepDefinition(String, String, String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
createStepDefinitionFromJSON(JsonNode) - Method in class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
createStepDefinitionFromJSON(JsonNode) - Method in interface com.marklogic.hub.StepDefinitionManager
Creates a Step Definition from a given JsonNode
createStepFile(String, String, String, String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
Create a step file based on the given stepName, stepType, entityType (for non ingestion steps), and stepDefName.
createStepResponse(Flow, String, String) - Static method in class com.marklogic.hub.step.impl.StepRunnerUtil
 
csvFilesProcessed - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 
customForestPath - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
CustomStepDefinitionImpl - Class in com.marklogic.hub.step.impl
 
CustomStepDefinitionImpl(String) - Constructor for class com.marklogic.hub.step.impl.CustomStepDefinitionImpl
 
CustomStepService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server

D

DataFormat - Enum in com.marklogic.hub.legacy.flow
 
DataHub - Interface in com.marklogic.hub
Handles creation and orchastration of DHF with a MarkLogic server.
DataHubConfigurationException - Exception in com.marklogic.hub.error
An exception to wrap issues found while configuring Data Hub
DataHubConfigurationException() - Constructor for exception com.marklogic.hub.error.DataHubConfigurationException
 
DataHubConfigurationException(String) - Constructor for exception com.marklogic.hub.error.DataHubConfigurationException
 
DataHubConfigurationException(String, Throwable) - Constructor for exception com.marklogic.hub.error.DataHubConfigurationException
 
DataHubConfigurationException(Throwable) - Constructor for exception com.marklogic.hub.error.DataHubConfigurationException
 
DataHubImpl - Class in com.marklogic.hub.impl
 
DataHubImpl() - Constructor for class com.marklogic.hub.impl.DataHubImpl
 
DataHubImpl(HubConfig) - Constructor for class com.marklogic.hub.impl.DataHubImpl
 
DataHubImpl(HubClient) - Constructor for class com.marklogic.hub.impl.DataHubImpl
Only use this constructor for the clearUserData operation, which does not depend on a HubConfig.
DataHubProjectException - Exception in com.marklogic.hub.error
An exception for issues when retrieving data from the project directory.
DataHubProjectException() - Constructor for exception com.marklogic.hub.error.DataHubProjectException
 
DataHubProjectException(String) - Constructor for exception com.marklogic.hub.error.DataHubProjectException
 
DataHubProjectException(String, Throwable) - Constructor for exception com.marklogic.hub.error.DataHubProjectException
 
DataHubProjectException(Throwable) - Constructor for exception com.marklogic.hub.error.DataHubProjectException
 
datatype - Variable in class com.marklogic.hub.entity.ItemType
 
datatype - Variable in class com.marklogic.hub.entity.PropertyType
 
DEFAULT_AUTH_METHOD - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_BATCH_SIZE - Static variable in class com.marklogic.hub.flow.impl.FlowImpl
 
DEFAULT_CUSTOM_FOREST_PATH - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_DEVELOPER_ROLE_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_FINAL_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_FINAL_PORT - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_FINAL_SCHEMAS_DB_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_FINAL_TRIGGERS_DB_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_FORESTS_PER_HOST - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_HUB_LOG_LEVEL - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_JOB_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_JOB_PORT - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_MODULES_DB_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_ROLE_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_SCHEME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_STAGING_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_STAGING_PORT - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_STAGING_SCHEMAS_DB_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_STAGING_TRIGGERS_DB_NAME - Static variable in interface com.marklogic.hub.HubConfig
 
DEFAULT_STOP_ONERROR - Static variable in class com.marklogic.hub.flow.impl.FlowImpl
 
DEFAULT_THREAD_COUNT - Static variable in class com.marklogic.hub.flow.impl.FlowImpl
 
definitions - Variable in class com.marklogic.hub.entity.DefinitionsType
 
definitions - Variable in class com.marklogic.hub.entity.HubEntity
 
DefinitionsType - Class in com.marklogic.hub.entity
 
DefinitionsType() - Constructor for class com.marklogic.hub.entity.DefinitionsType
 
DefinitionType - Class in com.marklogic.hub.entity
 
DefinitionType() - Constructor for class com.marklogic.hub.entity.DefinitionType
 
deleteData(DatabaseClient, String, String) - Static method in class com.marklogic.hub.dataservices.BulkUtil
 
deletedJobs - Variable in class com.marklogic.hub.legacy.job.JobDeleteResponse
 
deleteDocumentsInDirectory(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
deleteDraftModel(String) - Method in interface com.marklogic.hub.dataservices.ConceptService
Mark a draft concept class to be deleted
deleteDraftModel(String) - Method in interface com.marklogic.hub.dataservices.ModelsService
Mark a draft entity model to be deleted
deletedTraces - Variable in class com.marklogic.hub.legacy.job.JobDeleteResponse
 
deleteEntity(String) - Method in interface com.marklogic.hub.EntityManager
 
deleteEntity(String) - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
deleteEntityBasedArtifacts(HubProject) - Method in class com.marklogic.hub.hubcentral.HubCentralManager
 
deleteFlow(String) - Method in interface com.marklogic.hub.dataservices.FlowService
Invokes the deleteFlow operation on the database server
deleteFlow(String) - Method in interface com.marklogic.hub.FlowManager
Deletes a flow
deleteFlow(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
deleteHubCentralConfig(HubClient) - Method in class com.marklogic.hub.hubcentral.HubCentralManager
 
deleteJobs(String) - Method in class com.marklogic.hub.flow.JobManager
 
deleteJobs(String) - Method in class com.marklogic.hub.legacy.job.impl.LegacyJobManagerImpl
 
deleteJobs(String) - Method in class com.marklogic.hub.legacy.job.impl.LegacyJobManagerImpl.JobDeleteResource
 
deleteJobs(String) - Method in interface com.marklogic.hub.legacy.job.LegacyJobManager
 
deleteLegacyMappings() - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
After flows have been converted, a user needs to delete any legacy mappings that exist, as these have now been converted to mapping steps.
deleteMapping(String) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
deleteMapping(String) - Method in interface com.marklogic.hub.MappingManager
Deletes a defined mapping by string name
deleteMappingArtifacts(Flow, Step) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
deleteNotifications(List<String>) - Method in class com.marklogic.hub.impl.MasteringManagerImpl
 
deleteNotifications(List<String>) - Method in interface com.marklogic.hub.MasteringManager
 
deleteProvenance(Reader, Reader) - Method in interface com.marklogic.hub.dataservices.ProvenanceService
Deletes provenance according to the retainDuration property provided in endpointConstants.
deleteProvenanceRecords(String) - Method in class com.marklogic.hub.provenance.ProvenanceManager
 
deleteProvenanceRecords(String, String) - Method in class com.marklogic.hub.provenance.ProvenanceManager
 
deleteRelatedStepArtifacts(Flow, Step) - Method in class com.marklogic.hub.impl.FlowManagerImpl
For certain step types, when the step is deleted, we need to do some cleanup of artifacts on disk and in the staging and final databases.
deleteSavedQuery(String) - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the deleteSavedQuery operation on the database server
deleteStep(String, String) - Method in interface com.marklogic.hub.dataservices.StepService
Invokes the deleteStep operation on the database server
deleteStep(Flow, String) - Method in interface com.marklogic.hub.FlowManager
 
deleteStep(Flow, String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
deleteStepDefinition(String) - Method in interface com.marklogic.hub.dataservices.StepDefinitionService
Invokes the deleteStepDefinition operation on the database server
deleteStepDefinition(StepDefinition) - Method in class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
deleteStepDefinition(StepDefinition) - Method in interface com.marklogic.hub.StepDefinitionManager
Deletes a Step Definition from disk
deleteStepDefinitionArtifacts(Step, StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
deleteUserArtifacts(HubProject) - Method in class com.marklogic.hub.hubcentral.HubCentralManager
 
deployAsDeveloper(HubConfigImpl) - Method in class com.marklogic.hub.deploy.HubDeployer
Deploys the portions of a DHF app that a data-hub-developer is permitted to deploy.
deployAsSecurityAdmin(HubConfigImpl) - Method in class com.marklogic.hub.deploy.HubDeployer
Deploys the portions of a DHF app that a data-hub-security-admin is permitted to deploy.
DeployDatabaseFieldCommand - Class in com.marklogic.hub.deploy.commands
Per DHFPROD-2554, this command ensures that when it adds DHF-specific fields and range field indexes to the staging, final, and jobs databases, it will not drop any existing fields or range field indexes.
DeployDatabaseFieldCommand() - Constructor for class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
DeployDatabaseFieldCommand.HubDatabaseManager - Class in com.marklogic.hub.deploy.commands
 
DeployHubAmpsCommand - Class in com.marklogic.hub.deploy.commands
This command is used instead of DeployAmpsCommand when a data-hub-security-admin user is deploying amps.
DeployHubAmpsCommand() - Constructor for class com.marklogic.hub.deploy.commands.DeployHubAmpsCommand
DeployHubAmpsCommand should run before we run LoadHubModulesCommand as we require the amp for getting the default rewriter to be present so that it can be used to generate the custom rewriter.
deployHubCentralConfig(HubClient, JsonNode, String) - Method in class com.marklogic.hub.hubcentral.HubCentralManager
 
DeployHubDatabaseCommand - Class in com.marklogic.hub.deploy.commands
Extends ml-app-deployer's standard command for deploying a single database and adds DHF-specific functionality.
DeployHubDatabaseCommand(HubConfig, File, String) - Constructor for class com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand
In order for sorting to work correctly via DeployDatabaseCommandComparator, must call setDatabaseFile so that the parent getPayload method is able to find the correct File to read from.
DeployHubQueryRolesetsCommand - Class in com.marklogic.hub.deploy.commands
This command is used instead of DeployQueryRolesetsCommand for when a data-hub-developer user is deploying query rolesets.
DeployHubQueryRolesetsCommand() - Constructor for class com.marklogic.hub.deploy.commands.DeployHubQueryRolesetsCommand
 
DeployHubTriggersCommand - Class in com.marklogic.hub.deploy.commands
DHF extension that provides support for writing triggers to any triggers database.
DeployHubTriggersCommand(String) - Constructor for class com.marklogic.hub.deploy.commands.DeployHubTriggersCommand
 
deployQueryOptions() - Method in interface com.marklogic.hub.EntityManager
Deploys the query option
deployQueryOptions() - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
DeployQueryOptionsCommand - Class in com.marklogic.hub.deploy.commands
 
DeployQueryOptionsCommand(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.DeployQueryOptionsCommand
 
deployToReplica(HubConfig) - Method in class com.marklogic.hub.deploy.HubDeployer
 
describeRole(String) - Method in interface com.marklogic.hub.dataservices.SecurityService
Returns the roles, privileges, default permissions, and default collections for the given role
describeUser(String) - Method in interface com.marklogic.hub.dataservices.SecurityService
Returns the roles, privileges, default permissions, and default collections for the given username
description - Variable in class com.marklogic.hub.entity.DefinitionType
 
description - Variable in class com.marklogic.hub.entity.InfoType
 
description - Variable in class com.marklogic.hub.entity.PropertyType
 
deserialize(JsonNode) - Method in interface com.marklogic.hub.flow.Flow
Deserialize a json response and applies it to this flow
deserialize(JsonNode) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
deserialize(JsonNode) - Method in interface com.marklogic.hub.mapping.Mapping
Deserializes a json response and applies it to this mapping
deserialize(JsonNode) - Method in class com.marklogic.hub.mapping.MappingImpl
 
deserialize(JsonNode) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
deserialize(JsonNode) - Method in class com.marklogic.hub.step.impl.IngestionStepDefinitionImpl
 
deserialize(JsonNode) - Static method in class com.marklogic.hub.step.impl.Step
 
deserialize(JsonNode) - Method in interface com.marklogic.hub.step.StepDefinition
Deserialize a json response and applies it to this mapping
determineInputFilePath(String) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
determineVersionFromLocalProject(HubProject) - Method in class com.marklogic.hub.impl.Versions
As of 5.3.0, the only time this is needed is when QuickStart tries to determine if an upgrade is needed, but DH is not installed yet.
disable() - Method in class com.marklogic.hub.legacy.impl.LegacyDebuggingImpl
 
disable() - Method in class com.marklogic.hub.legacy.impl.LegacyTracingImpl
 
disable() - Method in interface com.marklogic.hub.legacy.LegacyDebugging
Disables debugging
disable() - Method in interface com.marklogic.hub.legacy.LegacyTracing
Disables tracing
disableSimpleSsl() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
disableSomeCmaUsage(AppConfig) - Method in class com.marklogic.hub.impl.DataHubImpl
Turns off CMA for some resources that have bbugs in ML 9.0-7/8.
DiskQueue<E extends java.io.Serializable> - Class in com.marklogic.hub.legacy.collector
A queue that writes extra elements to disk, and reads them in as needed.
DiskQueue(int) - Constructor for class com.marklogic.hub.legacy.collector.DiskQueue
Construct a disk-backed queue that keeps at most maxInMemorySize elements in memory.
DiskQueue(int, File) - Constructor for class com.marklogic.hub.legacy.collector.DiskQueue
Construct a disk-backed queue that keeps at most maxInMemorySize elements in memory.
DiskQueue<E extends java.io.Serializable> - Class in com.marklogic.hub.util
A queue that writes extra elements to disk, and reads them in as needed.
DiskQueue(int) - Constructor for class com.marklogic.hub.util.DiskQueue
Construct a disk-backed queue that keeps at most maxInMemorySize elements in memory.
DiskQueue(int, File) - Constructor for class com.marklogic.hub.util.DiskQueue
Construct a disk-backed queue that keeps at most maxInMemorySize elements in memory.
documentHistory(String) - Method in class com.marklogic.hub.impl.MasteringManagerImpl
 
documentHistory(String) - Method in interface com.marklogic.hub.MasteringManager
Returns provenance information about a merged document
documents - Variable in class com.marklogic.hub.step.ResponseHolder
 

E

elementRangeIndex - Variable in class com.marklogic.hub.entity.DefinitionType
 
enable() - Method in class com.marklogic.hub.legacy.impl.LegacyDebuggingImpl
 
enable() - Method in class com.marklogic.hub.legacy.impl.LegacyTracingImpl
 
enable() - Method in interface com.marklogic.hub.legacy.LegacyDebugging
Enables debugging
enable() - Method in interface com.marklogic.hub.legacy.LegacyTracing
Enables tracing
enableSimpleSsl() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
EntitiesValidator - Interface in com.marklogic.hub.legacy.validate
Uses a supplied DatabaseClient to run an entity validation against all entities defined or against a specific entity/flow/plugins (triples etc) combination
EntitiesValidatorImpl - Class in com.marklogic.hub.legacy.validate.impl
 
EntitiesValidatorImpl(DatabaseClient) - Constructor for class com.marklogic.hub.legacy.validate.impl.EntitiesValidatorImpl
 
ENTITY_CONFIG_DIR - Static variable in interface com.marklogic.hub.HubConfig
 
ENTITY_CONFIG_DIR - Static variable in class com.marklogic.hub.impl.HubProjectImpl
 
ENTITY_FILE_EXTENSION - Static variable in class com.marklogic.hub.impl.EntityManagerImpl
 
EntityDefModulesFinder - Class in com.marklogic.client.ext.modulesloader.impl
 
EntityDefModulesFinder() - Constructor for class com.marklogic.client.ext.modulesloader.impl.EntityDefModulesFinder
 
entityManager - Variable in class com.marklogic.hub.deploy.commands.LoadUserModulesCommand
 
EntityManager - Interface in com.marklogic.hub
Manages existing entities' MarkLogic Server database index settings and query options.
EntityManagerImpl - Class in com.marklogic.hub.impl
 
EntityManagerImpl() - Constructor for class com.marklogic.hub.impl.EntityManagerImpl
 
EntityManagerImpl(HubConfig) - Constructor for class com.marklogic.hub.impl.EntityManagerImpl
For use outside of a Spring container.
entityModelRequiresConversion(String, JsonNode) - Method in class com.marklogic.hub.hubcentral.conversion.HubCentralConverter
 
entityModelValidForConversion(String, JsonNode) - Method in class com.marklogic.hub.hubcentral.conversion.HubCentralConverter
 
EntitySearchService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
errorCount - Variable in class com.marklogic.hub.legacy.flow.RunFlowResponse
 
errorCount - Variable in class com.marklogic.hub.legacy.job.JobDeleteResponse
 
errorCount - Variable in class com.marklogic.hub.step.ResponseHolder
 
errors - Variable in class com.marklogic.hub.legacy.flow.RunFlowResponse
 
errors - Variable in class com.marklogic.hub.legacy.job.JobDeleteResponse
 
errors - Variable in class com.marklogic.hub.step.ResponseHolder
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployHubAmpsCommand
The parent class's execute method eagerly grabs amps for performance reasons.
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployHubTriggersCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployQueryOptionsCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.FinishHubDeploymentCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.GenerateFunctionMetadataCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.LoadHubArtifactsCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.LoadHubModulesCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.LoadUserArtifactsCommand
 
execute(CommandContext) - Method in class com.marklogic.hub.deploy.commands.LoadUserModulesCommand
 
EXP_FINAL_ENTITY_QUERY_OPTIONS_FILE - Static variable in interface com.marklogic.hub.HubConfig
 
EXP_STAGING_ENTITY_QUERY_OPTIONS_FILE - Static variable in interface com.marklogic.hub.HubConfig
 
exportJobs(Path, String[]) - Method in class com.marklogic.hub.legacy.job.impl.LegacyJobManagerImpl
 
exportJobs(Path, String[]) - Method in interface com.marklogic.hub.legacy.job.LegacyJobManager
Export Job documents and their associated Trace documents to a zip file.
exportProject(File) - Method in interface com.marklogic.hub.HubProject
Exports the project content to disk
exportProject(OutputStream) - Method in interface com.marklogic.hub.HubProject
Exports the project content to output stream
exportProject(File) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
exportProject(OutputStream) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
exportProject(OutputStream, List<String>) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
exportSearchAsCSV(String, String, String, String, String, Long, ArrayNode, Stream<String>) - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the exportSearchAsCSV operation on the database server
extractEntityNameFromFilename(String) - Static method in class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
extractZipToProject(HubProject, File) - Method in class com.marklogic.hub.hubcentral.HubCentralManager
 

F

FAILED_PREFIX - Static variable in enum com.marklogic.hub.flow.impl.JobStatus
 
failedItems - Variable in class com.marklogic.hub.legacy.flow.RunFlowResponse
 
failedItems - Variable in class com.marklogic.hub.step.ResponseHolder
 
failedJobs - Variable in class com.marklogic.hub.legacy.job.JobDeleteResponse
 
failedTraces - Variable in class com.marklogic.hub.legacy.job.JobDeleteResponse
 
FileCollector - Class in com.marklogic.hub.step.impl
 
FileCollector(String) - Constructor for class com.marklogic.hub.step.impl.FileCollector
 
filename - Variable in class com.marklogic.hub.entity.HubEntity
 
FileUtil - Class in com.marklogic.hub.util
 
FileUtil() - Constructor for class com.marklogic.hub.util.FileUtil
 
filterEntities(Map<String, File>) - Method in class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
FINAL_ENTITY_DATABASE_FILE - Static variable in interface com.marklogic.hub.HubConfig
 
FINAL_ENTITY_QUERY_OPTIONS_FILE - Static variable in interface com.marklogic.hub.HubConfig
 
finalAppServerExists - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
finalCollectionLexiconOn - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
finalDbExists - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
finalForestsExist - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
finalForestsPerHost - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
finalHttpName - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
finalSchemasForestsPerHost - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
finalTriggersForestsPerHost - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
finalTripleIndexOn - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
findEntityFiles() - Method in class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
findModulesWithResolvedBaseDir(String) - Method in class com.marklogic.client.ext.modulesloader.impl.EntityDefModulesFinder
 
findModulesWithResolvedBaseDir(String) - Method in class com.marklogic.client.ext.modulesloader.impl.FlowDefModulesFinder
 
findModulesWithResolvedBaseDir(String) - Method in class com.marklogic.client.ext.modulesloader.impl.MappingDefModulesFinder
 
findModulesWithResolvedBaseDir(String) - Method in class com.marklogic.client.ext.modulesloader.impl.SearchOptionsFinder
 
findModulesWithResolvedBaseDir(String) - Method in class com.marklogic.client.ext.modulesloader.impl.StepDefModulesFinder
 
findModulesWithResolvedBaseDir(String) - Method in class com.marklogic.client.ext.modulesloader.impl.UserModulesFinder
 
findStepResponses(JsonNode) - Method in interface com.marklogic.hub.dataservices.JobService
 
finishHubDeployment() - Method in interface com.marklogic.hub.dataservices.SystemService
Invokes the finishHubDeployment operation on the database server
FinishHubDeploymentCommand - Class in com.marklogic.hub.deploy.commands
FinishHubDeployment will invoke the dataservice finishHubDeployment to complete hub deployment.
FinishHubDeploymentCommand(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.FinishHubDeploymentCommand
 
finishJob(String, String) - Method in interface com.marklogic.hub.dataservices.JobService
Updated the Job document associated with jobId with the given jobStatus
finishStep(String, String, String, JsonNode) - Method in interface com.marklogic.hub.dataservices.JobService
Updates the associated Job document after all batches have been processed for a step
fixInDatabase(String) - Method in class com.marklogic.hub.util.CreatedByStepFixer
 
Flow - Interface in com.marklogic.hub.flow
 
FLOW_FILE_EXTENSION - Static variable in interface com.marklogic.hub.FlowManager
String value for the flow file extension
FlowConverter - Class in com.marklogic.hub.hubcentral.conversion
Class for converting pre-5.3.0 artifacts to 5.3.0 and above versions
FlowConverter(HubConfig) - Constructor for class com.marklogic.hub.hubcentral.conversion.FlowConverter
 
FlowDefModulesFinder - Class in com.marklogic.client.ext.modulesloader.impl
 
FlowDefModulesFinder() - Constructor for class com.marklogic.client.ext.modulesloader.impl.FlowDefModulesFinder
 
flowFromXml(Element) - Static method in interface com.marklogic.hub.legacy.LegacyFlowManager
Turns an XML document into a flow
FlowImpl - Class in com.marklogic.hub.flow.impl
 
FlowImpl() - Constructor for class com.marklogic.hub.flow.impl.FlowImpl
 
FlowInputs - Class in com.marklogic.hub.flow
 
FlowInputs() - Constructor for class com.marklogic.hub.flow.FlowInputs
 
FlowInputs(String) - Constructor for class com.marklogic.hub.flow.FlowInputs
 
FlowInputs(String, String...) - Constructor for class com.marklogic.hub.flow.FlowInputs
 
FlowManager - Interface in com.marklogic.hub
Manages CRUD operations for flows
FlowManagerImpl - Class in com.marklogic.hub.impl
 
FlowManagerImpl() - Constructor for class com.marklogic.hub.impl.FlowManagerImpl
 
FlowManagerImpl(HubConfig) - Constructor for class com.marklogic.hub.impl.FlowManagerImpl
 
FlowManagerImpl(HubClient) - Constructor for class com.marklogic.hub.impl.FlowManagerImpl
 
FlowManagerImpl(HubConfig, MappingManager) - Constructor for class com.marklogic.hub.impl.FlowManagerImpl
 
FlowManagerImpl(HubConfig, MappingManager, StepDefinitionManager) - Constructor for class com.marklogic.hub.impl.FlowManagerImpl
 
FlowRunner - Interface in com.marklogic.hub.flow
 
FlowRunnerImpl - Class in com.marklogic.hub.flow.impl
 
FlowRunnerImpl() - Constructor for class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
FlowRunnerImpl(HubConfig, FlowManager) - Constructor for class com.marklogic.hub.flow.impl.FlowRunnerImpl
Simulates construction of this object via Spring, where the Autowired objects are set manually.
FlowRunnerImpl(String, String, String) - Constructor for class com.marklogic.hub.flow.impl.FlowRunnerImpl
Convenience constructor for running flows with no dependency on project files on the filesystem, and where a user can authenticate with just a username and a password.
FlowRunnerImpl(HubClient) - Constructor for class com.marklogic.hub.flow.impl.FlowRunnerImpl
Constructs a FlowRunnerImpl that can be used for running flows without any reference to project files on a filesystem - and thus, this constructor will not instantiate an instance of FlowManager, which is used for reading project files from the filesystem.
FlowRunnerImpl(HubConfig) - Constructor for class com.marklogic.hub.flow.impl.FlowRunnerImpl
Deprecated.
FlowService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
FlowStatusListener - Interface in com.marklogic.hub.flow
This is no longer used in DHF, but is still required by DHCCE.
FlowType - Enum in com.marklogic.hub.legacy.flow
 
fromJson(JsonNode) - Static method in class com.marklogic.hub.entity.DefinitionsType
 
fromJson(String, JsonNode) - Static method in class com.marklogic.hub.entity.DefinitionType
 
fromJson(String, JsonNode) - Static method in class com.marklogic.hub.entity.HubEntity
 
fromJson(JsonNode) - Static method in class com.marklogic.hub.entity.InfoType
 
fromJson(JsonNode) - Static method in class com.marklogic.hub.entity.ItemType
 
fromJson(String, JsonNode) - Static method in class com.marklogic.hub.entity.PropertyType
 
fromXml(Node) - Static method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
fullPath - Variable in class com.marklogic.hub.legacy.job.JobExportResponse
 

G

generateDatabaseProperties(JsonNode) - Method in interface com.marklogic.hub.dataservices.ModelsService
Returns a JSON object containing database properties based on entity models
generateExtractionTemplate(AppConfig, GeneratedCode) - Method in class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
generateFunctionMetadata() - Method in class com.marklogic.hub.deploy.commands.GenerateFunctionMetadataCommand
 
GenerateFunctionMetadataCommand - Class in com.marklogic.hub.deploy.commands
 
GenerateFunctionMetadataCommand() - Constructor for class com.marklogic.hub.deploy.commands.GenerateFunctionMetadataCommand
 
GenerateFunctionMetadataCommand(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.GenerateFunctionMetadataCommand
 
GenerateHubTDETemplateCommand - Class in com.marklogic.hub.deploy.commands
 
GenerateHubTDETemplateCommand(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
generateMappingTransforms() - Method in interface com.marklogic.hub.dataservices.MappingService
Generates a transform in the modules database for each legacy mapping or mapping step
generateModelConfig() - Method in interface com.marklogic.hub.dataservices.ModelsService
Invokes the generateModelConfig operation on the database server
generateProtectedPathConfig(JsonNode) - Method in interface com.marklogic.hub.dataservices.ModelsService
Generate a CMA config object with protected paths and query rolesets based on the 'pii' arrays in the given entity models
generateTestSuite(Path, String) - Method in class com.marklogic.hub.ext.mlunittest.TestSuiteGenerator
 
generateTestSuite(Path, String, String) - Method in class com.marklogic.hub.ext.mlunittest.TestSuiteGenerator
 
generateUriForCsv(String, String) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
getAbsolutePath(String, String...) - Static method in class com.marklogic.hub.impl.ScaffoldingImpl
 
getAdminConfig() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getAdminManager() - Method in interface com.marklogic.hub.HubConfig
 
getAdminManager() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getAppConfig() - Method in interface com.marklogic.hub.HubConfig
Returns the current AppConfig object attached to the HubConfig
getAppConfig() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getArray(String) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a list of Objects by key
getArrayString(String, boolean) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a list of String by key with/without null values
getArrayString(String) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a list of String by key
getArtifactService() - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getArtifactsWithProjectPaths() - Method in interface com.marklogic.hub.dataservices.ArtifactService
Returns a JSON array with an entry for each project artifact and its file path within a project
getAuthMethod(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the AuthMethod object for the DatabaseKind in the hub config
getAuthMethod(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getAuthorities() - Method in interface com.marklogic.hub.dataservices.HubCentralService
Invokes the getAuthorities operation on the database server
getBaseUri() - Method in class com.marklogic.hub.entity.InfoType
Gets the value of the baseUri property.
getBatchSize() - Method in interface com.marklogic.hub.flow.Flow
Returns flow batch size
getBatchSize() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getBatchSize() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getBatchSize() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getBatchSize() - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
getBatchSize() - Method in class com.marklogic.hub.step.impl.Step
 
getBatchSize() - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
getBatchSize() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the batch size
getBatchSize() - Method in interface com.marklogic.hub.step.StepRunner
Returns the batch size
getBoolean(String) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a Boolean value by key
getBoolean(Object, Boolean) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a Boolean value by key with a default value
getBuildVersion() - Static method in class com.marklogic.hub.impl.VersionInfo
 
getCertFile(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the SSL Cert file as a string for the DatabaseKind in the hub config
getCertFile(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getCertPassword(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the SSL Cert Password as a string for the DatabaseKind in the hub config
getCertPassword(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getClient() - Method in class com.marklogic.hub.legacy.collector.impl.LegacyCollectorImpl
 
getClient() - Method in interface com.marklogic.hub.legacy.collector.LegacyCollector
Gets the client in use currently by the collector object
getClusterName() - Method in class com.marklogic.hub.impl.VersionInfo
 
getCodeFormat() - Method in class com.marklogic.hub.legacy.collector.impl.LegacyCollectorImpl
 
getCodeFormat() - Method in interface com.marklogic.hub.legacy.collector.LegacyCollector
Obtains the code format for the collector in use
getCodeFormat(String) - Static method in enum com.marklogic.hub.legacy.flow.CodeFormat
 
getCodeFormat() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
getCodeFormat() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Returns the CodeFormat enum of the flow
getCodeFormat() - Method in class com.marklogic.hub.legacy.impl.MainPluginImpl
 
getCodeFormat() - Method in interface com.marklogic.hub.legacy.MainPlugin
 
getCollation() - Method in class com.marklogic.hub.entity.ItemType
 
getCollation() - Method in class com.marklogic.hub.entity.PropertyType
 
getCollector() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
getCollector() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Gets the collector to be used for the flow
getContents(String, CodeFormat, FlowType, String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl.ContentPlugin
 
getCustomForestPath() - Method in interface com.marklogic.hub.HubConfig
Returns the path for the custom forests definition
getCustomForestPath() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getCustomHook() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getCustomHook() - Method in class com.marklogic.hub.step.impl.Step
 
getCustomHook() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the customHook
getCustomMappingFunctionsDir() - Method in interface com.marklogic.hub.HubProject
 
getCustomMappingFunctionsDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getCustomModuleDir(String, String) - Method in interface com.marklogic.hub.HubProject
 
getCustomModuleDir(String, String) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getCustomModulesDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the custom modules directory
getCustomModulesDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getCustomStep(String) - Method in interface com.marklogic.hub.dataservices.CustomStepService
Invokes the getCustomStep operation on the database server
getCustomSteps() - Method in interface com.marklogic.hub.dataservices.CustomStepService
Invokes the getCustomSteps operation on the database server
getDataFormat(String) - Static method in enum com.marklogic.hub.legacy.flow.DataFormat
 
getDataFormat() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
getDataFormat() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Returns the DataForm enum of the flow
getDataHubConfig() - Method in interface com.marklogic.hub.dataservices.SystemService
Invokes the getDataHubConfig operation on the database server
getDatatype() - Method in class com.marklogic.hub.entity.ItemType
 
getDatatype() - Method in class com.marklogic.hub.entity.PropertyType
 
getDbName(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the database name for the DatabaseKind set in the config
getDbName(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getDefaultCollections(String) - Method in interface com.marklogic.hub.dataservices.MasteringService
Invokes the getDefaultCollections operation on the database server
getDefinitions() - Method in class com.marklogic.hub.entity.DefinitionsType
 
getDefinitions() - Method in class com.marklogic.hub.entity.HubEntity
 
getDescription() - Method in class com.marklogic.hub.entity.DefinitionType
 
getDescription() - Method in class com.marklogic.hub.entity.InfoType
Gets the value of the description property.
getDescription() - Method in class com.marklogic.hub.entity.PropertyType
 
getDescription() - Method in interface com.marklogic.hub.flow.Flow
Returns flow description
getDescription() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getDescription() - Method in interface com.marklogic.hub.mapping.Mapping
Returns a string description of what the mapping is/does
getDescription() - Method in class com.marklogic.hub.mapping.MappingImpl
 
getDescription() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getDescription() - Method in class com.marklogic.hub.step.impl.Step
 
getDescription() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the description of the Step
getDocument(String, String) - Method in interface com.marklogic.hub.dataservices.MappingService
Gets the document based on the given URI from the source database associated with the given step name
getElementRangeIndex() - Method in class com.marklogic.hub.entity.DefinitionType
 
getEndTime() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
getEndTime() - Method in class com.marklogic.hub.legacy.job.Job
 
getEntities() - Method in interface com.marklogic.hub.EntityManager
 
getEntities(Boolean) - Method in interface com.marklogic.hub.EntityManager
 
getEntities() - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
getEntities(Boolean) - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
getEntitiesForMapping(String) - Method in interface com.marklogic.hub.dataservices.MappingService
Gets the specified entity model and all its related entity models
getEntitiesWithConceptsTypes() - Method in interface com.marklogic.hub.dataservices.GraphService
 
getEntityConfigDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the entity's config directory
getEntityConfigDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getEntityDatabaseDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the entity database directory
getEntityDatabaseDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the entity database directory
getEntityDatabaseDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getEntityDatabaseDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getEntityDir(String) - Method in interface com.marklogic.hub.HubProject
 
getEntityDir(String) - Method in class com.marklogic.hub.impl.HubProjectImpl
Deprecated.
getEntityFromEntityDefinitions(String, List<HubEntity>, String, Boolean) - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
getEntityFromProject(String) - Method in interface com.marklogic.hub.EntityManager
 
getEntityFromProject(String, String) - Method in interface com.marklogic.hub.EntityManager
 
getEntityFromProject(String, Boolean) - Method in interface com.marklogic.hub.EntityManager
 
getEntityFromProject(String, String, Boolean) - Method in interface com.marklogic.hub.EntityManager
 
getEntityFromProject(String) - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
getEntityFromProject(String, String) - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
getEntityFromProject(String, Boolean) - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
getEntityFromProject(String, String, Boolean) - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
getEntityFromProject(String, List<HubEntity>, String, Boolean) - Method in class com.marklogic.hub.impl.EntityManagerImpl
Extracted for unit testing so that it doesn't depend on entity model files existing within a project directory structure.
getEntityModelPermissions() - Method in interface com.marklogic.hub.HubConfig
Prior to 5.1.0, entities were assigned permissions returned by getModulePermissions.
getEntityModelPermissions() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getEntityName() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
getEntityName() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Returns the name of the entity that's been set for the flow in strong form
getEntityName() - Method in class com.marklogic.hub.legacy.job.Job
 
getEntityNameFromEntityType(String) - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
To avoid making flow conversion depend on connecting to ML, we're implementing a simple approach here to try to extract the entity name that should work most of the time.
getEntityNames() - Method in class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
getExecuteSortOrder() - Method in class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
It is anticipated that these privileges can always be added at the end of a deployment because none of the steps before that should depend on the privileges being added.
getExternalName(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the external name for the host for the DatabaseKind in the hub config
getExternalName(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getFailedBatches() - Method in class com.marklogic.hub.legacy.job.Job
 
getFailedBatches() - Method in class com.marklogic.hub.step.impl.StepMetrics
 
getFailedBatches() - Method in class com.marklogic.hub.step.RunStepResponse
 
getFailedBatchesCount() - Method in class com.marklogic.hub.step.impl.StepMetrics
 
getFailedEvents() - Method in class com.marklogic.hub.legacy.job.Job
 
getFailedEvents() - Method in class com.marklogic.hub.step.impl.StepMetrics
 
getFailedEvents() - Method in class com.marklogic.hub.step.RunStepResponse
 
getFailedEventsCount() - Method in class com.marklogic.hub.step.impl.StepMetrics
 
getFailHard() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getFileForLocalFlow(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getFileLocations() - Method in class com.marklogic.hub.step.impl.IngestionStepDefinitionImpl
 
getFileLocations() - Method in class com.marklogic.hub.step.impl.Step
 
getFilename() - Method in class com.marklogic.hub.entity.HubEntity
 
getFinalDbName() - Method in class com.marklogic.hub.impl.VersionInfo
 
getFlow(String) - Method in interface com.marklogic.hub.dataservices.FlowService
Invokes the getFlow operation on the database server
getFlow(String) - Method in interface com.marklogic.hub.FlowManager
Retrieves a named flow on the MarkLogic server
getFlow(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getFlow(String, String) - Method in class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
getFlow(String, String, FlowType) - Method in class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
getFlow(String, String) - Method in interface com.marklogic.hub.legacy.LegacyFlowManager
Retrieves a named flow from a given entity
getFlow(String, String, FlowType) - Method in interface com.marklogic.hub.legacy.LegacyFlowManager
Retrieves a named flow from a given entity
getFlowAsJSON(String) - Method in interface com.marklogic.hub.FlowManager
Returns a flow based on the provided name as JSON string
getFlowAsJSON(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getFlowDbPath() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
getFlowDbPath() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Gets the DbPath (uri) for the flow in string form
getFlowDeveloperRoleName() - Method in interface com.marklogic.hub.HubConfig
Get the roleName the hub uses for developing flows
getFlowDeveloperRoleName() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getFlowFromProperties(Path) - Method in class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
getFlowFromProperties(Path) - Method in interface com.marklogic.hub.legacy.LegacyFlowManager
Obtains a flow from a property file
getFlowName() - Method in class com.marklogic.hub.flow.FlowInputs
 
getFlowName() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
getFlowName() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getFlowName() - Method in class com.marklogic.hub.legacy.job.Job
 
getFlowName() - Method in class com.marklogic.hub.step.RunStepResponse
 
getFlowNames() - Method in interface com.marklogic.hub.FlowManager
Retrieves a list of names of flows installed on the MarkLogic server
getFlowNames() - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getFlowOperatorRoleName() - Method in interface com.marklogic.hub.HubConfig
Get the roleName the hub uses
getFlowOperatorRoleName() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getFlowPermissions() - Method in interface com.marklogic.hub.HubConfig
Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions.
getFlowPermissions() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getFlowRunner() - Method in interface com.marklogic.hub.DataHub
Creates and returns the FlowRunner object using the datahub's autowired hubconfig
getFlowRunner() - Method in class com.marklogic.hub.impl.DataHubImpl
 
getFlows() - Method in interface com.marklogic.hub.FlowManager
Retrieves a list of flows installed on the MarkLogic server
getFlows() - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getFlows(String) - Method in class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
getFlows(String) - Method in interface com.marklogic.hub.legacy.LegacyFlowManager
Retrieves a list of flows installed on the MarkLogic server
getFlowsDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the flows directory
getFlowsDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the flows directory
getFlowsDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getFlowsDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getFlowService() - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getFlowsWithStepDetails() - Method in interface com.marklogic.hub.dataservices.FlowService
Invokes the getFlowsWithStepDetails operation on the database server
getFlowType(String) - Static method in enum com.marklogic.hub.legacy.flow.FlowType
 
getFlowType() - Method in class com.marklogic.hub.legacy.job.Job
 
getFlowWithLatestJobInfo(String) - Method in interface com.marklogic.hub.dataservices.FlowService
Invokes the getFlowWithLatestJobInfo operation on the database server
getForestsPerHost(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the number of forests per host for the DatabaseKind set in the config
getForestsPerHost(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getFullFlow(String) - Method in interface com.marklogic.hub.dataservices.FlowService
Invokes the getFullFlow operation on the database server
getFullFlow(String) - Method in interface com.marklogic.hub.FlowManager
Retrieves the expanded flow document with properties from artifact and settings
getFullFlow(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getFullOutput() - Method in class com.marklogic.hub.step.RunStepResponse
 
getGroupNames() - Method in class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
 
getGroupNamesForScheduledTaskPrivileges() - Method in class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
 
getHost() - Method in interface com.marklogic.hub.HubConfig
Gets the hostname of the AppConfig
getHost() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHttpName(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the appserver name for the DatabaseKind set in the config
getHttpName(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubCentralConceptsPath() - Method in interface com.marklogic.hub.HubProject
 
getHubCentralConceptsPath() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubCentralConfigPath() - Method in interface com.marklogic.hub.HubProject
 
getHubCentralConfigPath() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubConfig() - Method in class com.marklogic.hub.impl.DataHubImpl
 
getHubConfig() - Method in class com.marklogic.hub.legacy.collector.impl.LegacyCollectorImpl
 
getHubConfig() - Method in interface com.marklogic.hub.legacy.collector.LegacyCollector
Returns the current hubConfig ont he collector object
getHubConfigDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the hub's config directory
getHubConfigDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub's config directory
getHubConfigDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubConfigDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubDatabaseDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the hub's database directory
getHubDatabaseDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub's database directory
getHubDatabaseDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubDatabaseDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubEntitiesDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the hub entities directory
getHubEntitiesDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub entities directory
getHubEntitiesDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubEntitiesDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubLogLevel() - Method in interface com.marklogic.hub.HubConfig
Gets the current level of logging set for the data hub
getHubLogLevel() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubMappingsDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the hub mappings directory
getHubMappingsDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub mappings directory
getHubMappingsDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubMappingsDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubPluginsDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the hub plugins directory
getHubPluginsDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub plugins directory
getHubPluginsDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubPluginsDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubProject() - Method in interface com.marklogic.hub.HubConfig
Returns the HubProject associated with the HubConfig
getHubProject() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubProjectDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubPropertiesFromDb(DatabaseClient) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubSecurityDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the hub's security directory
getHubSecurityDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub's security directory
getHubSecurityDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubSecurityDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubServersDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the hub servers directory
getHubServersDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub servers directory
getHubServersDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getHubServersDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubStagingModulesDir() - Method in interface com.marklogic.hub.HubProject
Deprecated.
getHubStagingModulesDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
Deprecated.
getHubTriggersDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub's triggers directory
getHubTriggersDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getHubVersion() - Method in class com.marklogic.hub.impl.VersionInfo
 
getInfo() - Method in class com.marklogic.hub.entity.HubEntity
 
getInfo() - Method in interface com.marklogic.hub.HubConfig
Gets information on a datahub configuration
getInfo() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getInputFilePath() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getInputFileType() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getInstalledVersion() - Method in class com.marklogic.hub.impl.Versions
Depends on being able to obtain the version from an installed DH.
getInstalledVersion(boolean) - Method in class com.marklogic.hub.impl.Versions
 
getInt(String) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a int value by key with 0 as default value
getInt(Object, int) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a int value by key with a default value
getIntValue(JsonNode, String) - Static method in class com.marklogic.hub.entity.JsonPojo
 
getIntValue(JsonNode, String, Integer) - Static method in class com.marklogic.hub.entity.JsonPojo
 
getIntValue(String) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a int value by key with null as default value
getIsHostLoadBalancer() - Method in interface com.marklogic.hub.HubConfig
Signifies if the host is a load balancer host.
getIsProvisionedEnvironment() - Method in interface com.marklogic.hub.HubConfig
Signifies if we are dealing with a provisioned environment.
getIsProvisionedEnvironment() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getItems() - Method in class com.marklogic.hub.entity.PropertyType
 
getJarVersion() - Method in interface com.marklogic.hub.HubConfig
Gets the current version of the DHF Jar
getJarVersion() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getJob(String) - Method in interface com.marklogic.hub.dataservices.JobService
Get the Job document associated with the given job ID
getJobId() - Method in class com.marklogic.hub.flow.FlowInputs
 
getJobId() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
getJobId() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getJobId() - Method in class com.marklogic.hub.legacy.job.Job
 
getJobId() - Method in class com.marklogic.hub.step.RunStepResponse
 
getJobName() - Method in class com.marklogic.hub.legacy.job.Job
 
getJobOutput() - Method in class com.marklogic.hub.legacy.job.Job
 
getJobPermissions() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getJobResponseById(String) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
getJobsDbName() - Method in class com.marklogic.hub.impl.VersionInfo
 
getJobStatus(String) - Static method in enum com.marklogic.hub.flow.impl.JobStatus
 
getJobStatus() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
getJobStatus(String) - Static method in enum com.marklogic.hub.legacy.job.JobStatus
 
getJobWithDetails(String) - Method in interface com.marklogic.hub.dataservices.JobService
Get the Job document associated with the given job ID and additional metadata
getJsonArraySize(String) - Method in class com.marklogic.hub.util.json.JSONObject
Gets json size if it is an array
getLang() - Method in interface com.marklogic.hub.mapping.Mapping
Return the language key setting
getLang() - Method in class com.marklogic.hub.mapping.MappingImpl
 
getLang() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getLang() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the language setting of the step
getLanguage() - Method in interface com.marklogic.hub.mapping.Mapping
Deprecated.
getLanguage() - Method in class com.marklogic.hub.mapping.MappingImpl
Deprecated.
getLanguage() - Method in class com.marklogic.hub.step.AbstractStepDefinition
Deprecated.
getLanguage() - Method in interface com.marklogic.hub.step.StepDefinition
Deprecated.
getLastAttemptedStep() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
getLastCompletedStep() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
getLatestJobData(String) - Method in interface com.marklogic.hub.dataservices.ModelsService
Invokes the getLatestJobData operation on the database server
getLegacyFlowDir(String, String, FlowType) - Method in interface com.marklogic.hub.impl.Scaffolding
Returns the directory of the flow
getLegacyFlowDir(String, String, FlowType) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
getLegacyHubEntitiesDir() - Method in interface com.marklogic.hub.HubProject
Gets the legacy path for the hub entities directory
getLegacyHubEntitiesDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getLegacyHubMappingsDir() - Method in interface com.marklogic.hub.HubProject
Gets the legacy path for the hub mappings directory
getLegacyHubMappingsDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getLegacyMappingDir(String) - Method in interface com.marklogic.hub.HubProject
 
getLegacyMappingDir(String) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getList(String) - Method in interface com.marklogic.hub.dataservices.ArtifactService
Invokes the getList operation on the database server
getLocalFlow(String) - Method in interface com.marklogic.hub.FlowManager
Retrieves a named flow from the Data Hub project
getLocalFlow(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getLocalFlowAsJSON(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getLocalFlowNames() - Method in interface com.marklogic.hub.FlowManager
Retrieves a list of names of flows in the local project
getLocalFlowNames() - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getLocalFlows() - Method in interface com.marklogic.hub.FlowManager
Retrieves a list of flows in a Data Hub project
getLocalFlows() - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getLocalFlows() - Method in class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
getLocalFlows() - Method in interface com.marklogic.hub.legacy.LegacyFlowManager
retrieves a list of all the flows on the local files systems
getLocalFlowsAsJSON() - Method in interface com.marklogic.hub.FlowManager
Retrieves a list of flows in a Data Hub project
getLocalFlowsAsJSON() - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
getLocalFlowsForEntity(String) - Method in class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
getLocalFlowsForEntity(String, FlowType) - Method in class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
getLocalFlowsForEntity(String) - Method in interface com.marklogic.hub.legacy.LegacyFlowManager
retrieves a list of all the flows on the local files systems
getLocalFlowsForEntity(String, FlowType) - Method in interface com.marklogic.hub.legacy.LegacyFlowManager
retrieves a list of all the flows on the local files systems
getLocalProjectVersion() - Method in class com.marklogic.hub.impl.Versions
 
getLocalStepAsJSON(String) - Method in class com.marklogic.hub.impl.StepManager
 
getLong(String) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a Long value by key
getLong(Object, long) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a Long value by key with a default value
getMain() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
getMain() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Gets the main plugin module that the flow is set to use
getManageClient() - Method in interface com.marklogic.hub.HubConfig
 
getManageClient() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getManageConfig() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getMap(String) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a Map (String, Object) by key
getMapper() - Method in class com.marklogic.hub.util.json.JSONObject
Returns the mapper
getMapping(String) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
getMapping(String, int, boolean) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
getMapping(String) - Method in interface com.marklogic.hub.MappingManager
Returns a mapping based on the provided name
getMapping(String, int, boolean) - Method in interface com.marklogic.hub.MappingManager
Returns a mapping based on the provided name
getMappingArtifact(String, JsonNode) - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
 
getMappingAsJSON(String) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
getMappingAsJSON(String, int, boolean) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
getMappingAsJSON(String) - Method in interface com.marklogic.hub.MappingManager
Returns a mapping based on the provided name as JSON string
getMappingAsJSON(String, int, boolean) - Method in interface com.marklogic.hub.MappingManager
Returns a mapping based on the provided name as JSON string
getMappingDir(String) - Method in interface com.marklogic.hub.HubProject
 
getMappingDir(String) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getMappingFunctions(Boolean) - Method in interface com.marklogic.hub.dataservices.MappingService
Invokes the getMappingFunctions operation on the database server
getMappingFunctions() - Method in interface com.marklogic.hub.dataservices.MappingService
Invokes the getMappingFunctions operation on the database server.
getMappingName() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
getMappingName() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Gets the mapping name used for the flow
getMappingName() - Method in class com.marklogic.hub.step.impl.Step
 
getMappingPermissions() - Method in interface com.marklogic.hub.HubConfig
Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions.
getMappingPermissions() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getMappings() - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
getMappings() - Method in interface com.marklogic.hub.MappingManager
Returns a list of all mappings currently defined
getMappingsNames() - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
getMappingsNames() - Method in interface com.marklogic.hub.MappingManager
Returns a string list of names for all mappings currently defined
getMarkLogicVersion() - Method in class com.marklogic.hub.impl.VersionInfo
 
getMarkLogicVersion() - Method in class com.marklogic.hub.impl.Versions
 
getMarkLogicVersionString() - Method in class com.marklogic.hub.impl.Versions
 
getMatchingPropertyValues(JsonNode) - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the getMatchingPropertyValues operation on the database server
getMatchingPropertyValues(JsonNode) - Method in interface com.marklogic.hub.dataservices.JobService
Invokes the getMatchingPropertyValues operation on the database server
getMinAndMaxPropertyValues(JsonNode) - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the getMinAndMaxPropertyValues operation on the database server
getMlPassword() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getMlUsername() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getModelReferences(String) - Method in interface com.marklogic.hub.dataservices.ConceptService
Returns a json containing the names of the entities that reference the given concept class.
getModelReferences(String, String) - Method in interface com.marklogic.hub.dataservices.ModelsService
Returns a json containing the names of the models and steps that reference the given entity model.
getModelRelationships() - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the getModelRelationships operation on the database server
getModule() - Method in class com.marklogic.hub.legacy.collector.impl.LegacyCollectorImpl
 
getModule() - Method in interface com.marklogic.hub.legacy.collector.LegacyCollector
Returns the module for the collect
getModule() - Method in class com.marklogic.hub.legacy.impl.MainPluginImpl
 
getModule() - Method in interface com.marklogic.hub.legacy.MainPlugin
 
getModulePath() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getModulePath() - Method in interface com.marklogic.hub.step.StepDefinition
Returns path to the module
getModulePermissions() - Method in interface com.marklogic.hub.HubConfig
Gets the permissions used to execute a module in string form
getModulesDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the modules directory
getModulesDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the modules directory
getModulesDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getModulesDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getName() - Method in class com.marklogic.hub.entity.DefinitionType
 
getName() - Method in class com.marklogic.hub.entity.PropertyType
 
getName() - Method in interface com.marklogic.hub.flow.Flow
Returns the name of the flow
getName() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getName() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
getName() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Gets the name of the flow
getName() - Method in interface com.marklogic.hub.mapping.Mapping
Returns the name of the mapping as a string
getName() - Method in class com.marklogic.hub.mapping.MappingImpl
 
getName() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getName() - Method in class com.marklogic.hub.step.impl.Step
 
getName() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the name of the step
getNamespace() - Method in class com.marklogic.hub.entity.DefinitionType
 
getNamespacePrefix() - Method in class com.marklogic.hub.entity.DefinitionType
 
getNamespaces() - Method in interface com.marklogic.hub.mapping.Mapping
Gets the map of the namespaces for mapping
getNamespaces() - Method in class com.marklogic.hub.mapping.MappingImpl
 
getNode(Object) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a JsonNode value by key
getNode(Object, JsonNode) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a JsonNode value by key with a default value
getOptions() - Method in interface com.marklogic.hub.flow.Flow
Returns flow options as JsonNode
getOptions() - Method in class com.marklogic.hub.flow.FlowInputs
 
getOptions() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getOptions() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getOptions() - Method in class com.marklogic.hub.step.impl.Step
 
getOptions() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the step options as a map
getOptionsFile() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getOptionsJSON() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getOutputURIPrefix() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getOutputURIReplacement() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getOverrideStepConfig() - Method in interface com.marklogic.hub.flow.Flow
Gets the overridden options that were set at java runtime
getOverrideStepConfig() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getPayload(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand
 
getPii() - Method in class com.marklogic.hub.entity.DefinitionType
 
getPort(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the port number for the DatabaseKind set in the config
getPort(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getPortInUseBy(DatabaseKind) - Method in interface com.marklogic.hub.DataHub
Returns name of what is using the port
getPortInUseBy(DatabaseKind) - Method in class com.marklogic.hub.impl.DataHubImpl
 
getPrefixedEncodedURI(String) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
getPrimaryEntityTypes(Boolean) - Method in interface com.marklogic.hub.dataservices.ModelsService
Returns an array of primary entity types.
getPrimaryKey() - Method in class com.marklogic.hub.entity.DefinitionType
 
getProjectDir() - Method in interface com.marklogic.hub.HubConfig
Obtains the project directory as a string
getProjectDir() - Method in interface com.marklogic.hub.HubProject
Returns the base directory for this project
getProjectDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
Deprecated.
getProjectDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getProjectDirString() - Method in interface com.marklogic.hub.HubProject
Gets the string used to originally make the project
getProjectDirString() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getProjectName() - Method in interface com.marklogic.hub.HubProject
Returns the name of the project
getProjectName() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getProperties() - Method in class com.marklogic.hub.entity.DefinitionType
 
getProperties() - Method in interface com.marklogic.hub.mapping.Mapping
Gets the hashmap of the properties mapping
getProperties() - Method in class com.marklogic.hub.mapping.MappingImpl
 
getProvenanceGraph(String) - Method in interface com.marklogic.hub.dataservices.ProvenanceService
Returns a JSON Object contain Provenance nodes and links.
getQueuedJobIdsFromFlow(String) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
getRangeIndex() - Method in class com.marklogic.hub.entity.DefinitionType
 
getRecord(String) - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the getRecord operation on the database server
getRef() - Method in class com.marklogic.hub.entity.ItemType
 
getRef() - Method in class com.marklogic.hub.entity.PropertyType
 
getReferences(String) - Method in interface com.marklogic.hub.dataservices.MappingService
Gets the references associated with given mapping step name.
getRequired() - Method in class com.marklogic.hub.entity.DefinitionType
 
getResourceDirs(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
getResourceManager(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
getResourceManager(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployHubAmpsCommand
 
getResourceName() - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand.HubDatabaseManager
 
getResponse(JsonNode, String) - Static method in class com.marklogic.hub.step.impl.StepRunnerUtil
 
getRetryLimit() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getRetryLimit() - Method in class com.marklogic.hub.step.impl.Step
 
getRetryLimit() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the retry limit for the step
getRunningFlow() - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
getRunningStepKey() - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
getRuntimeOptions() - Method in interface com.marklogic.hub.flow.Flow
Gets the overridden options that were set at java runtime
getRuntimeOptions() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getSavedQueries() - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the getSavedQueries operation on the database server
getSavedQuery(String) - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the getSavedQuery operation on the database server
getScheme(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Deprecated.
getScheme(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
Deprecated.
getSecurityCommandList() - Method in class com.marklogic.hub.impl.DataHubImpl
 
getSemanticConceptInfo(String) - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the getSemanticConceptInfo operation on the database server
getSeparator() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getServerVersion() - Method in interface com.marklogic.hub.DataHub
Returns the string presentation of the server version, eg: "9.03-1"
getServerVersion() - Method in class com.marklogic.hub.impl.DataHubImpl
 
getShowOptions() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getSimpleSsl(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns if Simple SSL is set for the DatabaseKind in the hub config
getSimpleSsl(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getSourceContext() - Method in interface com.marklogic.hub.mapping.Mapping
Returns the source context string for the mapping
getSourceContext() - Method in class com.marklogic.hub.mapping.MappingImpl
 
getSourceQuery() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getSourceQuery() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the step sourceQuery
getSourceURI() - Method in interface com.marklogic.hub.mapping.Mapping
Returns a URI of the mapping source document
getSourceURI() - Method in class com.marklogic.hub.mapping.MappingImpl
 
getSslContext(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the SSL Context for the DatabaseKind set in the config
getSslContext(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getSslHostnameVerifier(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the SSL hostname verifier object for the DatabaseKind in the hub config
getSslHostnameVerifier(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getStagingDbName() - Method in class com.marklogic.hub.impl.VersionInfo
 
getStagingTriggersDbName() - Method in interface com.marklogic.hub.HubConfig
 
getStartTime() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
getStartTime() - Method in class com.marklogic.hub.legacy.job.Job
 
getStatus() - Method in class com.marklogic.hub.legacy.job.Job
 
getStatus() - Method in class com.marklogic.hub.step.RunStepResponse
 
getStep(String, String) - Method in interface com.marklogic.hub.dataservices.StepService
Invokes the getStep operation on the database server
getStep(String) - Method in interface com.marklogic.hub.flow.Flow
Gets the step specified by string key
getStep(String) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getStep(Flow, String) - Method in interface com.marklogic.hub.FlowManager
Deprecated.
getStep(Flow, String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
Deprecated.
getStepById(String) - Method in interface com.marklogic.hub.flow.Flow
Deprecated.
getStepById(String) - Method in class com.marklogic.hub.flow.impl.FlowImpl
Deprecated.
getStepConfig() - Method in class com.marklogic.hub.flow.FlowInputs
 
getStepDefinition(String, String) - Method in interface com.marklogic.hub.dataservices.StepDefinitionService
Invokes the getStepDefinition operation on the database server
getStepDefinition(String, StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
getStepDefinition(String, StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.step.MarkLogicStepDefinitionProvider
 
getStepDefinition(String, StepDefinition.StepDefinitionType) - Method in interface com.marklogic.hub.step.StepDefinitionProvider
 
getStepDefinition(String, StepDefinition.StepDefinitionType) - Method in interface com.marklogic.hub.StepDefinitionManager
Returns a single Step Definition given a name and a type
getStepDefinitionName() - Method in class com.marklogic.hub.step.impl.Step
 
getStepDefinitionName() - Method in class com.marklogic.hub.step.RunStepResponse
 
getStepDefinitionNamesByType(StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
getStepDefinitionNamesByType(StepDefinition.StepDefinitionType) - Method in interface com.marklogic.hub.StepDefinitionManager
Returns a list of Step Definition names that have the given type
getStepDefinitionPath(StepDefinition.StepDefinitionType) - Method in interface com.marklogic.hub.HubConfig
 
getStepDefinitionPath(StepDefinition.StepDefinitionType) - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub step directory by step type
getStepDefinitionPath(StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getStepDefinitionPath(StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getStepDefinitionPermissions() - Method in interface com.marklogic.hub.HubConfig
Prior to 5.2.0, entities were assigned permissions returned by getModulePermissions.
getStepDefinitionPermissions() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getStepDefinitions() - Method in class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
getStepDefinitions() - Method in interface com.marklogic.hub.StepDefinitionManager
Returns a list of all Step Definition currently defined
getStepDefinitionsByType(StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
getStepDefinitionsByType(StepDefinition.StepDefinitionType) - Method in interface com.marklogic.hub.StepDefinitionManager
Returns a list of Step Definitions that have the given type
getStepDefinitionsDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the step definitions directory
getStepDefinitionsDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the hub step-definitions directory
getStepDefinitionsDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getStepDefinitionsDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getStepDefinitionType() - Method in class com.marklogic.hub.step.impl.Step
 
getStepDefinitionType() - Method in class com.marklogic.hub.step.RunStepResponse
 
getStepDefinitionType(String) - Static method in enum com.marklogic.hub.step.StepDefinition.StepDefinitionType
 
getStepDefinitionTypes() - Static method in enum com.marklogic.hub.step.StepDefinition.StepDefinitionType
 
getStepEndTime() - Method in class com.marklogic.hub.step.RunStepResponse
 
getStepFile(StepDefinition.StepDefinitionType, String) - Method in interface com.marklogic.hub.HubProject
 
getStepFile(StepDefinition.StepDefinitionType, String) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getStepId() - Method in class com.marklogic.hub.step.impl.Step
 
getStepName(ObjectNode) - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
 
getStepName(String) - Method in class com.marklogic.hub.impl.StepManager
 
getStepName() - Method in class com.marklogic.hub.step.RunStepResponse
 
getStepOutput() - Method in class com.marklogic.hub.step.RunStepResponse
 
getStepResponses() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
getStepRunner(Flow, String) - Method in class com.marklogic.hub.step.StepRunnerFactory
 
getSteps() - Method in interface com.marklogic.hub.flow.Flow
Returns a map of Steps
getSteps() - Method in class com.marklogic.hub.flow.FlowInputs
 
getSteps() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getSteps(Flow) - Method in interface com.marklogic.hub.FlowManager
Deprecated.
getSteps() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getSteps(Flow) - Method in class com.marklogic.hub.impl.FlowManagerImpl
Deprecated.
getStepsByType(Stream<String>) - Method in interface com.marklogic.hub.dataservices.StepService
Invokes the getStepsByType operation on the database server
getStepsPath() - Method in interface com.marklogic.hub.HubProject
 
getStepsPath(StepDefinition.StepDefinitionType) - Method in interface com.marklogic.hub.HubProject
 
getStepsPath() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getStepsPath(StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getStepsPath(String) - Method in class com.marklogic.hub.impl.StepManager
 
getStepStartTime() - Method in class com.marklogic.hub.step.RunStepResponse
 
getString(Object) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a String value by key
getString(Object, String) - Method in class com.marklogic.hub.util.json.JSONObject
Gets a String value by key with a default value
getSubProperties() - Method in class com.marklogic.hub.entity.PropertyType
 
getSuccessfulBatches() - Method in class com.marklogic.hub.legacy.job.Job
 
getSuccessfulBatches() - Method in class com.marklogic.hub.step.impl.StepMetrics
 
getSuccessfulBatches() - Method in class com.marklogic.hub.step.RunStepResponse
 
getSuccessfulBatchesCount() - Method in class com.marklogic.hub.step.impl.StepMetrics
 
getSuccessfulEvents() - Method in class com.marklogic.hub.legacy.job.Job
 
getSuccessfulEvents() - Method in class com.marklogic.hub.step.impl.StepMetrics
 
getSuccessfulEvents() - Method in class com.marklogic.hub.step.RunStepResponse
 
getSuccessfulEventsCount() - Method in class com.marklogic.hub.step.impl.StepMetrics
 
getSupportConcepts() - Method in class com.marklogic.hub.impl.VersionInfo
 
getTargetDatabase() - Method in class com.marklogic.hub.step.RunStepResponse
 
getTargetEntityType() - Method in interface com.marklogic.hub.mapping.Mapping
Returns the IRI for the targeted entity type
getTargetEntityType() - Method in class com.marklogic.hub.mapping.MappingImpl
 
getTargetEntityType() - Method in class com.marklogic.hub.step.RunStepResponse
 
getThreadCount() - Method in interface com.marklogic.hub.flow.Flow
Returns flow thread count
getThreadCount() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getThreadCount() - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
getThreadCount() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getThreadCount() - Method in class com.marklogic.hub.step.impl.Step
 
getThreadCount() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the thread count
getTitle() - Method in class com.marklogic.hub.entity.InfoType
Gets the value of the title property.
getTotalEvents() - Method in class com.marklogic.hub.step.RunStepResponse
 
getTrustManager(DatabaseKind) - Method in interface com.marklogic.hub.HubConfig
Returns the TrustManager object for the DatabaseKind in the hub config
getTrustManager(DatabaseKind) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getType() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
getType() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Gets the FlowType enum for the flow
getType() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getType() - Method in interface com.marklogic.hub.step.StepDefinition
Returns the type of the Step
getUndoSortOrder() - Method in class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
 
getUris(String, Integer) - Method in interface com.marklogic.hub.dataservices.MappingService
Gets the list of URIs that match the 'sourceQuery' from source db associated with given step name.
getUser() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
getUserConfigDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the user config directory
getUserConfigDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the user config directory
getUserConfigDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getUserConfigDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getUserDatabaseDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the user database directory
getUserDatabaseDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the user database directory
getUserDatabaseDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getUserDatabaseDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getUserFinalModulesDir() - Method in interface com.marklogic.hub.HubProject
Deprecated.
getUserFinalModulesDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
Deprecated.
getUserModulesDeployTimestampFile() - Method in interface com.marklogic.hub.HubProject
 
getUserModulesDeployTimestampFile() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getUserSchemasDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the user schemas directory
getUserSchemasDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the user schemas directory
getUserSchemasDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getUserSchemasDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getUserSecurityDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the user security directory
getUserSecurityDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the user security directory
getUserSecurityDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getUserSecurityDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getUserServersDir() - Method in interface com.marklogic.hub.HubConfig
Gets the path for the user servers directory
getUserServersDir() - Method in interface com.marklogic.hub.HubProject
Gets the path for the user servers directory
getUserServersDir() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
getUserServersDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
getUserStagingModulesDir() - Method in interface com.marklogic.hub.HubProject
Deprecated.
getUserStagingModulesDir() - Method in class com.marklogic.hub.impl.HubProjectImpl
Deprecated.
getValue(JsonNode, String) - Static method in class com.marklogic.hub.entity.JsonPojo
 
getVersion() - Method in class com.marklogic.hub.entity.InfoType
Gets the value of the version property.
getVersion() - Method in interface com.marklogic.hub.flow.Flow
Gets version
getVersion() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
getVersion() - Method in interface com.marklogic.hub.mapping.Mapping
Returns the mapping version
getVersion() - Method in class com.marklogic.hub.mapping.MappingImpl
 
getVersion() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
getVersion() - Method in interface com.marklogic.hub.step.StepDefinition
Return the step version
getVersionFromViaLegacyRestExtension(DatabaseClient) - Method in class com.marklogic.hub.impl.Versions
 
getVersions() - Method in interface com.marklogic.hub.dataservices.SystemService
Invokes the getVersions operation on the database server
getWordLexicon() - Method in class com.marklogic.hub.entity.DefinitionType
 
GraphService - Interface in com.marklogic.hub.dataservices
 

H

handleFlowRunnerException(Exception) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
Deprecated.
handleSaveException(HttpClientErrorException) - Static method in class com.marklogic.hub.util.QueryRolesetUtil
Query rolesets have a bug in the Manage API in < 10.0-4 ML, and the Manage API no longer supports PUT requests (updates) on them in 10.0-4.
hasEmptyRangeElementIndexArray(ObjectNode) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
hasValues() - Method in class com.marklogic.hub.entity.ItemType
 
HUB_CONFIG_DIR - Static variable in interface com.marklogic.hub.HubConfig
 
HUB_CONFIG_DIR - Static variable in interface com.marklogic.hub.HubProject
 
HubCentralConverter - Class in com.marklogic.hub.hubcentral.conversion
 
HubCentralConverter(HubConfig) - Constructor for class com.marklogic.hub.hubcentral.conversion.HubCentralConverter
 
HubCentralManager - Class in com.marklogic.hub.hubcentral
Manager interface for operations that are distinctly HubCentral-specific.
HubCentralManager() - Constructor for class com.marklogic.hub.hubcentral.HubCentralManager
 
HubCentralService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
HubConfig - Interface in com.marklogic.hub
An interface to set, manage and recall the Data Hub's Configuration.
hubConfig - Variable in class com.marklogic.hub.impl.MappingManagerImpl
 
hubConfig - Variable in class com.marklogic.hub.impl.MasteringManagerImpl
 
HubConfigImpl - Class in com.marklogic.hub.impl
Extends HubConfigImpl to define all Data Hub properties, including those specific to deploying DHF.
HubConfigImpl() - Constructor for class com.marklogic.hub.impl.HubConfigImpl
Constructs a HubConfigImpl with a default set of property values.
HubConfigImpl(HubProject) - Constructor for class com.marklogic.hub.impl.HubConfigImpl
Constructor for when using this object outside of a Spring container, but a HubProject is still needed.
HubConfigImpl(String, String, String) - Constructor for class com.marklogic.hub.impl.HubConfigImpl
Provides a minimally-configured instance of HubConfigImpl based on DHF default properties, with no dependency on Spring or on project files.
HubConfigImpl(String, String, String, String, String) - Constructor for class com.marklogic.hub.impl.HubConfigImpl
Provides a minimally-configured instance of HubConfigImpl based on DHF default properties, with no dependency on Spring or on project files.
HubDatabaseManager(ManageClient) - Constructor for class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand.HubDatabaseManager
 
HubDeployDatabaseCommandFactory - Class in com.marklogic.hub.deploy.commands
Hub-specific factory implementation that's used to construct the hub-specific command for deploying a database.
HubDeployDatabaseCommandFactory(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.HubDeployDatabaseCommandFactory
 
HubDeployer - Class in com.marklogic.hub.deploy
Handles additional hub deployment scenarios beyond what "mlDeploy" is used for.
HubDeployer() - Constructor for class com.marklogic.hub.deploy.HubDeployer
 
HubEntity - Class in com.marklogic.hub.entity
 
HubEntity() - Constructor for class com.marklogic.hub.entity.HubEntity
 
HubFileFilter - Class in com.marklogic.hub.deploy.util
Simple implementation that accepts every file and ignores anything starting with ".".
HubFileFilter() - Constructor for class com.marklogic.hub.deploy.util.HubFileFilter
 
HubProject - Interface in com.marklogic.hub
Creates and gathers information about a hub project.
HubProjectImpl - Class in com.marklogic.hub.impl
 
HubProjectImpl() - Constructor for class com.marklogic.hub.impl.HubProjectImpl
 

I

importJobs(Path) - Method in class com.marklogic.hub.legacy.job.impl.LegacyJobManagerImpl
 
importJobs(Path) - Method in interface com.marklogic.hub.legacy.job.LegacyJobManager
Import Job documents and their associated Trace documents from a zip file.
incrementVersion() - Method in interface com.marklogic.hub.mapping.Mapping
Automatically increments the version of the mapping by 1
incrementVersion() - Method in class com.marklogic.hub.mapping.MappingImpl
 
incrementVersion() - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
incrementVersion() - Method in interface com.marklogic.hub.step.StepDefinition
Automatically increments the version of the mapping by 1
info - Variable in class com.marklogic.hub.entity.HubEntity
 
InfoType - Class in com.marklogic.hub.entity
 
InfoType() - Constructor for class com.marklogic.hub.entity.InfoType
 
IngestionStepDefinitionImpl - Class in com.marklogic.hub.step.impl
 
IngestionStepDefinitionImpl(String) - Constructor for class com.marklogic.hub.step.impl.IngestionStepDefinitionImpl
 
init(Map<String, String>) - Method in interface com.marklogic.hub.HubProject
Initializes a directory as a hub project directory.
init(Map<String, String>) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
initHubProject() - Method in interface com.marklogic.hub.HubConfig
Initializes the hub project on disk
initHubProject() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
initializeConfigDirs(AppConfig) - Method in class com.marklogic.hub.impl.HubConfigImpl
ml-app-deployer defaults to a single config path of src/main/ml-config.
initializeModulePaths(AppConfig) - Method in class com.marklogic.hub.impl.HubConfigImpl
Need to initialize every module path as being relative to the current project directory.
initializePropertyConsumerMap() - Method in class com.marklogic.hub.impl.HubConfigImpl
Defines functions for consuming properties from a PropertySource.
initProject() - Method in interface com.marklogic.hub.DataHub
Initializes the project on disk, creates scaffold project code
initProject() - Method in class com.marklogic.hub.impl.DataHubImpl
 
inputFilePath - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 
inputFileType - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 
install() - Method in interface com.marklogic.hub.DataHub
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() - Method in class com.marklogic.hub.impl.DataHubImpl
Installs the data hub configuration and server-side config files into MarkLogic
InstallInfo - Interface in com.marklogic.hub
Stores and reports information from MarkLogic server about the installed status of the DHF This interface abstracts holding state.
InstallInfoImpl - Class in com.marklogic.hub.impl
 
InstallInfoImpl() - Constructor for class com.marklogic.hub.impl.InstallInfoImpl
 
InvalidDBOperationError - Error in com.marklogic.hub.error
 
InvalidDBOperationError(DatabaseKind, String) - Constructor for error com.marklogic.hub.error.InvalidDBOperationError
 
isAppServerExistent(DatabaseKind) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
isAppServerExistent(DatabaseKind) - Method in interface com.marklogic.hub.InstallInfo
Checks to see if the App Server is present and accessible
isCatchExceptionsForUserModules() - Method in class com.marklogic.hub.deploy.commands.GenerateFunctionMetadataCommand
 
isCollectionLexiconOn(DatabaseKind) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
isCollectionLexiconOn(DatabaseKind) - Method in interface com.marklogic.hub.InstallInfo
Checks to see if the lexicon collection is set and on
isCustomMapping(Step) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
isCustomStep() - Method in class com.marklogic.hub.step.impl.Step
 
isDbExistent(DatabaseKind) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
isDbExistent(DatabaseKind) - Method in interface com.marklogic.hub.InstallInfo
Checks to see if the Database is present and accessible
isEnabled() - Method in class com.marklogic.hub.legacy.impl.LegacyDebuggingImpl
 
isEnabled() - Method in class com.marklogic.hub.legacy.impl.LegacyTracingImpl
 
isEnabled() - Method in interface com.marklogic.hub.legacy.LegacyDebugging
Determines if the hub has debugging enabled or not
isEnabled() - Method in interface com.marklogic.hub.legacy.LegacyTracing
Determines if the hub has tracing enabled or not
isEqual(Object) - Method in class com.marklogic.hub.step.impl.Step
 
isExist(String) - Method in class com.marklogic.hub.util.json.JSONObject
Checks if the key is existed or not
isFlowExisted(String) - Method in interface com.marklogic.hub.FlowManager
Check if a flow has existed
isFlowExisted(String) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
isInitialized() - Method in interface com.marklogic.hub.HubProject
Checks if the project has been initialized or not
isInitialized() - Method in class com.marklogic.hub.impl.HubProjectImpl
 
isInstalled() - Method in interface com.marklogic.hub.DataHub
Determines if the data hub is installed in MarkLogic
isInstalled() - Method in class com.marklogic.hub.impl.DataHubImpl
 
isInstalled() - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
isInstalled() - Method in interface com.marklogic.hub.InstallInfo
Checks if DHF has been installed
isJobRunning() - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
isMappingStep() - Method in class com.marklogic.hub.step.impl.Step
 
isPartiallyInstalled() - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
isPartiallyInstalled() - Method in interface com.marklogic.hub.InstallInfo
Returns if an install has been performed, but not complete
isPortInUse(DatabaseKind) - Method in interface com.marklogic.hub.DataHub
Checks to see if the port is in use
isPortInUse(DatabaseKind) - Method in class com.marklogic.hub.impl.DataHubImpl
 
isRemoveSchemaAndTriggersDatabaseSettings() - Method in class com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand
 
isSafeToInstall() - Method in interface com.marklogic.hub.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.
isSafeToInstall() - Method in class com.marklogic.hub.impl.DataHubImpl
 
isServerVersionOk() - Method in interface com.marklogic.hub.DataHub
Checks to see if the datahub and server versions are compatible
isServerVersionOk() - Method in class com.marklogic.hub.impl.DataHubImpl
 
isServerVersionValid(String) - Method in interface com.marklogic.hub.DataHub
Validates the MarkLogic server to ensure compatibility with the hub
isServerVersionValid(String) - Method in class com.marklogic.hub.impl.DataHubImpl
 
isStopOnError() - Method in interface com.marklogic.hub.flow.Flow
Returns the value for stop on error flag
isStopOnError() - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
isStopped - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 
isSuccess() - Method in class com.marklogic.hub.step.RunStepResponse
 
isTripleIndexOn(DatabaseKind) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
isTripleIndexOn(DatabaseKind) - Method in interface com.marklogic.hub.InstallInfo
Checks to see if the triple index is set and on
ItemType - Class in com.marklogic.hub.entity
 
ItemType() - Constructor for class com.marklogic.hub.entity.ItemType
 
iterator() - Method in class com.marklogic.hub.legacy.collector.DiskQueue
 
iterator() - Method in class com.marklogic.hub.util.DiskQueue
 

J

JacksonUtil - Class in com.marklogic.hub.util
Contains convenience methods for when working with the com.fasterxml.jackson library.
JacksonUtil() - Constructor for class com.marklogic.hub.util.JacksonUtil
 
Job - Class in com.marklogic.hub.legacy.job
 
jobAppServerExists - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
jobDbExists - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
JobDeleteResource(DatabaseClient) - Constructor for class com.marklogic.hub.legacy.job.impl.LegacyJobManagerImpl.JobDeleteResource
 
JobDeleteResponse - Class in com.marklogic.hub.legacy.job
 
JobDeleteResponse() - Constructor for class com.marklogic.hub.legacy.job.JobDeleteResponse
 
JobExportResponse - Class in com.marklogic.hub.legacy.job
 
JobExportResponse() - Constructor for class com.marklogic.hub.legacy.job.JobExportResponse
 
jobForestsExist - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
jobForestsPerHost - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
jobHttpName - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
jobId - Variable in class com.marklogic.hub.step.ResponseHolder
 
JobManager - Class in com.marklogic.hub.flow
 
JobManager(HubClient) - Constructor for class com.marklogic.hub.flow.JobManager
 
JobService - Interface in com.marklogic.hub.dataservices
Defines endpoints for managing Job documents
JobStatus - Enum in com.marklogic.hub.flow.impl
 
JobStatus - Enum in com.marklogic.hub.legacy.job
 
jsonNode() - Method in class com.marklogic.hub.util.json.JSONObject
Returns the json instance
JSONObject - Class in com.marklogic.hub.util.json
 
JSONObject() - Constructor for class com.marklogic.hub.util.json.JSONObject
 
JSONObject(boolean) - Constructor for class com.marklogic.hub.util.json.JSONObject
 
JSONObject(Object) - Constructor for class com.marklogic.hub.util.json.JSONObject
 
JSONObject(JsonNode) - Constructor for class com.marklogic.hub.util.json.JSONObject
 
JsonPojo - Class in com.marklogic.hub.entity
 
JsonPojo() - Constructor for class com.marklogic.hub.entity.JsonPojo
 
JSONStreamWriter - Class in com.marklogic.hub.util.json
 
JSONStreamWriter(OutputStream) - Constructor for class com.marklogic.hub.util.json.JSONStreamWriter
 
jsonToString(JsonNode) - Static method in class com.marklogic.hub.step.impl.StepRunnerUtil
 
JSONUtils - Class in com.marklogic.hub.util.json
 
JSONUtils() - Constructor for class com.marklogic.hub.util.json.JSONUtils
 

L

LegacyCollector - Interface in com.marklogic.hub.legacy.collector
Manages config and client for the collector, as well as runs the collector for the associated entity and flow
LegacyCollectorImpl - Class in com.marklogic.hub.legacy.collector.impl
 
LegacyCollectorImpl() - Constructor for class com.marklogic.hub.legacy.collector.impl.LegacyCollectorImpl
 
LegacyCollectorImpl(String, CodeFormat) - Constructor for class com.marklogic.hub.legacy.collector.impl.LegacyCollectorImpl
 
LegacyDebugging - Interface in com.marklogic.hub.legacy
Enables or disables debugging in the DHF for the specified database using the supplied client.
LegacyDebuggingImpl - Class in com.marklogic.hub.legacy.impl
 
LegacyDebuggingImpl(DatabaseClient) - Constructor for class com.marklogic.hub.legacy.impl.LegacyDebuggingImpl
 
LegacyFlow - Interface in com.marklogic.hub.legacy.flow
Manages the creation and configuration of flow objects
LegacyFlowBuilder - Class in com.marklogic.hub.legacy.flow
 
LegacyFlowFinishedListener - Interface in com.marklogic.hub.legacy.flow
 
LegacyFlowImpl - Class in com.marklogic.hub.legacy.flow.impl
 
LegacyFlowImpl() - Constructor for class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
LegacyFlowItemCompleteListener - Interface in com.marklogic.hub.legacy.flow
 
LegacyFlowItemFailureListener - Interface in com.marklogic.hub.legacy.flow
 
LegacyFlowManager - Interface in com.marklogic.hub.legacy
Manages existing flows and creates flow runners to execute flows.
LegacyFlowManagerImpl - Class in com.marklogic.hub.legacy.impl
 
LegacyFlowManagerImpl() - Constructor for class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
LegacyFlowManagerImpl(HubConfig) - Constructor for class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
For use outside of a Spring container.
LegacyFlowRunner - Interface in com.marklogic.hub.legacy.flow
Executes a flow with options
LegacyFlowRunnerImpl - Class in com.marklogic.hub.legacy.flow.impl
 
LegacyFlowRunnerImpl(HubConfig) - Constructor for class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
LegacyFlowRunnerImpl() - Constructor for class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
LegacyFlowStatusListener - Interface in com.marklogic.hub.legacy.flow
 
LegacyJobManager - Interface in com.marklogic.hub.legacy.job
Handles jobs and their creation, status, and deletion.
LegacyJobManagerImpl - Class in com.marklogic.hub.legacy.job.impl
 
LegacyJobManagerImpl(DatabaseClient) - Constructor for class com.marklogic.hub.legacy.job.impl.LegacyJobManagerImpl
 
LegacyJobManagerImpl.JobDeleteResource - Class in com.marklogic.hub.legacy.job.impl
 
LegacyTracing - Interface in com.marklogic.hub.legacy
Enables or disables tracing in the DHF for the specified database using the supplied client.
LegacyTracingImpl - Class in com.marklogic.hub.legacy.impl
 
LegacyTracingImpl(DatabaseClient) - Constructor for class com.marklogic.hub.legacy.impl.LegacyTracingImpl
 
listDirectFiles(File) - Static method in class com.marklogic.hub.util.FileUtil
 
listDirectFiles(String) - Static method in class com.marklogic.hub.util.FileUtil
 
listDirectFiles(Path) - Static method in class com.marklogic.hub.util.FileUtil
 
listDirectFolders(File) - Static method in class com.marklogic.hub.util.FileUtil
 
listDirectFolders(String) - Static method in class com.marklogic.hub.util.FileUtil
 
listDirectFolders(Path) - Static method in class com.marklogic.hub.util.FileUtil
 
loadConfigurationFromProperties(Properties, boolean) - Method in class com.marklogic.hub.impl.HubConfigImpl
Use this when you need to apply properties, and you likely also want to load properties from Gradle files.
loadFromFile(File) - Static method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
LoadHubArtifactsCommand - Class in com.marklogic.hub.deploy.commands
Loads hub artifacts (ootb flows and step defs).
LoadHubArtifactsCommand() - Constructor for class com.marklogic.hub.deploy.commands.LoadHubArtifactsCommand
 
LoadHubArtifactsCommand(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.LoadHubArtifactsCommand
For use outside of a Spring container.
LoadHubModulesCommand - Class in com.marklogic.hub.deploy.commands
Handles loading modules that are contained within the DHF jar.
LoadHubModulesCommand() - Constructor for class com.marklogic.hub.deploy.commands.LoadHubModulesCommand
 
LoadHubModulesCommand(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.LoadHubModulesCommand
For use outside of a Spring container.
loadStepRunnerParameters() - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
loadUserArtifacts() - Method in class com.marklogic.hub.deploy.commands.LoadUserArtifactsCommand
The CommandContext has no bearing on how user artifacts are loaded, so this method is easier to use when this class is used outside a deployment context.
LoadUserArtifactsCommand - Class in com.marklogic.hub.deploy.commands
Loads user artifacts like mappings and entities.
LoadUserArtifactsCommand() - Constructor for class com.marklogic.hub.deploy.commands.LoadUserArtifactsCommand
 
LoadUserArtifactsCommand(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.LoadUserArtifactsCommand
For use outside of a Spring container.
LoadUserModulesCommand - Class in com.marklogic.hub.deploy.commands
Extends ml-app-deployer's LoadModulesCommand, which expects to load from every path defined by "mlModulePaths", so that it can also load from two DHF-specific locations - "./plugins" and "src/main/entity-config".
LoadUserModulesCommand() - Constructor for class com.marklogic.hub.deploy.commands.LoadUserModulesCommand
 
LoadUserModulesCommand(HubConfig) - Constructor for class com.marklogic.hub.deploy.commands.LoadUserModulesCommand
For use outside of a Spring container.
logger - Variable in class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
logger - Variable in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
logger - Variable in class com.marklogic.hub.impl.DataHubImpl
 
logger - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 

M

MainPlugin - Interface in com.marklogic.hub.legacy
Interface to the in-memory representation of the main plugin module (main.sjs or main.xqy)
MainPluginImpl - Class in com.marklogic.hub.legacy.impl
 
MainPluginImpl() - Constructor for class com.marklogic.hub.legacy.impl.MainPluginImpl
 
MainPluginImpl(String, CodeFormat) - Constructor for class com.marklogic.hub.legacy.impl.MainPluginImpl
 
makeCombinedOptions(Flow, StepDefinition, String, Map<String, Object>) - Static method in class com.marklogic.hub.step.impl.StepRunnerUtil
Note that this logic exists in flow-utils.sjs as well; this is apparently because FlowRunner needs to combine options before it runs any steps.
Mapping - Interface in com.marklogic.hub.mapping
 
MAPPING_FILE_EXTENSION - Static variable in interface com.marklogic.hub.MappingManager
String value for the mapping file extension
MappingDefModulesFinder - Class in com.marklogic.client.ext.modulesloader.impl
 
MappingDefModulesFinder() - Constructor for class com.marklogic.client.ext.modulesloader.impl.MappingDefModulesFinder
 
MappingImpl - Class in com.marklogic.hub.mapping
 
MappingImpl(String) - Constructor for class com.marklogic.hub.mapping.MappingImpl
 
MappingImpl(String, HubEntity) - Constructor for class com.marklogic.hub.mapping.MappingImpl
 
mappingIsReferencedByAFlow(Step) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
MappingManager - Interface in com.marklogic.hub
Handles the artifacts associated with mapping of source documents into entity services models.
MappingManagerImpl - Class in com.marklogic.hub.impl
 
MappingManagerImpl() - Constructor for class com.marklogic.hub.impl.MappingManagerImpl
 
MappingManagerImpl(HubConfig) - Constructor for class com.marklogic.hub.impl.MappingManagerImpl
 
MappingService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
MappingStepDefinitionImpl - Class in com.marklogic.hub.step.impl
 
MappingStepDefinitionImpl(String) - Constructor for class com.marklogic.hub.step.impl.MappingStepDefinitionImpl
 
MappingValidator - Class in com.marklogic.hub.mapping
This is no longer used in DHF, but is still required by DHCCE.
MappingValidator(DatabaseClient) - Constructor for class com.marklogic.hub.mapping.MappingValidator
 
MarkLogicStepDefinitionProvider - Class in com.marklogic.hub.step
Implementation that retrieves step definitions from MarkLogic via a data service.
MarkLogicStepDefinitionProvider(DatabaseClient) - Constructor for class com.marklogic.hub.step.MarkLogicStepDefinitionProvider
 
MasteringManager - Interface in com.marklogic.hub
Handles the calls to the Mastering endpoints.
MasteringManagerImpl - Class in com.marklogic.hub.impl
 
MasteringManagerImpl(HubConfig) - Constructor for class com.marklogic.hub.impl.MasteringManagerImpl
 
MasteringManagerImpl(HubClientConfig) - Constructor for class com.marklogic.hub.impl.MasteringManagerImpl
 
MasteringService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
MasteringStepDefinitionImpl - Class in com.marklogic.hub.step.impl
 
MasteringStepDefinitionImpl(String) - Constructor for class com.marklogic.hub.step.impl.MasteringStepDefinitionImpl
 
match(String, String, String, Boolean, JsonNode) - Method in class com.marklogic.hub.impl.MasteringManagerImpl
 
match(String, String, String, Boolean, JsonNode) - Method in interface com.marklogic.hub.MasteringManager
Returns potential candidates for merging with a document
MatchingStepDefinitionImpl - Class in com.marklogic.hub.step.impl
 
MatchingStepDefinitionImpl(String) - Constructor for class com.marklogic.hub.step.impl.MatchingStepDefinitionImpl
 
merge(List<String>, String, String, Boolean, JsonNode) - Method in class com.marklogic.hub.impl.MasteringManagerImpl
 
merge(List<String>, String, String, Boolean, JsonNode) - Method in interface com.marklogic.hub.MasteringManager
Manually merges a set of documents
mergeExistingArrayProperties(ObjectNode, ObjectNode) - Static method in class com.marklogic.hub.deploy.util.ResourceUtil
Given a set of properties to save, this will update each array property in that set with the items from the same array in the given existingResourceProperties object, if the array property exists in that object.
mergePayloadWithEntityConfigFileIfItExists(CommandContext, ObjectNode) - Method in class com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand
When either staging-database.json or final-database.json is processed (and in the case of staging-database.json, it could be under the hub config or user config directory), need to check to see if a same-named file is in the entity config directory, where entity-specific database configuration is written.
mergePreview(String, List<String>) - Method in class com.marklogic.hub.impl.MasteringManagerImpl
 
mergePreview(String, List<String>) - Method in interface com.marklogic.hub.MasteringManager
Manually merges a set of documents
MergingStepDefinitionImpl - Class in com.marklogic.hub.step.impl
 
MergingStepDefinitionImpl(String) - Constructor for class com.marklogic.hub.step.impl.MergingStepDefinitionImpl
 
migrateProvenance(Reader, Reader) - Method in interface com.marklogic.hub.dataservices.ProvenanceService
Migrates provenance to provenance format starting in DH 5.7.
migrateProvenanceRecords() - Method in class com.marklogic.hub.provenance.ProvenanceManager
 
ModelsService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
MODULES_DIR - Static variable in class com.marklogic.hub.impl.HubProjectImpl
 
modulesDbExists - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
modulesForestsPerHost - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
ModuleWatchingConsumer - Class in com.marklogic.hub.deploy.util
Consumer implementation to be used with mlWatch.
ModuleWatchingConsumer(CommandContext, Command) - Constructor for class com.marklogic.hub.deploy.util.ModuleWatchingConsumer
 

N

name - Variable in class com.marklogic.hub.entity.DefinitionType
 
name - Variable in class com.marklogic.hub.entity.PropertyType
 
namespace - Variable in class com.marklogic.hub.entity.DefinitionType
 
namespacePrefix - Variable in class com.marklogic.hub.entity.DefinitionType
 
needToSwitchToDefaultRewriter() - Method in class com.marklogic.hub.deploy.commands.LoadHubModulesCommand
 
newAppServicesClient() - Method in interface com.marklogic.hub.HubConfig
Creates a new DatabaseClient for accessing the AppServices app
newAppServicesClient() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
newAppServicesModulesClient() - Method in interface com.marklogic.hub.HubConfig
 
newAppServicesModulesClient() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
newDeployDatabaseCommand(File) - Method in class com.marklogic.hub.deploy.commands.HubDeployDatabaseCommandFactory
 
newFinalClient() - Method in interface com.marklogic.hub.HubConfig
Gets a new DatabaseClient that queries the Final database and appserver
newFinalClient(String) - Method in interface com.marklogic.hub.HubConfig
Gets a new DatabaseClient that queries the Final database using the final appserver.
newFinalClient() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
newFlow() - Static method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
newFlowRunner() - Method in class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
newFlowRunner() - Method in interface com.marklogic.hub.legacy.LegacyFlowManager
Creates and returns a new LegacyFlowRunner object using the FlowManager's hubconfig
newHubClient() - Method in interface com.marklogic.hub.HubConfig
 
newHubClient() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
newJobDbClient() - Method in interface com.marklogic.hub.HubConfig
Creates a new DatabaseClient for accessing the Job database
newModulesDbClient() - Method in interface com.marklogic.hub.HubConfig
Creates a new DatabaseClient for accessing the Hub Modules database
newReverseFlowClient() - Method in interface com.marklogic.hub.HubConfig
Gets a new DatabaseClient that queries the Final database using the staging appserver.
newReverseFlowClient() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
newSessionState() - Method in interface com.marklogic.hub.dataservices.StepRunnerService
Creates an object to track a session for a set of operations that require session state on the database server.
newStagingClient() - Method in interface com.marklogic.hub.HubConfig
Gets a new DatabaseClient that queries the staging database and appserver
newStagingClient(String) - Method in interface com.marklogic.hub.HubConfig
Gets a new DatabaseClient that queries the staging database and appserver
newStagingClient() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
newTraceDbClient() - Method in interface com.marklogic.hub.HubConfig
Deprecated.
newTraceDbClient() - Method in class com.marklogic.hub.impl.HubConfigImpl
Deprecated.
newVersionInfo(HubClient) - Static method in class com.marklogic.hub.impl.VersionInfo
 
newWriterWithSeparateLinesForArrayValues() - Static method in class com.marklogic.hub.util.JacksonUtil
Convenient for print JSON nodes with arrays that have potentially many values, such that seeing them all on one line would be very difficult to read.
nodeExpand(JsonNode, Integer) - Method in interface com.marklogic.hub.dataservices.GraphService
 
notifications(int, int) - Method in class com.marklogic.hub.impl.MasteringManagerImpl
 
notifications(int, int) - Method in interface com.marklogic.hub.MasteringManager
Returns notifications

O

objectToString(Object) - Static method in class com.marklogic.hub.step.impl.StepRunnerUtil
 
offer(String) - Method in class com.marklogic.hub.legacy.collector.DiskQueue
 
offer(String) - Method in class com.marklogic.hub.util.DiskQueue
 
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.ArtifactService
Creates a ArtifactService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.ArtifactService
Creates a ArtifactService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.ConceptService
Creates a ConceptService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.ConceptService
Creates a ConceptService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.CustomStepService
Creates a CustomStepService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.CustomStepService
Creates a CustomStepService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.EntitySearchService
Creates a EntitySearchService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.EntitySearchService
Creates a EntitySearchService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.FlowService
Creates a FlowService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.FlowService
Creates a FlowService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.GraphService
 
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.GraphService
 
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.HubCentralService
Creates a HubCentralService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.HubCentralService
Creates a HubCentralService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.JobService
Creates a JobService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.JobService
Creates a JobService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.MappingService
Creates a MappingService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.MappingService
Creates a MappingService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.MasteringService
Creates a MasteringService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.MasteringService
Creates a MasteringService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.ModelsService
Creates a ModelsService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.ModelsService
Creates a ModelsService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.ProvenanceService
Creates a ProvenanceService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.ProvenanceService
Creates a ProvenanceService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.SecurityService
Creates a SecurityService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.SecurityService
Creates a SecurityService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.StepDefinitionService
Creates a StepDefinitionService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.StepDefinitionService
Creates a StepDefinitionService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.StepRunnerService
Creates a StepRunnerService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.StepRunnerService
Creates a StepRunnerService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.StepService
Creates a StepService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.StepService
Creates a StepService object for executing operations on the database server.
on(DatabaseClient) - Static method in interface com.marklogic.hub.dataservices.SystemService
Creates a SystemService object for executing operations on the database server.
on(DatabaseClient, JSONWriteHandle) - Static method in interface com.marklogic.hub.dataservices.SystemService
Creates a SystemService object for executing operations on the database server.
onFinished(LegacyFlowFinishedListener) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
onFinished(LegacyFlowFinishedListener) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets the finished listener for when the item has processed (similar to a finally)
onFlowFinished() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowFinishedListener
Listens for when the flow is complete
onItemComplete(LegacyFlowItemCompleteListener) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
onItemComplete(LegacyFlowItemCompleteListener) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets a listener on each item completing
onItemComplete(StepItemCompleteListener) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
onItemComplete(StepItemCompleteListener) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
onItemComplete(StepItemCompleteListener) - Method in interface com.marklogic.hub.step.StepRunner
Sets a listener on each item completing
onItemFailed(LegacyFlowItemFailureListener) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
onItemFailed(LegacyFlowItemFailureListener) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets the failure listener for each item in the flow
onItemFailed(StepItemFailureListener) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
onItemFailed(StepItemFailureListener) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
onItemFailed(StepItemFailureListener) - Method in interface com.marklogic.hub.step.StepRunner
Sets the failure listener for each item in the flow
onStatusChange(String, int, String) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowStatusListener
 
onStatusChange(String, int, String, long, long, String) - Method in interface com.marklogic.hub.step.StepStatusListener
 
onStatusChanged(FlowStatusListener) - Method in interface com.marklogic.hub.flow.FlowRunner
Sets the status change listener on the flowrunner object
onStatusChanged(String, Step, String, int, long, long, String) - Method in interface com.marklogic.hub.flow.FlowStatusListener
 
onStatusChanged(FlowStatusListener) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
onStatusChanged(LegacyFlowStatusListener) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
onStatusChanged(LegacyFlowStatusListener) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets the status change listener on the flowrunner object
onStatusChanged(StepStatusListener) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
onStatusChanged(StepStatusListener) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
onStatusChanged(StepStatusListener) - Method in interface com.marklogic.hub.step.StepRunner
Sets the status change listener on the flowrunner object
outputCollections - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 
outputFormat - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 
outputPermissions - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 
outputURIPrefix - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 
outputURIReplacement - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 

P

PATH_PREFIX - Static variable in interface com.marklogic.hub.HubConfig
 
PATH_PREFIX - Static variable in interface com.marklogic.hub.HubProject
 
peek() - Method in class com.marklogic.hub.legacy.collector.DiskQueue
 
peek() - Method in class com.marklogic.hub.util.DiskQueue
 
pii - Variable in class com.marklogic.hub.entity.DefinitionType
 
PII_PROTECTED_PATHS_FILE - Static variable in interface com.marklogic.hub.HubConfig
 
PII_QUERY_ROLESET_FILE - Static variable in interface com.marklogic.hub.HubConfig
 
poll() - Method in class com.marklogic.hub.legacy.collector.DiskQueue
 
poll() - Method in class com.marklogic.hub.util.DiskQueue
 
prepareAppConfigForDeployingToDhs(HubConfig) - Method in class com.marklogic.hub.deploy.HubDeployer
The AppConfig object belonging to HubConfig can be configured based on known DHS environment settings.
prepareAssetFileLoader(AssetFileLoader, CommandContext) - Method in class com.marklogic.hub.deploy.commands.LoadHubModulesCommand
 
preparePayloadBeforeSubmitting(CommandContext, String) - Method in class com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand
 
prepareProjectBeforeUpgrading(HubProject, String) - Method in class com.marklogic.hub.impl.DataHubImpl
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.
prettyPrint() - Method in class com.marklogic.hub.util.json.JSONObject
Makes pretty print for the json instance
previewFixingDocuments(String) - Method in class com.marklogic.hub.util.CreatedByStepFixer
 
previewMatchingActivity(Integer, Stream<String>, String, Boolean, Boolean) - Method in interface com.marklogic.hub.dataservices.MasteringService
Invokes the previewMatchingActivity operation on the database server
primaryKey - Variable in class com.marklogic.hub.entity.DefinitionType
 
processBatch(SessionState, JsonNode) - Method in interface com.marklogic.hub.dataservices.StepRunnerService
Replacement for the mlRunFlow REST extension; processes a batch of items using the given flow and step
processCompletion(String, String) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowItemCompleteListener
Listener interface for each flow item completing successfully
processCompletion(String, String) - Method in interface com.marklogic.hub.step.StepItemCompleteListener
Listener interface for each flow item completing successfully
processDocumentFile(DocumentFile) - Method in class com.marklogic.client.ext.file.CacheBusterDocumentFileProcessor
 
processFailure(String, String) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowItemFailureListener
Listener interface for each flow item that failed
processFailure(String, String) - Method in interface com.marklogic.hub.step.StepItemFailureListener
Listener interface for each flow item that failed
properties - Variable in class com.marklogic.hub.entity.DefinitionType
 
PropertyType - Class in com.marklogic.hub.entity
 
PropertyType() - Constructor for class com.marklogic.hub.entity.PropertyType
 
ProvenanceManager - Class in com.marklogic.hub.provenance
 
ProvenanceManager(HubClient) - Constructor for class com.marklogic.hub.provenance.ProvenanceManager
 
ProvenanceService - Interface in com.marklogic.hub.dataservices
Defines endpoints for viewing and managing provenance documents
publishDraftModels() - Method in interface com.marklogic.hub.dataservices.ModelsService
Moves draft entity models to the published collection and clear out the draft collection
put(String, Object) - Method in class com.marklogic.hub.util.json.JSONObject
Puts (key, value) pairs to the json instance
putArray(String, Object...) - Method in class com.marklogic.hub.util.json.JSONObject
Puts a number of Objects into Json Array of the json instance
putArray(String, List<?>) - Method in class com.marklogic.hub.util.json.JSONObject
Puts a list of Objects into Json Array of the json instance
putMap(Map<String, Object>) - Method in class com.marklogic.hub.util.json.JSONObject
Puts map entries to the json instance
putPayload(ManageClient, String, String) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand.HubDatabaseManager
 

Q

QueryRolesetUtil - Class in com.marklogic.hub.util
 
QueryRolesetUtil() - Constructor for class com.marklogic.hub.util.QueryRolesetUtil
 
QueryStepRunner - Class in com.marklogic.hub.step.impl
 
QueryStepRunner(HubClient) - Constructor for class com.marklogic.hub.step.impl.QueryStepRunner
 

R

rangeIndex - Variable in class com.marklogic.hub.entity.DefinitionType
 
readInput(String) - Static method in class com.marklogic.hub.util.json.JSONObject
Returns a Json node instance from a json String
readInput(InputStream) - Static method in class com.marklogic.hub.util.json.JSONObject
Returns a Json node instance from an input stream
readInput(Reader) - Static method in class com.marklogic.hub.util.json.JSONObject
Returns a Json node instance from an input reader
ref - Variable in class com.marklogic.hub.entity.ItemType
 
ref - Variable in class com.marklogic.hub.entity.PropertyType
 
refreshProject() - Method in interface com.marklogic.hub.HubConfig
Loads HubConfig object with values from gradle.properties (optionally overridden with gradle-(environment).properties).
refreshProject() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
remove() - Method in class com.marklogic.hub.legacy.collector.DiskQueue
 
remove() - Method in class com.marklogic.hub.util.DiskQueue
 
removeCollationFromEntityReferenceProperties(JsonNode) - Method in class com.marklogic.hub.impl.EntityManagerImpl
Per DHFPROD-3472, when a property in QS is changed to an entity reference, a collation is still defined for it.
removeDatabaseNameFromXmlPayload(String) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand.HubDatabaseManager
The database-name is not required, and for a data-hub-developer, the inclusion of it will cause a Forbidden error from the Manage API.
removeDefinition(String) - Method in class com.marklogic.hub.entity.DefinitionsType
 
removeEmptyRangeElementIndexArrayFromFinalDatabaseFile() - Method in class com.marklogic.hub.impl.HubProjectImpl
This method uses warn-level log messages to ensure they appear when upgrading a project via Gradle.
removeHubInternalConfigFromConfigDirs(AppConfig) - Method in class com.marklogic.hub.deploy.HubDeployer
The contents of hub-internal-config should have been deployed to DHS already via the DHF installer.
removeStepFromFlow(String, String) - Method in interface com.marklogic.hub.dataservices.FlowService
Invokes the removeStepFromFlow operation on the database server
removeStepFromFlow(Flow, String) - Static method in class com.marklogic.hub.impl.FlowManagerImpl
Extracted for reuse in HubCentral
replaceLanguageWithLang(ObjectNode) - Method in class com.marklogic.hub.deploy.commands.LoadUserArtifactsCommand
Per DHFPROD-3193 and an update to MarkLogic 10.0-2, "lang" must now be used instead of "language".
required - Variable in class com.marklogic.hub.entity.DefinitionType
 
requireHubProject() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
ResourceUtil - Class in com.marklogic.hub.deploy.util
This isn't "JsonUtil" because its current scope is specific to JSON resource payloads and the Manage API.
ResourceUtil() - Constructor for class com.marklogic.hub.deploy.util.ResourceUtil
 
ResponseHolder - Class in com.marklogic.hub.step
 
ResponseHolder() - Constructor for class com.marklogic.hub.step.ResponseHolder
 
ROLES_THAT_CAN_BE_INHERITED - Static variable in class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
Defines the roles that can be inherited when a data-hub-security-admin creates or edits a custom role.
run(String, String, String, int, Map<String, Object>) - Method in class com.marklogic.hub.legacy.collector.impl.LegacyCollectorImpl
Deprecated.
run(String, String, String, int, Map<String, Object>) - Method in interface com.marklogic.hub.legacy.collector.LegacyCollector
Obtains and grabs a list of uris that match the collector code
run() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
Deprecated.
run() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Runs the flow and creates the job
run(Path) - Method in class com.marklogic.hub.step.impl.FileCollector
 
run() - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
run(Collection<String>) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
run(String, String, Map<String, Object>) - Method in class com.marklogic.hub.step.impl.SourceQueryCollector
 
run() - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
run(Collection<String>) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
run() - Method in interface com.marklogic.hub.step.StepRunner
Runs the flow and creates the job
run(Collection<String>) - Method in interface com.marklogic.hub.step.StepRunner
Runs the flow and creates the job.
runExecCaller(DatabaseClient, String, ObjectNode, String) - Static method in class com.marklogic.hub.dataservices.BulkUtil
 
runFlow(FlowInputs) - Method in interface com.marklogic.hub.flow.FlowRunner
Run a flow without any dependency on an underlying HubProject for either finding artifacts (flows and step definitions) or for resolving file paths for an ingestion step.
runFlow(String, String) - Method in interface com.marklogic.hub.flow.FlowRunner
Deprecated.
Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
runFlow(String, List<String>, String) - Method in interface com.marklogic.hub.flow.FlowRunner
Deprecated.
Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
runFlow(String, String, Map<String, Object>) - Method in interface com.marklogic.hub.flow.FlowRunner
Deprecated.
Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
runFlow(String, List<String>, String, Map<String, Object>) - Method in interface com.marklogic.hub.flow.FlowRunner
Deprecated.
Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
runFlow(String, List<String>, String, Map<String, Object>, Map<String, Object>) - Method in interface com.marklogic.hub.flow.FlowRunner
Deprecated.
Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
runFlow(String, List<String>) - Method in interface com.marklogic.hub.flow.FlowRunner
Deprecated.
Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
runFlow(String) - Method in interface com.marklogic.hub.flow.FlowRunner
Deprecated.
Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
runFlow(String) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
Deprecated.
runFlow(String, List<String>) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
Deprecated.
runFlow(String, String) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
Deprecated.
runFlow(String, List<String>, String) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
Deprecated.
runFlow(String, String, Map<String, Object>) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
Deprecated.
runFlow(String, List<String>, String, Map<String, Object>) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
Deprecated.
runFlow(String, List<String>, String, Map<String, Object>, Map<String, Object>) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
Deprecated.
runFlow(FlowInputs) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
Retrieves the given flow from the staging database in MarkLogic, and then proceeds with the normal execution of the flow.
runFlow(Flow, List<String>, String, Map<String, Object>, Map<String, Object>) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
RunFlowResponse - Class in com.marklogic.hub.flow
 
RunFlowResponse(String) - Constructor for class com.marklogic.hub.flow.RunFlowResponse
 
RunFlowResponse() - Constructor for class com.marklogic.hub.flow.RunFlowResponse
 
RunFlowResponse - Class in com.marklogic.hub.legacy.flow
 
RunFlowResponse() - Constructor for class com.marklogic.hub.legacy.flow.RunFlowResponse
 
RUNNING_PREFIX - Static variable in enum com.marklogic.hub.flow.impl.JobStatus
 
runPreInstallCheck() - Method in interface com.marklogic.hub.DataHub
Runs the pre-install check for the datahub populating the object with variables necessary to perform the install.
runPreInstallCheck() - Method in class com.marklogic.hub.impl.DataHubImpl
 
runPreInstallCheck(ServerManager) - Method in class com.marklogic.hub.impl.DataHubImpl
This overloaded version was added to facilitate mock testing - i.e.
runStatusListener(double, StepMetrics) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
RunStepResponse - Class in com.marklogic.hub.step
 
RunStepResponse() - Constructor for class com.marklogic.hub.step.RunStepResponse
 

S

saveConceptModels(JsonNode) - Method in interface com.marklogic.hub.dataservices.ConceptService
Save an array of concept models
saveDbIndexes() - Method in interface com.marklogic.hub.EntityManager
Updates the indexes for the entity on the filesystem
saveDbIndexes() - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
saveDraftModel(JsonNode) - Method in interface com.marklogic.hub.dataservices.ModelsService
Save a draft model, where the input is a JSON model
saveEntity(HubEntity, Boolean) - Method in interface com.marklogic.hub.EntityManager
Deprecated.
saveEntity(HubEntity, Boolean) - Method in class com.marklogic.hub.impl.EntityManagerImpl
Deprecated.
saveFlow(Flow) - Method in interface com.marklogic.hub.FlowManager
Saves a flow to project structure and MarkLogic instance
saveFlow(Flow) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
saveGranularPrivileges(ManageClient, Map<String, Privilege>) - Method in class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
Save each of the given privileges.
saveJob(Job) - Method in class com.marklogic.hub.legacy.job.impl.LegacyJobManagerImpl
 
saveJob(Job, Transaction) - Method in class com.marklogic.hub.legacy.job.impl.LegacyJobManagerImpl
 
saveJob(Job) - Method in interface com.marklogic.hub.legacy.job.LegacyJobManager
Saves the job to the database
saveJob(Job, Transaction) - Method in interface com.marklogic.hub.legacy.job.LegacyJobManager
Saves the job to the database
saveLocalFlow(Flow) - Method in interface com.marklogic.hub.FlowManager
Saves a flow to project structure
saveLocalFlow(Flow) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
saveLocalStep(ObjectNode) - Method in class com.marklogic.hub.impl.StepManager
 
saveMapping(Mapping) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
saveMapping(Mapping, boolean) - Method in class com.marklogic.hub.impl.MappingManagerImpl
 
saveMapping(Mapping) - Method in interface com.marklogic.hub.MappingManager
Saves a map to disk
saveMapping(Mapping, boolean) - Method in interface com.marklogic.hub.MappingManager
Saves a map to disk, incrementing its version by 1
saveModels(JsonNode) - Method in interface com.marklogic.hub.dataservices.ModelsService
Save an array of entity models to only the database associated with the app server that receives this request
savePii() - Method in interface com.marklogic.hub.EntityManager
Scans the entities in the project for pii properties, and saves the required ELS configurations to support those properties.
savePii() - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
saveQueryOptions() - Method in interface com.marklogic.hub.EntityManager
Updates the query options to the file system
saveQueryOptions() - Method in class com.marklogic.hub.impl.EntityManagerImpl
 
saveResource(ResourceManager, CommandContext, String) - Method in class com.marklogic.hub.deploy.commands.DeployHubQueryRolesetsCommand
 
saveSavedQuery(JsonNode) - Method in interface com.marklogic.hub.dataservices.EntitySearchService
Invokes the saveSavedQuery operation on the database server
saveStep(String, JsonNode, Boolean, Boolean) - Method in interface com.marklogic.hub.dataservices.StepService
Invokes the saveStep operation on the database server
saveStepDefinition(StepDefinition) - Method in class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
saveStepDefinition(StepDefinition, boolean) - Method in class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
saveStepDefinition(StepDefinition) - Method in interface com.marklogic.hub.StepDefinitionManager
Saves a Step Definition to disk
saveStepDefinition(StepDefinition, boolean) - Method in interface com.marklogic.hub.StepDefinitionManager
Saves a Step Definition to disk
Scaffolding - Interface in com.marklogic.hub.impl
Interface that handles the management of DHF projects on disk Includes creating entities, flows, rest extensions, and transforms for an already initialized project
ScaffoldingImpl - Class in com.marklogic.hub.impl
 
ScaffoldingImpl() - Constructor for class com.marklogic.hub.impl.ScaffoldingImpl
 
ScaffoldingImpl(HubConfig) - Constructor for class com.marklogic.hub.impl.ScaffoldingImpl
 
ScaffoldingImpl.ContentPlugin - Class in com.marklogic.hub.impl
 
searchNodes(JsonNode, String, String) - Method in interface com.marklogic.hub.dataservices.GraphService
 
SearchOptionsFinder - Class in com.marklogic.client.ext.modulesloader.impl
 
SearchOptionsFinder() - Constructor for class com.marklogic.client.ext.modulesloader.impl.SearchOptionsFinder
 
SecurityService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
separator - Variable in class com.marklogic.hub.step.impl.WriteStepRunner
 
serialize() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
serialize() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Serializes the flow into an xml string
serialize() - Method in interface com.marklogic.hub.mapping.Mapping
Serializes the mapping as a json string
serialize() - Method in class com.marklogic.hub.mapping.MappingImpl
 
ServerValidationException - Exception in com.marklogic.hub.error
 
ServerValidationException(String) - Constructor for exception com.marklogic.hub.error.ServerValidationException
 
setAdminConfig(AdminConfig) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setAdminManager(AdminManager) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setAppConfig(AppConfig) - Method in interface com.marklogic.hub.HubConfig
Sets the AppConfig for the current HubConfig
setAppConfig(AppConfig, boolean) - Method in interface com.marklogic.hub.HubConfig
Sets the AppConfig for the current HubConfig, with skipUpdate option
setAppConfig(AppConfig) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setAppConfig(AppConfig, boolean) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setAppServerExistent(DatabaseKind, boolean) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
setAppServerExistent(DatabaseKind, boolean) - Method in interface com.marklogic.hub.InstallInfo
Sets the boolean property if the app server exists for the databasekind
setArtifact(String, String, JsonNode, String) - Method in interface com.marklogic.hub.dataservices.ArtifactService
Invokes the setArtifact operation on the database server
setAuthMethod(DatabaseKind, String) - Method in interface com.marklogic.hub.HubConfig
Sets the SSL Auth Method for the DatabaseKind in the config
setAuthMethod(DatabaseKind, String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setBaseUri(String) - Method in class com.marklogic.hub.entity.InfoType
Sets the value of the baseUri property.
setBatchSize(int) - Method in interface com.marklogic.hub.flow.Flow
Set flow batch size
setBatchSize(int) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setBatchSize(Integer) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setBatchSize(Integer) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setBatchSize(Integer) - Method in class com.marklogic.hub.step.impl.Step
 
setBatchSize(Integer) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the batch size for running this step
setBatchSize(int) - Method in class com.marklogic.hub.util.CreatedByStepFixer
 
setCatchExceptionsForUserModules(boolean) - Method in class com.marklogic.hub.deploy.commands.GenerateFunctionMetadataCommand
 
setCertFile(DatabaseKind, String) - Method in interface com.marklogic.hub.HubConfig
Sets the SSL Certfile to use for the DatabaseKind in the config
setCertFile(DatabaseKind, String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setCertPass(DatabaseKind, String) - Method in interface com.marklogic.hub.HubConfig
Sets the SSL Cert password for the DatabaseKind in the config
setCertPass(DatabaseKind, String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setClient(DatabaseClient) - Method in class com.marklogic.hub.legacy.collector.impl.LegacyCollectorImpl
 
setClient(DatabaseClient) - Method in interface com.marklogic.hub.legacy.collector.LegacyCollector
Sets the client to be used to communicate with the database
setCodeFormat(CodeFormat) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
setCodeFormat(CodeFormat) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Sets the CodeFormat enum of the flow
setCodeFormat(CodeFormat) - Method in class com.marklogic.hub.legacy.impl.MainPluginImpl
 
setCollation(String) - Method in class com.marklogic.hub.entity.ItemType
 
setCollation(String) - Method in class com.marklogic.hub.entity.PropertyType
 
setCollectionLexiconOn(DatabaseKind, boolean) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
setCollectionLexiconOn(DatabaseKind, boolean) - Method in interface com.marklogic.hub.InstallInfo
Sets if the collection lexicon is on or not
setCollector(LegacyCollector) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
setCollector(LegacyCollector) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Sets the legacyCollector to be used for the flow
setCounts(long, long, long, long) - Method in class com.marklogic.hub.legacy.job.Job
 
setCounts(long, long, long, long, long) - Method in class com.marklogic.hub.step.RunStepResponse
 
setCustomForestPath(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setCustomHook(JsonNode) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setCustomHook(JsonNode) - Method in class com.marklogic.hub.step.impl.Step
 
setCustomHook(JsonNode) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the customHook
setDataFormat(DataFormat) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
setDataFormat(DataFormat) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Sets the DataFormat for the flow
setDatatype(String) - Method in class com.marklogic.hub.entity.ItemType
 
setDatatype(String) - Method in class com.marklogic.hub.entity.PropertyType
 
setDbExistent(DatabaseKind, boolean) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
setDbExistent(DatabaseKind, boolean) - Method in interface com.marklogic.hub.InstallInfo
Sets the boolean property if the database exists for the databasekind
setDbName(DatabaseKind, String) - Method in interface com.marklogic.hub.HubConfig
Sets the database name for the databaseKind on the hubconfig
setDbName(DatabaseKind, String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setDefinitions(DefinitionsType) - Method in class com.marklogic.hub.entity.HubEntity
 
setDescription(String) - Method in class com.marklogic.hub.entity.DefinitionType
 
setDescription(String) - Method in class com.marklogic.hub.entity.InfoType
Sets the value of the description property.
setDescription(String) - Method in class com.marklogic.hub.entity.PropertyType
 
setDescription(String) - Method in interface com.marklogic.hub.flow.Flow
Sets flow description
setDescription(String) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setDescription(String) - Method in interface com.marklogic.hub.mapping.Mapping
Set the description for the mapping
setDescription(String) - Method in class com.marklogic.hub.mapping.MappingImpl
 
setDescription(String) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setDescription(String) - Method in class com.marklogic.hub.step.impl.Step
 
setDescription(String) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the description for the step
setElementRangeIndex(List<String>) - Method in class com.marklogic.hub.entity.DefinitionType
 
setEndTime(String) - Method in class com.marklogic.hub.flow.RunFlowResponse
 
setEntityModelPermissions(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setEntityName(String) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
setEntityName(String) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Sets the entity name for the flow
setEntityNames(String) - Method in class com.marklogic.hub.deploy.commands.GenerateHubTDETemplateCommand
 
setExternalName(DatabaseKind, String) - Method in interface com.marklogic.hub.HubConfig
Sets the external hostname for the DatabaseKind in the config
setExternalName(DatabaseKind, String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setFailHard(Boolean) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setFileLocations(JsonNode) - Method in class com.marklogic.hub.step.impl.IngestionStepDefinitionImpl
 
setFileLocations(JsonNode) - Method in class com.marklogic.hub.step.impl.Step
 
setFilename(String) - Method in class com.marklogic.hub.entity.HubEntity
 
setFlowDeveloperRoleName(String) - Method in interface com.marklogic.hub.HubConfig
Set the role name that the hub uses for developing flows
setFlowDeveloperRoleName(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setFlowName(String) - Method in class com.marklogic.hub.flow.FlowInputs
 
setFlowName(String) - Method in class com.marklogic.hub.flow.RunFlowResponse
 
setFlowName(String) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setFlowOperatorRoleName(String) - Method in interface com.marklogic.hub.HubConfig
Set the role name that the hub uses
setFlowOperatorRoleName(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setFlowPermissions(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setForceLoad(boolean) - Method in class com.marklogic.hub.deploy.commands.LoadUserModulesCommand
 
setForestsExistent(DatabaseKind, boolean) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
setForestsExistent(DatabaseKind, boolean) - Method in interface com.marklogic.hub.InstallInfo
Sets the boolean property if the forests exist for the databasekind
setForestsPerHost(DatabaseKind, Integer) - Method in interface com.marklogic.hub.HubConfig
Sets the number of forests per host for the databaseKind on the hubconfig
setForestsPerHost(DatabaseKind, Integer) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setHost(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setHttpName(DatabaseKind, String) - Method in interface com.marklogic.hub.HubConfig
Sets the appserver name for the databaseKind on the hubconfig
setHttpName(DatabaseKind, String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setHubConfig(HubConfig) - Method in class com.marklogic.hub.deploy.commands.GenerateFunctionMetadataCommand
 
setHubConfig(HubConfig) - Method in class com.marklogic.hub.deploy.commands.LoadHubArtifactsCommand
 
setHubConfig(HubConfig) - Method in class com.marklogic.hub.deploy.commands.LoadHubModulesCommand
 
setHubConfig(HubConfig) - Method in class com.marklogic.hub.deploy.commands.LoadUserArtifactsCommand
 
setHubConfig(HubConfig) - Method in class com.marklogic.hub.deploy.commands.LoadUserModulesCommand
 
setHubConfig(HubConfig) - Method in interface com.marklogic.hub.FlowManager
Set the HubConfig
setHubConfig(HubConfigImpl) - Method in class com.marklogic.hub.impl.DataHubImpl
 
setHubConfig(HubConfig) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
setHubConfig(HubConfig) - Method in class com.marklogic.hub.legacy.collector.impl.LegacyCollectorImpl
 
setHubConfig(HubConfig) - Method in interface com.marklogic.hub.legacy.collector.LegacyCollector
Set's the hub config for the collector
setHubConfig(HubConfig) - Method in class com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl
 
setHubConfig(HubConfig) - Method in interface com.marklogic.hub.legacy.LegacyFlowManager
Set HubConfig
setHubProject(HubProject) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setInfo(InfoType) - Method in class com.marklogic.hub.entity.HubEntity
 
setInputFilePath(String) - Method in class com.marklogic.hub.flow.FlowInputs
A common step configuration to override at runtime is the inputFilePath for an ingestion step.
setInputFilePath(String) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setInputFileType(String) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setIsProvisionedEnvironment(boolean) - Method in interface com.marklogic.hub.HubConfig
 
setIsProvisionedEnvironment(boolean) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setItems(ItemType) - Method in class com.marklogic.hub.entity.PropertyType
 
setJobId(String) - Method in class com.marklogic.hub.flow.FlowInputs
 
setJobId(String) - Method in class com.marklogic.hub.flow.RunFlowResponse
 
setJobId(String) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setJobPermissions(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setJobStatus(String) - Method in class com.marklogic.hub.flow.RunFlowResponse
 
setKnownValuesForDhsDeployment(HubConfig) - Method in class com.marklogic.hub.deploy.HubDeployer
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.
setLang(String) - Method in interface com.marklogic.hub.mapping.Mapping
*CAREFUL - DO NOT TOUCH IF YOU DON'T EXPLICITLY KNOW WHAT THIS VALUE REPRESENTS* Sets the language for the mapping to use for MarkLogic server
setLang(String) - Method in class com.marklogic.hub.mapping.MappingImpl
 
setLanguage(String) - Method in interface com.marklogic.hub.mapping.Mapping
Deprecated.
setLanguage(String) - Method in class com.marklogic.hub.mapping.MappingImpl
Deprecated.
setLastAttemptedStep(String) - Method in class com.marklogic.hub.flow.RunFlowResponse
 
setLastCompletedStep(String) - Method in class com.marklogic.hub.flow.RunFlowResponse
 
setLoadAllModules(boolean) - Method in class com.marklogic.hub.deploy.commands.LoadUserModulesCommand
 
setLoadQueryOptions(boolean) - Method in class com.marklogic.hub.deploy.commands.LoadUserModulesCommand
 
setMain(MainPlugin) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
setMain(MainPlugin) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Sets the main plugin module for the flow
setManageClient(ManageClient) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setMappingName(String) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
setMappingName(String) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Sets the mapping name used to generate the flow
setMappingPermissions(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setMergeEntityConfigFiles(boolean) - Method in class com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand
 
setMergeEntityConfigFiles(boolean) - Method in class com.marklogic.hub.deploy.commands.HubDeployDatabaseCommandFactory
 
setMergeExistingArrayProperties(boolean) - Method in class com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand
 
setMergeExistingArrayProperties(boolean) - Method in class com.marklogic.hub.deploy.commands.HubDeployDatabaseCommandFactory
 
setMlPassword(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setMlUsername(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setModule(String) - Method in class com.marklogic.hub.legacy.impl.MainPluginImpl
 
setModulePath(String) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setModulePath(String) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the module path
setName(String) - Method in class com.marklogic.hub.entity.DefinitionType
 
setName(String) - Method in class com.marklogic.hub.entity.PropertyType
 
setName(String) - Method in interface com.marklogic.hub.flow.Flow
Sets the name of the flow
setName(String) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setName(String) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
setName(String) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Sets the name of the flow
setName(String) - Method in interface com.marklogic.hub.mapping.Mapping
Sets the name of the mapping as a string
setName(String) - Method in class com.marklogic.hub.mapping.MappingImpl
 
setName(String) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setName(String) - Method in class com.marklogic.hub.step.impl.Step
 
setName(String) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the name of the step
setNamespace(String) - Method in class com.marklogic.hub.entity.DefinitionType
 
setNamespacePrefix(String) - Method in class com.marklogic.hub.entity.DefinitionType
 
setNamespaces(Map<String, String>) - Method in interface com.marklogic.hub.mapping.Mapping
Sets the namespaces map for the mapping
setNamespaces(Map<String, String>) - Method in class com.marklogic.hub.mapping.MappingImpl
 
setObjectMapper(ObjectMapper) - Method in class com.marklogic.hub.deploy.commands.LoadUserArtifactsCommand
 
setOptions(JsonNode) - Method in interface com.marklogic.hub.flow.Flow
Sets flow options
setOptions(Map<String, Object>) - Method in class com.marklogic.hub.flow.FlowInputs
 
setOptions(JsonNode) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setOptions(Map<String, Object>) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setOptions(Map<String, Object>) - Method in class com.marklogic.hub.step.impl.Step
 
setOptions(Map<String, Object>) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the step options
setOptionsFile(String) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setOptionsJSON(String) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setOutputURIPrefix(String) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setOutputURIReplacement(String) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setOverrideStepConfig(Map<String, Object>) - Method in interface com.marklogic.hub.flow.Flow
Sets the overridden step configs to use at java runtime
setOverrideStepConfig(Map<String, Object>) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setPii(List<String>) - Method in class com.marklogic.hub.entity.DefinitionType
 
setPort(DatabaseKind, Integer) - Method in interface com.marklogic.hub.HubConfig
Sets the port number for the databaseKind on the hubconfig
setPort(DatabaseKind, Integer) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setPrimaryKey(String) - Method in class com.marklogic.hub.entity.DefinitionType
 
setProjectDir(String) - Method in interface com.marklogic.hub.HubConfig
Sets the directory for the current project
setProjectDir(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
Deprecated.
setProperties(List<PropertyType>) - Method in class com.marklogic.hub.entity.DefinitionType
 
setProperties(HashMap<String, ObjectNode>) - Method in interface com.marklogic.hub.mapping.Mapping
Sets the properties hashmap for the mapping
setProperties(HashMap<String, ObjectNode>) - Method in class com.marklogic.hub.mapping.MappingImpl
 
setRangeIndex(List<String>) - Method in class com.marklogic.hub.entity.DefinitionType
 
setRef(String) - Method in class com.marklogic.hub.entity.ItemType
 
setRef(String) - Method in class com.marklogic.hub.entity.PropertyType
 
setRemoveSchemaAndTriggersDatabaseSettings(boolean) - Method in class com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand
 
setRemoveSchemaAndTriggersDatabaseSettings(boolean) - Method in class com.marklogic.hub.deploy.commands.HubDeployDatabaseCommandFactory
 
setRequired(List<String>) - Method in class com.marklogic.hub.entity.DefinitionType
 
setRetryLimit(int) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setRetryLimit(Integer) - Method in class com.marklogic.hub.step.impl.Step
 
setRetryLimit(int) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the retry limit for the step
setRuntimeOptions(Map<String, Object>) - Method in interface com.marklogic.hub.flow.Flow
Sets the overridden options for the flow to use at java runtime
setRuntimeOptions(Map<String, Object>) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setScheme(DatabaseKind, String) - Method in interface com.marklogic.hub.HubConfig
Deprecated.
setScheme(DatabaseKind, String) - Method in class com.marklogic.hub.impl.HubConfigImpl
Deprecated.
setSeparator(String) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setShowOptions(Boolean) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setSimpleSsl(DatabaseKind, Boolean) - Method in interface com.marklogic.hub.HubConfig
Sets if Simple SSL is to be used for the DatabaseKind in the config
setSimpleSsl(DatabaseKind, Boolean) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setSourceContext(String) - Method in interface com.marklogic.hub.mapping.Mapping
Sets the source context for the mapping
setSourceContext(String) - Method in class com.marklogic.hub.mapping.MappingImpl
 
setSourceQuery(String) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setSourceQuery(String) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the sourceQuery for the step
setSourceURI(String) - Method in interface com.marklogic.hub.mapping.Mapping
Set the URI for the mapping source document
setSourceURI(String) - Method in class com.marklogic.hub.mapping.MappingImpl
 
setSslContext(DatabaseKind, SSLContext) - Method in interface com.marklogic.hub.HubConfig
Sets the SSL Context for the DatabaseKind in the config
setSslContext(DatabaseKind, SSLContext) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setSslHostnameVerifier(DatabaseKind, DatabaseClientFactory.SSLHostnameVerifier) - Method in interface com.marklogic.hub.HubConfig
Sets the SSL Hostname Verifier object for the DatabaseKind in the config
setSslHostnameVerifier(DatabaseKind, DatabaseClientFactory.SSLHostnameVerifier) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setStartTime(String) - Method in class com.marklogic.hub.flow.RunFlowResponse
 
setStepConfig(Map<String, Object>) - Method in class com.marklogic.hub.flow.FlowInputs
 
setStepDefinitionName(String) - Method in class com.marklogic.hub.step.impl.Step
 
setStepDefinitionPermissions(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setStepDefinitionType(StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.step.impl.Step
 
setStepEndTime(String) - Method in class com.marklogic.hub.step.RunStepResponse
 
setStepId(String) - Method in class com.marklogic.hub.step.impl.Step
 
setStepResponses(Map<String, RunStepResponse>) - Method in class com.marklogic.hub.flow.RunFlowResponse
 
setSteps(Map<String, Step>) - Method in interface com.marklogic.hub.flow.Flow
Sets the steps to the flow model
setSteps(List<String>) - Method in class com.marklogic.hub.flow.FlowInputs
 
setSteps(Map<String, Step>) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setSteps(Flow, Map<String, Step>) - Method in interface com.marklogic.hub.FlowManager
Deprecated.
setSteps(List<String>) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setSteps(Flow, Map<String, Step>) - Method in class com.marklogic.hub.impl.FlowManagerImpl
Deprecated.
setStepStartTime(String) - Method in class com.marklogic.hub.step.RunStepResponse
 
setStopOnError(boolean) - Method in interface com.marklogic.hub.flow.Flow
If set stops the flow on error
setStopOnError(boolean) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setSubProperties(List<PropertyType>) - Method in class com.marklogic.hub.entity.PropertyType
 
setTargetDatabase(String) - Method in class com.marklogic.hub.step.RunStepResponse
 
setTargetEntityType(String) - Method in interface com.marklogic.hub.mapping.Mapping
Setting the IRI for the target entity type
setTargetEntityType(String) - Method in class com.marklogic.hub.mapping.MappingImpl
 
setThreadCount(int) - Method in interface com.marklogic.hub.flow.Flow
Sets flow thread count
setThreadCount(int) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setThreadCount(Integer) - Method in class com.marklogic.hub.impl.CommandLineFlowInputs
 
setThreadCount(Integer) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setThreadCount(Integer) - Method in class com.marklogic.hub.step.impl.Step
 
setThreadCount(Integer) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the thread count for running this step
setThreadCount(int) - Method in class com.marklogic.hub.util.CreatedByStepFixer
 
setTitle(String) - Method in class com.marklogic.hub.entity.InfoType
Sets the value of the title property.
setTripleIndexOn(DatabaseKind, boolean) - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
setTripleIndexOn(DatabaseKind, boolean) - Method in interface com.marklogic.hub.InstallInfo
Sets if the triple index is on or off by boolean
setTrustManager(DatabaseKind, X509TrustManager) - Method in interface com.marklogic.hub.HubConfig
Sets the Trust Manager for the DatabaseKind in the config
setTrustManager(DatabaseKind, X509TrustManager) - Method in class com.marklogic.hub.impl.HubConfigImpl
 
setType(FlowType) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
setType(FlowType) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Sets the type of the flow
setType(StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setType(StepDefinition.StepDefinitionType) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the type of the step
setUser(String) - Method in class com.marklogic.hub.flow.RunFlowResponse
 
setUserModulesDeployTimestampFile(String) - Method in interface com.marklogic.hub.HubProject
 
setUserModulesDeployTimestampFile(String) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
setVersion(String) - Method in class com.marklogic.hub.entity.InfoType
Sets the value of the version property.
setVersion(int) - Method in interface com.marklogic.hub.flow.Flow
Sets version
setVersion(int) - Method in class com.marklogic.hub.flow.impl.FlowImpl
 
setVersion(int) - Method in interface com.marklogic.hub.mapping.Mapping
Sets the version for the mapping
setVersion(int) - Method in class com.marklogic.hub.mapping.MappingImpl
 
setVersion(Integer) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
setVersion(Integer) - Method in interface com.marklogic.hub.step.StepDefinition
Sets the step version number
setVersions(Versions) - Method in class com.marklogic.hub.impl.DataHubImpl
 
setWordLexicon(List<String>) - Method in class com.marklogic.hub.entity.DefinitionType
 
shouldFunctionMetadataBeGenerated(Set<Resource>) - Method in class com.marklogic.hub.deploy.util.ModuleWatchingConsumer
 
size() - Method in class com.marklogic.hub.legacy.collector.DiskQueue
 
size() - Method in class com.marklogic.hub.util.DiskQueue
 
SORT_ORDER - Static variable in class com.marklogic.hub.deploy.commands.LoadHubArtifactsCommand
Hub artifacts are deployed after triggers for no particular reason yet other than that user artifacts must be deployed after both triggers (because of entity models) and after hub artifacts.
SourceQueryCollector - Class in com.marklogic.hub.step.impl
 
SourceQueryCollector(HubClient, String) - Constructor for class com.marklogic.hub.step.impl.SourceQueryCollector
 
STAGING_ENTITY_DATABASE_FILE - Static variable in interface com.marklogic.hub.HubConfig
 
STAGING_ENTITY_QUERY_OPTIONS_FILE - Static variable in interface com.marklogic.hub.HubConfig
 
stagingAppServerExists - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
stagingCollectionLexiconOn - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
stagingDbExists - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
stagingForestsExist - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
stagingForestsPerHost - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
stagingHttpName - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
stagingSchemasDbExists - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
stagingSchemasForestsPerHost - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
stagingTriggersDbExists - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
stagingTriggersForestsPerHost - Variable in class com.marklogic.hub.impl.HubConfigImpl
 
stagingTripleIndexOn - Variable in class com.marklogic.hub.impl.InstallInfoImpl
 
startJob(String, String) - Method in interface com.marklogic.hub.dataservices.JobService
Start a new job for the given flowName by creating a new Job document
startStep(String, String, String, JsonNode) - Method in interface com.marklogic.hub.dataservices.JobService
Updates the Job document associated with the given jobId to note that the step has been started
Step - Class in com.marklogic.hub.step.impl
 
Step() - Constructor for class com.marklogic.hub.step.impl.Step
 
STEP_DEFINITION_FILE_EXTENSION - Static variable in interface com.marklogic.hub.StepDefinitionManager
String value for the mapping file extension
StepDefinition - Interface in com.marklogic.hub.step
 
StepDefinition.StepDefinitionType - Enum in com.marklogic.hub.step
 
StepDefinitionManager - Interface in com.marklogic.hub
 
StepDefinitionManagerImpl - Class in com.marklogic.hub.impl
 
StepDefinitionManagerImpl() - Constructor for class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
StepDefinitionManagerImpl(HubConfig) - Constructor for class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
StepDefinitionManagerImpl(HubClient, HubProject) - Constructor for class com.marklogic.hub.impl.StepDefinitionManagerImpl
 
StepDefinitionProvider - Interface in com.marklogic.hub.step
Abstracts how a StepDefinition is provided to a client so that it can come from MarkLogic, from a filesystem, or from other location.
StepDefinitionService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
StepDefModulesFinder - Class in com.marklogic.client.ext.modulesloader.impl
 
StepDefModulesFinder() - Constructor for class com.marklogic.client.ext.modulesloader.impl.StepDefModulesFinder
 
stepIsReferencedByAFlow(String, StepDefinition.StepDefinitionType) - Method in class com.marklogic.hub.impl.FlowManagerImpl
 
StepItemCompleteListener - Interface in com.marklogic.hub.step
 
StepItemFailureListener - Interface in com.marklogic.hub.step
 
StepManager - Class in com.marklogic.hub.impl
 
StepManager(HubConfig) - Constructor for class com.marklogic.hub.impl.StepManager
 
StepMetrics - Class in com.marklogic.hub.step.impl
 
StepMetrics() - Constructor for class com.marklogic.hub.step.impl.StepMetrics
 
stepOutput - Variable in class com.marklogic.hub.step.RunStepResponse
 
StepRunner - Interface in com.marklogic.hub.step
Executes a step with options
StepRunnerFactory - Class in com.marklogic.hub.step
 
StepRunnerFactory(HubConfig) - Constructor for class com.marklogic.hub.step.StepRunnerFactory
The one difference between this and the HubClient-based constructor is that by having access to a HubProject via HubConfig, the WriteStepRunner instances created by this class will be able to resolve relative file input paths based on the project directory.
StepRunnerFactory(HubClient) - Constructor for class com.marklogic.hub.step.StepRunnerFactory
 
StepRunnerService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
StepRunnerUtil - Class in com.marklogic.hub.step.impl
 
StepRunnerUtil() - Constructor for class com.marklogic.hub.step.impl.StepRunnerUtil
 
StepService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server
StepStatusListener - Interface in com.marklogic.hub.step
 
stop() - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
stop() - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
stop() - Method in interface com.marklogic.hub.step.StepRunner
Stops the step run
STOP_ON_ERROR_PREFIX - Static variable in enum com.marklogic.hub.flow.impl.JobStatus
 
stopJob(String) - Method in interface com.marklogic.hub.flow.FlowRunner
Runs the flow.
stopJob(String) - Method in class com.marklogic.hub.flow.impl.FlowRunnerImpl
 
subProperties - Variable in class com.marklogic.hub.entity.PropertyType
 
SystemService - Interface in com.marklogic.hub.dataservices
Provides a set of operations on the database server

T

testMapping(String, String, JsonNode) - Method in interface com.marklogic.hub.dataservices.MappingService
Invokes the testMapping operation on the database server
TestSuiteGenerator - Class in com.marklogic.hub.ext.mlunittest
Generates marklogic-unit-test test suites.
TestSuiteGenerator() - Constructor for class com.marklogic.hub.ext.mlunittest.TestSuiteGenerator
 
throwExceptionIfMarkLogicVersionIsInvalid(HubConfig) - Method in class com.marklogic.hub.deploy.HubDeployer
 
title - Variable in class com.marklogic.hub.entity.InfoType
 
toJson() - Method in class com.marklogic.hub.entity.DefinitionsType
 
toJson() - Method in class com.marklogic.hub.entity.DefinitionType
 
toJson() - Method in class com.marklogic.hub.entity.HubEntity
 
toJson() - Method in class com.marklogic.hub.entity.InfoType
 
toJson() - Method in class com.marklogic.hub.entity.ItemType
 
toJson() - Method in class com.marklogic.hub.entity.JsonPojo
 
toJson() - Method in class com.marklogic.hub.entity.PropertyType
 
toJson() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
toObjectNode() - Method in class com.marklogic.hub.step.RunStepResponse
 
toProperties() - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowImpl
 
toProperties() - Method in interface com.marklogic.hub.legacy.flow.LegacyFlow
Creates a properties object representing the flow
toString() - Method in enum com.marklogic.hub.flow.impl.JobStatus
 
toString() - Method in class com.marklogic.hub.flow.RunFlowResponse
 
toString() - Method in class com.marklogic.hub.impl.HubConfigImpl
 
toString() - Method in class com.marklogic.hub.impl.InstallInfoImpl
 
toString() - Method in interface com.marklogic.hub.InstallInfo
Returns the entire object as a string
toString() - Method in enum com.marklogic.hub.legacy.flow.CodeFormat
 
toString() - Method in enum com.marklogic.hub.legacy.flow.DataFormat
 
toString() - Method in enum com.marklogic.hub.legacy.flow.FlowType
 
toString() - Method in class com.marklogic.hub.legacy.flow.RunFlowResponse
 
toString() - Method in class com.marklogic.hub.legacy.job.JobDeleteResponse
 
toString() - Method in enum com.marklogic.hub.legacy.job.JobStatus
 
toString() - Method in class com.marklogic.hub.step.ResponseHolder
 
toString() - Method in class com.marklogic.hub.step.RunStepResponse
 
toString() - Method in enum com.marklogic.hub.step.StepDefinition.StepDefinitionType
 
toString() - Method in class com.marklogic.hub.util.json.JSONObject
 
totalCount - Variable in class com.marklogic.hub.legacy.flow.RunFlowResponse
 
totalCount - Variable in class com.marklogic.hub.legacy.job.JobDeleteResponse
 
totalCount - Variable in class com.marklogic.hub.step.ResponseHolder
 
totalJobs - Variable in class com.marklogic.hub.legacy.job.JobExportResponse
 
totalTraces - Variable in class com.marklogic.hub.legacy.job.JobExportResponse
 
transformFromStep(StepDefinition, Step) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
transformFromStep(StepDefinition, Step) - Method in class com.marklogic.hub.step.impl.IngestionStepDefinitionImpl
 
transformFromStep(StepDefinition, Step) - Method in interface com.marklogic.hub.step.StepDefinition
 
transformMatchingOptions(ObjectNode) - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
 
transformMergingOptions(ObjectNode) - Method in class com.marklogic.hub.hubcentral.conversion.FlowConverter
 
transformToStep(String, StepDefinition, Step) - Method in class com.marklogic.hub.step.AbstractStepDefinition
 
transformToStep(String, StepDefinition, Step) - Method in class com.marklogic.hub.step.impl.IngestionStepDefinitionImpl
 
transformToStep(String, StepDefinition, Step) - Method in interface com.marklogic.hub.step.StepDefinition
 
trimText(JSONObject, String...) - Static method in class com.marklogic.hub.util.json.JSONUtils
A utility method to trim all text values in a json object
trimText(JsonNode, String...) - Static method in class com.marklogic.hub.util.json.JSONUtils
A utility method to trim all text values in a json node

U

undo(CommandContext) - Method in class com.marklogic.hub.deploy.commands.CreateGranularPrivilegesCommand
Delete every granular privilege.
undo(CommandContext) - Method in class com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand
 
unmerge(String, Boolean, Boolean) - Method in class com.marklogic.hub.impl.MasteringManagerImpl
 
unmerge(String, Boolean, Boolean) - Method in interface com.marklogic.hub.MasteringManager
Reverses the last set of merges made into the given merge UR
unmergeRecord(String, Boolean, Boolean, List<String>) - Method in class com.marklogic.hub.impl.MasteringManagerImpl
 
unmergeRecord(String, Boolean, Boolean, List<String>) - Method in interface com.marklogic.hub.MasteringManager
Unmerges the set of uris from a merged document
updateCustomStep(JsonNode) - Method in interface com.marklogic.hub.dataservices.CustomStepService
Updates the custom step and returns the updated step
updateDraftModelEntityTypes(JsonNode) - Method in interface com.marklogic.hub.dataservices.ModelsService
Update entity model types in the entity models draft collection.
updateDraftModelInfo(String, JsonNode) - Method in interface com.marklogic.hub.dataservices.ConceptService
Update the description of an existing concept class.
updateDraftModelInfo(String, JsonNode) - Method in interface com.marklogic.hub.dataservices.ModelsService
Update the description and optionally the namespace and namespace prefix of an existing model.
updateFlow(String, String, ArrayNode) - Method in interface com.marklogic.hub.dataservices.FlowService
Invokes the updateFlow operation on the database server
updateIndexes() - Method in interface com.marklogic.hub.DataHub
Updates the indexes in the database based on the project Must be run as a user with flow-developer-role or equivalent
updateIndexes() - Method in class com.marklogic.hub.impl.DataHubImpl
Note that this differs from how "mlUpdateIndexes" works in ml-gradle.
updateLegacyEntity(String) - Method in interface com.marklogic.hub.impl.Scaffolding
Update a specific entity that's legacy
updateLegacyEntity(String) - Method in class com.marklogic.hub.impl.ScaffoldingImpl
 
updateMatchOptions(JsonNode) - Method in interface com.marklogic.hub.dataservices.MasteringService
Invokes the updateMatchOptions operation on the database server
updateMergeOptions(JsonNode) - Method in interface com.marklogic.hub.dataservices.MasteringService
Invokes the updateMergeOptions operation on the database server
updateStepDefinitionTypeForInlineMappingSteps(FlowManager) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
upgradeFinalDatabaseXmlFile() - Method in class com.marklogic.hub.impl.HubProjectImpl
Because this file is under src/main/ml-config, we cannot overwrite it, as a user may have modifications to it, and we don't want to lose those (while we could copy the existing file to a separate directory, forcing the user to then have to restore all their additions is a lousy user experience).
upgradeHub() - Method in interface com.marklogic.hub.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.
upgradeHub() - Method in class com.marklogic.hub.impl.DataHubImpl
 
upgradeProject(FlowManager) - Method in interface com.marklogic.hub.HubProject
Performs an upgrade to a pre-4.0 project by copying folders to their new positions as defined in hubproject.
upgradeProject(FlowManager) - Method in class com.marklogic.hub.impl.HubProjectImpl
 
USER_CONFIG_DIR - Static variable in interface com.marklogic.hub.HubConfig
 
USER_CONFIG_DIR - Static variable in interface com.marklogic.hub.HubProject
 
USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES - Static variable in interface com.marklogic.hub.HubConfig
 
USER_SCHEMAS_DIR - Static variable in class com.marklogic.hub.impl.HubProjectImpl
 
UserModulesFinder - Class in com.marklogic.client.ext.modulesloader.impl
 
UserModulesFinder() - Constructor for class com.marklogic.client.ext.modulesloader.impl.UserModulesFinder
 

V

validate(String, String, String, String, String) - Method in interface com.marklogic.hub.legacy.validate.EntitiesValidator
Creates and returns a an EntityValidator object
validate(String, String, String, String, String) - Method in class com.marklogic.hub.legacy.validate.impl.EntitiesValidatorImpl
 
validateAll() - Method in interface com.marklogic.hub.legacy.validate.EntitiesValidator
Validates all entities
validateAll() - Method in class com.marklogic.hub.legacy.validate.impl.EntitiesValidatorImpl
 
validateJsonMapping(String, String) - Method in class com.marklogic.hub.mapping.MappingValidator
 
validateMatchingStep(String) - Method in interface com.marklogic.hub.dataservices.MasteringService
Invokes the validateMatchingStep operation on the database server
validateMergingStep(String, String, String) - Method in interface com.marklogic.hub.dataservices.MasteringService
Provides feedback in the form of errors and warnings about a merge step.
valueOf(String) - Static method in enum com.marklogic.hub.flow.impl.JobStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.marklogic.hub.legacy.flow.CodeFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.marklogic.hub.legacy.flow.DataFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.marklogic.hub.legacy.flow.FlowType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.marklogic.hub.legacy.job.JobStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.marklogic.hub.step.StepDefinition.StepDefinitionType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.marklogic.hub.flow.impl.JobStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.marklogic.hub.legacy.flow.CodeFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.marklogic.hub.legacy.flow.DataFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.marklogic.hub.legacy.flow.FlowType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.marklogic.hub.legacy.job.JobStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.marklogic.hub.step.StepDefinition.StepDefinitionType
Returns an array containing the constants of this enum type, in the order they are declared.
verifyLocalProjectIs430OrGreater() - Method in class com.marklogic.hub.impl.DataHubImpl
Per DHFPROD-4912, instead of depending on mlDHFVersion, this logic takes advantage of the fact that the hub-internal-config triggers - including ml-dh-entity-create.json - had their permissions modified in the 4.3.0 release.
version - Variable in class com.marklogic.hub.entity.InfoType
 
VersionInfo - Class in com.marklogic.hub.impl
This is intended to replace some of the Versions class with a HubClient-friendly and non-Spring-dependent way of accessing version data.
VersionInfo(String, String, String, String, String, String) - Constructor for class com.marklogic.hub.impl.VersionInfo
 
Versions - Class in com.marklogic.hub.impl
 
Versions() - Constructor for class com.marklogic.hub.impl.Versions
 
Versions(HubClient) - Constructor for class com.marklogic.hub.impl.Versions
 
Versions(HubConfig) - Constructor for class com.marklogic.hub.impl.Versions
 

W

withBatchSize(int) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
withBatchSize(int) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets the batch size for the flow runner
withBatchSize(int) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
withBatchSize(int) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withBatchSize(int) - Method in interface com.marklogic.hub.step.StepRunner
Sets the batch size for the step runner
withCodeFormat(CodeFormat) - Method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
withCollector(LegacyCollector) - Method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
withDataFormat(DataFormat) - Method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
withDefaultProperties() - Static method in class com.marklogic.hub.impl.HubConfigImpl
Deprecated.
withDestinationDatabase(String) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
withDestinationDatabase(String) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets the database where flow output data will be presisted to
withDestinationDatabase(String) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withEndTime(Date) - Method in class com.marklogic.hub.legacy.job.Job
 
withEntityName(String) - Method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
withFlow(LegacyFlow) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
withFlow(LegacyFlow) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets the flow to be used with the flow runner
withFlow(LegacyFlow) - Static method in class com.marklogic.hub.legacy.job.Job
 
withFlow(Flow) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
withFlow(Flow) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withFlow(Flow) - Static method in class com.marklogic.hub.step.RunStepResponse
 
withFlow(Flow) - Method in interface com.marklogic.hub.step.StepRunner
Sets the flow to be used with the step runner
withFullOutput(Map<String, JsonNode>) - Method in class com.marklogic.hub.step.RunStepResponse
 
withJobId(String) - Method in class com.marklogic.hub.flow.FlowInputs
 
withJobId(String) - Method in class com.marklogic.hub.legacy.job.Job
 
withJobId(String) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
withJobId(String) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withJobId(String) - Method in class com.marklogic.hub.step.RunStepResponse
 
withJobId(String) - Method in interface com.marklogic.hub.step.StepRunner
Sets the batch size for the step runner
withJobName(String) - Method in class com.marklogic.hub.legacy.job.Job
 
withJobOutput(List<String>) - Method in class com.marklogic.hub.legacy.job.Job
 
withJobOutput(String) - Method in class com.marklogic.hub.legacy.job.Job
 
withMain(MainPlugin) - Method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
withMapping(String) - Method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
withName(String) - Method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
withOption(String, Object) - Method in class com.marklogic.hub.flow.FlowInputs
Convenience method for adding one option at a time.
withOptions(Map<String, Object>) - Method in class com.marklogic.hub.flow.FlowInputs
 
withOptions(Map<String, Object>) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
withOptions(Map<String, Object>) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets the options to be passed into the xqy or sjs flow in the $options or options variables of main.
withProperties(Properties) - Static method in class com.marklogic.hub.impl.HubConfigImpl
Convenience method for instantiating a HubConfigImpl with its default property values and then overlaying the values specified in the given Properties object.
withPropertiesFromEnvironment(String) - Method in interface com.marklogic.hub.HubConfig
In a non-Gradle environment, a client can use this to load properties from a "gradle-(environment).properties" file, similar to how the Gradle properties plugin would process such a file in a Gradle context.
withPropertiesFromEnvironment(String) - Method in class com.marklogic.hub.impl.HubConfigImpl
It is not expected that a client would use this, as it would be partially re-inventing what the Gradle properties plugin does.
withRuntimeOptions(Map<String, Object>) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
withRuntimeOptions(Map<String, Object>) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withRuntimeOptions(Map<String, Object>) - Method in interface com.marklogic.hub.step.StepRunner
Sets the options to be passed into the xqy or sjs flow in the $options or options variables of main.
withSourceClient(DatabaseClient) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
withSourceClient(DatabaseClient) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets the source client on the flow runner.
withStartTime(Date) - Method in class com.marklogic.hub.legacy.job.Job
 
withStatus(JobStatus) - Method in class com.marklogic.hub.legacy.job.Job
 
withStatus(String) - Method in class com.marklogic.hub.step.RunStepResponse
 
withStep(String) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
withStep(String) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withStep(String) - Method in class com.marklogic.hub.step.RunStepResponse
 
withStep(String) - Method in interface com.marklogic.hub.step.StepRunner
Sets the batch size for the step runner
withStepConfig(Map<String, Object>) - Method in class com.marklogic.hub.flow.FlowInputs
 
withStepConfig(Map<String, Object>) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
withStepConfig(Map<String, Object>) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withStepConfig(Map<String, Object>) - Method in interface com.marklogic.hub.step.StepRunner
Sets the config to be used in orchestrating the step.
withStepDefinition(StepDefinition) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
withStepDefinition(StepDefinition) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withStepOutput(List<String>) - Method in class com.marklogic.hub.step.RunStepResponse
 
withStepOutput(String) - Method in class com.marklogic.hub.step.RunStepResponse
 
withSteps(String...) - Method in class com.marklogic.hub.flow.FlowInputs
 
withStopOnFailure(boolean) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
withStopOnFailure(boolean) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets if this will stop the job on a failure, or if it will continue on
withStopOnFailure(boolean) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
withStopOnFailure(boolean) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withStopOnFailure(boolean) - Method in interface com.marklogic.hub.step.StepRunner
Sets if this will stop the job on a failure, or if it will continue on
withSuccess(boolean) - Method in class com.marklogic.hub.step.RunStepResponse
 
withThreadCount(int) - Method in class com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl
 
withThreadCount(int) - Method in interface com.marklogic.hub.legacy.flow.LegacyFlowRunner
Sets the thread count for the flowrunner
withThreadCount(int) - Method in class com.marklogic.hub.step.impl.QueryStepRunner
 
withThreadCount(int) - Method in class com.marklogic.hub.step.impl.WriteStepRunner
 
withThreadCount(int) - Method in interface com.marklogic.hub.step.StepRunner
Sets the thread count for the flowrunner
withType(FlowType) - Method in class com.marklogic.hub.legacy.flow.LegacyFlowBuilder
 
wordLexicon - Variable in class com.marklogic.hub.entity.DefinitionType
 
write(Object) - Method in class com.marklogic.hub.util.json.JSONStreamWriter
 
writeHubCentralFilesAsZip(HubClient, OutputStream) - Method in class com.marklogic.hub.hubcentral.HubCentralManager
 
writeNumberIf(ObjectNode, String, Integer) - Static method in class com.marklogic.hub.entity.JsonPojo
 
writeObjectIf(ObjectNode, String, JsonPojo) - Static method in class com.marklogic.hub.entity.JsonPojo
 
writeProjectFilesAsZip(HubClient, OutputStream) - Method in class com.marklogic.hub.hubcentral.HubCentralManager
 
WriteStepRunner - Class in com.marklogic.hub.step.impl
 
WriteStepRunner(HubClient, HubProject) - Constructor for class com.marklogic.hub.step.impl.WriteStepRunner
 
writeStringIf(ObjectNode, String, String) - Static method in class com.marklogic.hub.entity.JsonPojo
 
writeValueAsString(Object) - Static method in class com.marklogic.hub.util.json.JSONObject
Returns a json string from an Object with pretty print
writeValueAsString(Object, boolean) - Static method in class com.marklogic.hub.util.json.JSONObject
Returns a json string from an Object with pretty print as a flag
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links