diff --git a/_includes/javadoclinks.html b/_includes/javadoclinks.html index dfcbdf6736..0b3db11703 100644 --- a/_includes/javadoclinks.html +++ b/_includes/javadoclinks.html @@ -1,4 +1,4 @@ -{% for image in site.static_files %} +{% for image in site.static_files reversed %} {% assign parts = (image.path | split: "/") %} {% if parts.size == 4 and parts[1] == 'javadocs' and parts[3] == 'index.html' %}
MarkLogic Data Hub Framework {{parts[2]}}
diff --git a/javadocs/2.0.3/allclasses-frame.html b/javadocs/2.0.3/allclasses-frame.html new file mode 100644 index 0000000000..d1a49b0d1b --- /dev/null +++ b/javadocs/2.0.3/allclasses-frame.html @@ -0,0 +1,91 @@ + + + + + +public class CacheBusterDocumentFileProcessor
+extends com.marklogic.client.ext.helper.LoggingObject
+implements com.marklogic.client.ext.file.DocumentFileProcessor
+logger
Constructor and Description | +
---|
CacheBusterDocumentFileProcessor() |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.client.ext.file.DocumentFile |
+processDocumentFile(com.marklogic.client.ext.file.DocumentFile documentFile) |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
CacheBusterDocumentFileProcessor | ++ |
public class EntityDefModulesFinder
+extends com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
+logger
Constructor and Description | +
---|
EntityDefModulesFinder() |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.marklogic.client.ext.modulesloader.Modules |
+findModulesWithResolvedBaseDir(java.lang.String baseDir) |
+
addAssetDirectories, addNamespaces, addOptions, addPropertiesFile, addServices, addTransforms, decodeAssetDirectoryResource, findModules, findResources, getNamespaceFilenameFilter, getRecognizedPaths, getTransformFilenameFilter, isIncludeUnrecognizedPathsAsAssetPaths, setIncludeUnrecognizedPathsAsAssetPaths, setNamespaceFilenameFilter, setNamespacesPath, setOptionsPath, setServicesPath, setTransformFilenameFilter, setTransformsPath
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public EntityDefModulesFinder()+
protected com.marklogic.client.ext.modulesloader.Modules findModulesWithResolvedBaseDir(java.lang.String baseDir)+
findModulesWithResolvedBaseDir
in class com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
public class SearchOptionsFinder
+extends com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
+logger
Constructor and Description | +
---|
SearchOptionsFinder() |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.marklogic.client.ext.modulesloader.Modules |
+findModulesWithResolvedBaseDir(java.lang.String baseDir) |
+
addAssetDirectories, addNamespaces, addOptions, addPropertiesFile, addServices, addTransforms, decodeAssetDirectoryResource, findModules, findResources, getNamespaceFilenameFilter, getRecognizedPaths, getTransformFilenameFilter, isIncludeUnrecognizedPathsAsAssetPaths, setIncludeUnrecognizedPathsAsAssetPaths, setNamespaceFilenameFilter, setNamespacesPath, setOptionsPath, setServicesPath, setTransformFilenameFilter, setTransformsPath
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
protected com.marklogic.client.ext.modulesloader.Modules findModulesWithResolvedBaseDir(java.lang.String baseDir)+
findModulesWithResolvedBaseDir
in class com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
public class UserModulesFinder
+extends com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
+implements com.marklogic.client.ext.modulesloader.ModulesFinder
+logger
Constructor and Description | +
---|
UserModulesFinder() |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.marklogic.client.ext.modulesloader.Modules |
+findModulesWithResolvedBaseDir(java.lang.String baseDir) |
+
addAssetDirectories, addNamespaces, addOptions, addPropertiesFile, addServices, addTransforms, decodeAssetDirectoryResource, findModules, findResources, getNamespaceFilenameFilter, getRecognizedPaths, getTransformFilenameFilter, isIncludeUnrecognizedPathsAsAssetPaths, setIncludeUnrecognizedPathsAsAssetPaths, setNamespaceFilenameFilter, setNamespacesPath, setOptionsPath, setServicesPath, setTransformFilenameFilter, setTransformsPath
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
findModules
protected com.marklogic.client.ext.modulesloader.Modules findModulesWithResolvedBaseDir(java.lang.String baseDir)+
findModulesWithResolvedBaseDir
in class com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
Class | +Description | +
---|---|
EntityDefModulesFinder | ++ |
SearchOptionsFinder | ++ |
UserModulesFinder | ++ |
public class DataHub
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
Constructor and Description | +
---|
DataHub(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+clearUserModules()
+Removes user's modules from the modules db
+ TODO: this becomes much simpler when we move code into the server dir
+ |
+
com.marklogic.mgmt.admin.AdminManager |
+getAdminManager() |
+
java.util.List<com.marklogic.appdeployer.command.Command> |
+getCommandList() |
+
com.marklogic.mgmt.resource.databases.DatabaseManager |
+getDatabaseManager() |
+
com.marklogic.mgmt.ManageClient |
+getManageClient() |
+
com.marklogic.mgmt.resource.appservers.ServerManager |
+getServerManager() |
+
void |
+initProject() |
+
void |
+install()
+Installs the data hub configuration and server-side modules into MarkLogic
+ |
+
void |
+install(HubDeployStatusListener listener)
+Installs the data hub configuration and server-side modules into MarkLogic
+ |
+
InstallInfo |
+isInstalled()
+Determines if the data hub is installed in MarkLogic
+ |
+
boolean |
+isServerVersionValid(java.lang.String versionString)
+Validates the MarkLogic server to ensure compatibility with the hub
+ |
+
PreInstallCheck |
+runPreInstallCheck() |
+
PreInstallCheck |
+runPreInstallCheck(Versions versions) |
+
void |
+uninstall()
+Uninstalls the data hub configuration and server-side modules from MarkLogic
+ |
+
void |
+uninstall(HubDeployStatusListener listener)
+Uninstalls the data hub configuration and server-side modules from MarkLogic
+ |
+
void |
+updateIndexes() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public com.marklogic.mgmt.ManageClient getManageClient()+
public com.marklogic.mgmt.admin.AdminManager getAdminManager()+
public com.marklogic.mgmt.resource.databases.DatabaseManager getDatabaseManager()+
public com.marklogic.mgmt.resource.appservers.ServerManager getServerManager()+
public InstallInfo isInstalled()+
public boolean isServerVersionValid(java.lang.String versionString)+
versionString
- - the version of the server to validateServerValidationException
- if the server is not compatiblepublic void initProject()+
public void clearUserModules()+
public java.util.List<com.marklogic.appdeployer.command.Command> getCommandList()+
public PreInstallCheck runPreInstallCheck()+
public PreInstallCheck runPreInstallCheck(Versions versions)+
public void install()+
public void install(HubDeployStatusListener listener)+
listener
- - the callback method to receive status updatespublic void updateIndexes()+
public void uninstall()+
public void uninstall(HubDeployStatusListener listener)+
listener
- - the callback method to receive status updatespublic class DataHubUpgrader
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+MIN_UPGRADE_VERSION |
+
Constructor and Description | +
---|
DataHubUpgrader(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+upgradeHub() |
+
boolean |
+upgradeHub(java.util.List<java.lang.String> updatedFlows) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static java.lang.String MIN_UPGRADE_VERSION+
public DataHubUpgrader(HubConfig hubConfig)+
public boolean upgradeHub() + throws CantUpgradeException+
CantUpgradeException
public boolean upgradeHub(java.util.List<java.lang.String> updatedFlows) + throws CantUpgradeException+
CantUpgradeException
public class Debugging
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
Debugging(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+disable()
+Disables debugging
+ |
+
void |
+enable()
+Enables debugging
+ |
+
boolean |
+isEnabled()
+Determines if the hub has debugging enabled or not
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public Debugging(com.marklogic.client.DatabaseClient client)+
public void enable()+
public void disable()+
public boolean isEnabled()+
public class EntityManager
+extends com.marklogic.client.ext.helper.LoggingObject
+logger
Constructor and Description | +
---|
EntityManager(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
java.util.List<org.springframework.core.io.Resource> |
+deploySearchOptions() |
+
boolean |
+saveDbIndexes() |
+
boolean |
+saveSearchOptions() |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class FlowManager
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
FlowManager(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
static Flow |
+flowFromXml(org.w3c.dom.Element doc)
+Turns an XML document into a flow
+ |
+
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName)
+Retrieves a named flow from a given entity
+ |
+
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType) |
+
Flow |
+getFlowFromProperties(java.nio.file.Path propertiesFile) |
+
java.util.List<Flow> |
+getFlows(java.lang.String entityName)
+Retrieves a list of flows installed on the MarkLogic server
+ |
+
java.util.List<java.lang.String> |
+getLegacyFlows() |
+
java.util.List<Flow> |
+getLocalFlows()
+retrieves a list of all the flows on the local files systems
+ |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName) |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName,
+ FlowType flowType) |
+
FlowRunner |
+newFlowRunner() |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public java.util.List<Flow> getLocalFlows()+
public java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName)+
public java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName, + FlowType flowType)+
public Flow getFlowFromProperties(java.nio.file.Path propertiesFile)+
public java.util.List<Flow> getFlows(java.lang.String entityName)+
entityName
- - the entity from which to fetch the flowspublic Flow getFlow(java.lang.String entityName, + java.lang.String flowName)+
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getpublic Flow getFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
public java.util.List<java.lang.String> getLegacyFlows()+
public java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion)+
public FlowRunner newFlowRunner()+
public static Flow flowFromXml(org.w3c.dom.Element doc)+
doc
- - the xml document representing a flowpublic interface HubConfig
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DEFAULT_AUTH_METHOD |
+
static java.lang.String |
+DEFAULT_CUSTOM_FOREST_PATH |
+
static java.lang.String |
+DEFAULT_FINAL_NAME |
+
static java.lang.Integer |
+DEFAULT_FINAL_PORT |
+
static java.lang.Integer |
+DEFAULT_FORESTS_PER_HOST |
+
static java.lang.String |
+DEFAULT_JOB_NAME |
+
static java.lang.Integer |
+DEFAULT_JOB_PORT |
+
static java.lang.String |
+DEFAULT_MODULES_DB_NAME |
+
static java.lang.String |
+DEFAULT_ROLE_NAME |
+
static java.lang.String |
+DEFAULT_SCHEMAS_DB_NAME |
+
static java.lang.String |
+DEFAULT_SCHEME |
+
static java.lang.String |
+DEFAULT_STAGING_NAME |
+
static java.lang.Integer |
+DEFAULT_STAGING_PORT |
+
static java.lang.String |
+DEFAULT_TRACE_NAME |
+
static java.lang.Integer |
+DEFAULT_TRACE_PORT |
+
static java.lang.String |
+DEFAULT_TRIGGERS_DB_NAME |
+
static java.lang.String |
+DEFAULT_USER_NAME |
+
static java.lang.String |
+ENTITY_CONFIG_DIR |
+
static java.lang.String |
+FINAL_ENTITY_SEARCH_OPTIONS_FILE |
+
static java.lang.String |
+HUB_CONFIG_DIR |
+
static java.lang.String |
+HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+
static java.lang.String |
+STAGING_ENTITY_SEARCH_OPTIONS_FILE |
+
static java.lang.String |
+USER_CONFIG_DIR |
+
static java.lang.String |
+USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES |
+
static java.lang.String |
+USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.mgmt.admin.AdminConfig |
+getAdminConfig() |
+
com.marklogic.mgmt.admin.AdminManager |
+getAdminManager() |
+
com.marklogic.appdeployer.AppConfig |
+getAppConfig() |
+
java.lang.String |
+getCustomForestPath() |
+
java.nio.file.Path |
+getEntityDatabaseDir() |
+
java.lang.String |
+getFinalAuthMethod() |
+
java.lang.String |
+getFinalCertFile() |
+
java.lang.String |
+getFinalCertPassword() |
+
java.lang.String |
+getFinalDbName() |
+
java.lang.String |
+getFinalExternalName() |
+
java.lang.Integer |
+getFinalForestsPerHost() |
+
java.lang.String |
+getFinalHttpName() |
+
java.lang.Integer |
+getFinalPort() |
+
java.lang.String |
+getFinalScheme() |
+
boolean |
+getFinalSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getFinalSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getFinalSslHostnameVerifier() |
+
java.lang.String |
+getHost() |
+
java.nio.file.Path |
+getHubConfigDir() |
+
java.nio.file.Path |
+getHubDatabaseDir() |
+
java.nio.file.Path |
+getHubEntitiesDir() |
+
java.nio.file.Path |
+getHubMimetypesDir() |
+
java.lang.String |
+getHubModulesDeployTimestampFile() |
+
java.nio.file.Path |
+getHubPluginsDir() |
+
HubProject |
+getHubProject() |
+
java.lang.String |
+getHubRoleName() |
+
java.nio.file.Path |
+getHubSecurityDir() |
+
java.nio.file.Path |
+getHubServersDir() |
+
java.lang.String |
+getHubUserName() |
+
java.lang.String |
+getJarVersion() |
+
java.lang.String |
+getJobAuthMethod() |
+
java.lang.String |
+getJobCertFile() |
+
java.lang.String |
+getJobCertPassword() |
+
java.lang.String |
+getJobDbName() |
+
java.lang.String |
+getJobExternalName() |
+
java.lang.Integer |
+getJobForestsPerHost() |
+
java.lang.String |
+getJobHttpName() |
+
java.lang.Integer |
+getJobPort() |
+
java.lang.String |
+getJobScheme() |
+
boolean |
+getJobSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getJobSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getJobSslHostnameVerifier() |
+
java.lang.String[] |
+getLoadBalancerHosts() |
+
com.marklogic.mgmt.ManageClient |
+getManageClient() |
+
com.marklogic.mgmt.ManageConfig |
+getManageConfig() |
+
java.lang.String |
+getModulePermissions() |
+
java.lang.String |
+getModulesDbName() |
+
java.lang.Integer |
+getModulesForestsPerHost() |
+
java.lang.String |
+getProjectDir() |
+
java.lang.String |
+getSchemasDbName() |
+
java.lang.Integer |
+getSchemasForestsPerHost() |
+
java.lang.String |
+getStagingAuthMethod() |
+
java.lang.String |
+getStagingCertFile() |
+
java.lang.String |
+getStagingCertPassword() |
+
java.lang.String |
+getStagingDbName() |
+
java.lang.String |
+getStagingExternalName() |
+
java.lang.Integer |
+getStagingForestsPerHost() |
+
java.lang.String |
+getStagingHttpName() |
+
java.lang.Integer |
+getStagingPort() |
+
java.lang.String |
+getStagingScheme() |
+
boolean |
+getStagingSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getStagingSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getStagingSslHostnameVerifier() |
+
java.lang.String |
+getTraceAuthMethod() |
+
java.lang.String |
+getTraceCertFile() |
+
java.lang.String |
+getTraceCertPassword() |
+
java.lang.String |
+getTraceDbName() |
+
java.lang.String |
+getTraceExternalName() |
+
java.lang.Integer |
+getTraceForestsPerHost() |
+
java.lang.String |
+getTraceHttpName() |
+
java.lang.Integer |
+getTracePort() |
+
java.lang.String |
+getTraceScheme() |
+
boolean |
+getTraceSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getTraceSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getTraceSslHostnameVerifier() |
+
java.lang.String |
+getTriggersDbName() |
+
java.lang.Integer |
+getTriggersForestsPerHost() |
+
java.nio.file.Path |
+getUserConfigDir() |
+
java.io.File |
+getUserContentDeployTimestampFile() |
+
java.nio.file.Path |
+getUserDatabaseDir() |
+
java.lang.String |
+getUserModulesDeployTimestampFile() |
+
java.nio.file.Path |
+getUserSecurityDir() |
+
java.nio.file.Path |
+getUserServersDir() |
+
void |
+initHubProject() |
+
com.marklogic.client.DatabaseClient |
+newAppServicesClient() |
+
com.marklogic.client.DatabaseClient |
+newFinalClient()
+Creates a new DatabaseClient for accessing the Final database
+ |
+
com.marklogic.client.DatabaseClient |
+newJobDbClient()
+Creates a new DatabaseClient for accessing the Job database
+ |
+
com.marklogic.client.DatabaseClient |
+newModulesDbClient()
+Creates a new DatabaseClient for accessing the Hub Modules database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient()
+Creates a new DatabaseClient for accessing the Staging database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient(java.lang.String databaseName) |
+
com.marklogic.client.DatabaseClient |
+newTraceDbClient()
+Creates a new DatabaseClient for accessing the Trace database
+ |
+
void |
+setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig) |
+
void |
+setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager) |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config) |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config,
+ boolean skipUpdate) |
+
void |
+setCustomForestPath(java.lang.String customForestPath) |
+
void |
+setFinalAuthMethod(java.lang.String finalAuthMethod) |
+
void |
+setFinalCertFile(java.lang.String finalCertFile) |
+
void |
+setFinalCertPassword(java.lang.String finalCertPassword) |
+
void |
+setFinalDbName(java.lang.String finalDbName) |
+
void |
+setFinalExternalName(java.lang.String finalExternalName) |
+
void |
+setFinalForestsPerHost(java.lang.Integer finalForestsPerHost) |
+
void |
+setFinalHttpName(java.lang.String finalHttpName) |
+
void |
+setFinalPort(java.lang.Integer finalPort) |
+
void |
+setFinalScheme(java.lang.String finalScheme) |
+
void |
+setFinalSimpleSsl(boolean finalSimpleSsl) |
+
void |
+setFinalSslContext(javax.net.ssl.SSLContext finalSslContext) |
+
void |
+setFinalSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier finalSslHostnameVerifier) |
+
void |
+setHubRoleName(java.lang.String hubRoleName) |
+
void |
+setHubUserName(java.lang.String hubUserName) |
+
void |
+setJobAuthMethod(java.lang.String jobAuthMethod) |
+
void |
+setJobCertFile(java.lang.String jobCertFile) |
+
void |
+setJobCertPassword(java.lang.String jobCertPassword) |
+
void |
+setJobDbName(java.lang.String jobDbName) |
+
void |
+setJobExternalName(java.lang.String jobExternalName) |
+
void |
+setJobForestsPerHost(java.lang.Integer jobForestsPerHost) |
+
void |
+setJobHttpName(java.lang.String jobHttpName) |
+
void |
+setJobPort(java.lang.Integer jobPort) |
+
void |
+setJobScheme(java.lang.String jobScheme) |
+
void |
+setJobSimpleSsl(boolean jobSimpleSsl) |
+
void |
+setJobSslContext(javax.net.ssl.SSLContext jobSslContext) |
+
void |
+setJobSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier jobSslHostnameVerifier) |
+
void |
+setLoadBalancerHosts(java.lang.String[] loadBalancerHosts) |
+
void |
+setManageClient(com.marklogic.mgmt.ManageClient manageClient) |
+
void |
+setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig) |
+
void |
+setModulePermissions(java.lang.String modulePermissions) |
+
void |
+setModulesDbName(java.lang.String modulesDbName) |
+
void |
+setModulesForestsPerHost(java.lang.Integer modulesForestsPerHost) |
+
void |
+setProjectDir(java.lang.String projectDir) |
+
void |
+setSchemasDbName(java.lang.String schemasDbName) |
+
void |
+setSchemasForestsPerHost(java.lang.Integer schemasForestsPerHost) |
+
void |
+setStagingAuthMethod(java.lang.String stagingAuthMethod) |
+
void |
+setStagingCertFile(java.lang.String stagingCertFile) |
+
void |
+setStagingCertPassword(java.lang.String stagingCertPassword) |
+
void |
+setStagingDbName(java.lang.String stagingDbName) |
+
void |
+setStagingExternalName(java.lang.String stagingExternalName) |
+
void |
+setStagingForestsPerHost(java.lang.Integer stagingForestsPerHost) |
+
void |
+setStagingHttpName(java.lang.String stagingHttpName) |
+
void |
+setStagingPort(java.lang.Integer stagingPort) |
+
void |
+setStagingScheme(java.lang.String stagingScheme) |
+
void |
+setStagingSimpleSsl(boolean stagingSimpleSsl) |
+
void |
+setStagingSslContext(javax.net.ssl.SSLContext stagingSslContext) |
+
void |
+setStagingSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier) |
+
void |
+setTraceAuthMethod(java.lang.String traceAuthMethod) |
+
void |
+setTraceCertFile(java.lang.String traceCertFile) |
+
void |
+setTraceCertPassword(java.lang.String traceCertPassword) |
+
void |
+setTraceDbName(java.lang.String traceDbName) |
+
void |
+setTraceExternalName(java.lang.String traceExternalName) |
+
void |
+setTraceForestsPerHost(java.lang.Integer traceForestsPerHost) |
+
void |
+setTraceHttpName(java.lang.String traceHttpName) |
+
void |
+setTracePort(java.lang.Integer tracePort) |
+
void |
+setTraceScheme(java.lang.String traceScheme) |
+
void |
+setTraceSimpleSsl(boolean traceSimpleSsl) |
+
void |
+setTraceSslContext(javax.net.ssl.SSLContext traceSslContext) |
+
void |
+setTraceSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier traceSslHostnameVerifier) |
+
void |
+setTriggersDbName(java.lang.String triggersDbName) |
+
void |
+setTriggersForestsPerHost(java.lang.Integer triggersForestsPerHost) |
+
static final java.lang.String HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES+
static final java.lang.String USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES+
static final java.lang.String USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES+
static final java.lang.String HUB_CONFIG_DIR+
static final java.lang.String USER_CONFIG_DIR+
static final java.lang.String ENTITY_CONFIG_DIR+
static final java.lang.String STAGING_ENTITY_SEARCH_OPTIONS_FILE+
static final java.lang.String FINAL_ENTITY_SEARCH_OPTIONS_FILE+
static final java.lang.String DEFAULT_STAGING_NAME+
static final java.lang.String DEFAULT_FINAL_NAME+
static final java.lang.String DEFAULT_TRACE_NAME+
static final java.lang.String DEFAULT_JOB_NAME+
static final java.lang.String DEFAULT_MODULES_DB_NAME+
static final java.lang.String DEFAULT_TRIGGERS_DB_NAME+
static final java.lang.String DEFAULT_SCHEMAS_DB_NAME+
static final java.lang.String DEFAULT_ROLE_NAME+
static final java.lang.String DEFAULT_USER_NAME+
static final java.lang.Integer DEFAULT_STAGING_PORT+
static final java.lang.Integer DEFAULT_FINAL_PORT+
static final java.lang.Integer DEFAULT_TRACE_PORT+
static final java.lang.Integer DEFAULT_JOB_PORT+
static final java.lang.String DEFAULT_AUTH_METHOD+
static final java.lang.String DEFAULT_SCHEME+
static final java.lang.Integer DEFAULT_FORESTS_PER_HOST+
static final java.lang.String DEFAULT_CUSTOM_FOREST_PATH+
java.lang.String getHost()+
java.lang.String getStagingDbName()+
void setStagingDbName(java.lang.String stagingDbName)+
java.lang.String getStagingHttpName()+
void setStagingHttpName(java.lang.String stagingHttpName)+
java.lang.Integer getStagingForestsPerHost()+
void setStagingForestsPerHost(java.lang.Integer stagingForestsPerHost)+
java.lang.Integer getStagingPort()+
void setStagingPort(java.lang.Integer stagingPort)+
java.lang.String getStagingAuthMethod()+
void setStagingAuthMethod(java.lang.String stagingAuthMethod)+
java.lang.String getStagingScheme()+
void setStagingScheme(java.lang.String stagingScheme)+
boolean getStagingSimpleSsl()+
void setStagingSimpleSsl(boolean stagingSimpleSsl)+
javax.net.ssl.SSLContext getStagingSslContext()+
void setStagingSslContext(javax.net.ssl.SSLContext stagingSslContext)+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getStagingSslHostnameVerifier()+
void setStagingSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier)+
java.lang.String getStagingCertFile()+
void setStagingCertFile(java.lang.String stagingCertFile)+
java.lang.String getStagingCertPassword()+
void setStagingCertPassword(java.lang.String stagingCertPassword)+
java.lang.String getStagingExternalName()+
void setStagingExternalName(java.lang.String stagingExternalName)+
java.lang.String getFinalDbName()+
void setFinalDbName(java.lang.String finalDbName)+
java.lang.String getFinalHttpName()+
void setFinalHttpName(java.lang.String finalHttpName)+
java.lang.Integer getFinalForestsPerHost()+
void setFinalForestsPerHost(java.lang.Integer finalForestsPerHost)+
java.lang.Integer getFinalPort()+
void setFinalPort(java.lang.Integer finalPort)+
java.lang.String getFinalAuthMethod()+
void setFinalAuthMethod(java.lang.String finalAuthMethod)+
java.lang.String getFinalScheme()+
void setFinalScheme(java.lang.String finalScheme)+
boolean getFinalSimpleSsl()+
void setFinalSimpleSsl(boolean finalSimpleSsl)+
javax.net.ssl.SSLContext getFinalSslContext()+
void setFinalSslContext(javax.net.ssl.SSLContext finalSslContext)+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getFinalSslHostnameVerifier()+
void setFinalSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier finalSslHostnameVerifier)+
java.lang.String getFinalCertFile()+
void setFinalCertFile(java.lang.String finalCertFile)+
java.lang.String getFinalCertPassword()+
void setFinalCertPassword(java.lang.String finalCertPassword)+
java.lang.String getFinalExternalName()+
void setFinalExternalName(java.lang.String finalExternalName)+
java.lang.String getTraceDbName()+
void setTraceDbName(java.lang.String traceDbName)+
java.lang.String getTraceHttpName()+
void setTraceHttpName(java.lang.String traceHttpName)+
java.lang.Integer getTraceForestsPerHost()+
void setTraceForestsPerHost(java.lang.Integer traceForestsPerHost)+
java.lang.Integer getTracePort()+
void setTracePort(java.lang.Integer tracePort)+
java.lang.String getTraceAuthMethod()+
void setTraceAuthMethod(java.lang.String traceAuthMethod)+
java.lang.String getTraceScheme()+
void setTraceScheme(java.lang.String traceScheme)+
boolean getTraceSimpleSsl()+
void setTraceSimpleSsl(boolean traceSimpleSsl)+
javax.net.ssl.SSLContext getTraceSslContext()+
void setTraceSslContext(javax.net.ssl.SSLContext traceSslContext)+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getTraceSslHostnameVerifier()+
void setTraceSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier traceSslHostnameVerifier)+
java.lang.String getTraceCertFile()+
void setTraceCertFile(java.lang.String traceCertFile)+
java.lang.String getTraceCertPassword()+
void setTraceCertPassword(java.lang.String traceCertPassword)+
java.lang.String getTraceExternalName()+
void setTraceExternalName(java.lang.String traceExternalName)+
java.lang.String getJobDbName()+
void setJobDbName(java.lang.String jobDbName)+
java.lang.String getJobHttpName()+
void setJobHttpName(java.lang.String jobHttpName)+
java.lang.Integer getJobForestsPerHost()+
void setJobForestsPerHost(java.lang.Integer jobForestsPerHost)+
java.lang.Integer getJobPort()+
void setJobPort(java.lang.Integer jobPort)+
java.lang.String getJobAuthMethod()+
void setJobAuthMethod(java.lang.String jobAuthMethod)+
java.lang.String getJobScheme()+
void setJobScheme(java.lang.String jobScheme)+
boolean getJobSimpleSsl()+
void setJobSimpleSsl(boolean jobSimpleSsl)+
javax.net.ssl.SSLContext getJobSslContext()+
void setJobSslContext(javax.net.ssl.SSLContext jobSslContext)+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getJobSslHostnameVerifier()+
void setJobSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier jobSslHostnameVerifier)+
java.lang.String getJobCertFile()+
void setJobCertFile(java.lang.String jobCertFile)+
java.lang.String getJobCertPassword()+
void setJobCertPassword(java.lang.String jobCertPassword)+
java.lang.String getJobExternalName()+
void setJobExternalName(java.lang.String jobExternalName)+
java.lang.String getModulesDbName()+
void setModulesDbName(java.lang.String modulesDbName)+
java.lang.Integer getModulesForestsPerHost()+
void setModulesForestsPerHost(java.lang.Integer modulesForestsPerHost)+
java.lang.String getTriggersDbName()+
void setTriggersDbName(java.lang.String triggersDbName)+
java.lang.Integer getTriggersForestsPerHost()+
void setTriggersForestsPerHost(java.lang.Integer triggersForestsPerHost)+
java.lang.String getSchemasDbName()+
void setSchemasDbName(java.lang.String schemasDbName)+
java.lang.Integer getSchemasForestsPerHost()+
void setSchemasForestsPerHost(java.lang.Integer schemasForestsPerHost)+
java.lang.String getHubRoleName()+
void setHubRoleName(java.lang.String hubRoleName)+
java.lang.String getHubUserName()+
void setHubUserName(java.lang.String hubUserName)+
java.lang.String[] getLoadBalancerHosts()+
void setLoadBalancerHosts(java.lang.String[] loadBalancerHosts)+
java.lang.String getCustomForestPath()+
void setCustomForestPath(java.lang.String customForestPath)+
java.lang.String getModulePermissions()+
void setModulePermissions(java.lang.String modulePermissions)+
java.lang.String getProjectDir()+
void setProjectDir(java.lang.String projectDir)+
HubProject getHubProject()+
void initHubProject()+
java.lang.String getHubModulesDeployTimestampFile()+
java.lang.String getUserModulesDeployTimestampFile()+
java.io.File getUserContentDeployTimestampFile()+
com.marklogic.mgmt.ManageConfig getManageConfig()+
void setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
com.marklogic.mgmt.ManageClient getManageClient()+
void setManageClient(com.marklogic.mgmt.ManageClient manageClient)+
com.marklogic.mgmt.admin.AdminConfig getAdminConfig()+
void setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
com.marklogic.mgmt.admin.AdminManager getAdminManager()+
void setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
com.marklogic.client.DatabaseClient newAppServicesClient()+
com.marklogic.client.DatabaseClient newStagingClient()+
com.marklogic.client.DatabaseClient newStagingClient(java.lang.String databaseName)+
com.marklogic.client.DatabaseClient newFinalClient()+
com.marklogic.client.DatabaseClient newJobDbClient()+
com.marklogic.client.DatabaseClient newTraceDbClient()+
com.marklogic.client.DatabaseClient newModulesDbClient()+
java.nio.file.Path getHubPluginsDir()+
java.nio.file.Path getHubEntitiesDir()+
java.nio.file.Path getHubConfigDir()+
java.nio.file.Path getHubDatabaseDir()+
java.nio.file.Path getHubServersDir()+
java.nio.file.Path getHubSecurityDir()+
java.nio.file.Path getUserSecurityDir()+
java.nio.file.Path getUserConfigDir()+
java.nio.file.Path getUserDatabaseDir()+
java.nio.file.Path getEntityDatabaseDir()+
java.nio.file.Path getUserServersDir()+
java.nio.file.Path getHubMimetypesDir()+
com.marklogic.appdeployer.AppConfig getAppConfig()+
void setAppConfig(com.marklogic.appdeployer.AppConfig config)+
void setAppConfig(com.marklogic.appdeployer.AppConfig config, + boolean skipUpdate)+
java.lang.String getJarVersion() + throws java.io.IOException+
java.io.IOException
public class HubConfigBuilder
+extends java.lang.Object
+
+ HubConfig hubConfig = HubConfigBuilder.newHubConfigBuilder("/path/to/your/project")
+ .withPropertiesFromEnvironment("local")
+ .build();
+
Modifier and Type | +Method and Description | +
---|---|
HubConfig |
+build()
+Builds the
+HubConfig instance |
+
static HubConfigBuilder |
+newHubConfigBuilder(java.lang.String projectDir)
+Returns a new
+HubConfigBuilder instance |
+
HubConfigBuilder |
+withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)
+Sets the
+AdminConfig for the HubConfig |
+
HubConfigBuilder |
+withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)
+Sets the
+AdminManager for the HubConfig |
+
HubConfigBuilder |
+withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)
+Sets the
+AppConfig for the HubConfig |
+
HubConfigBuilder |
+withManageClient(com.marklogic.mgmt.ManageClient manageClient)
+Sets the
+ManageClient for the HubConfig |
+
HubConfigBuilder |
+withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)
+Sets the
+ManageConfig for the HubConfig |
+
HubConfigBuilder |
+withProperties(java.util.Properties properties)
+Tells the builder to use the given properties.
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment()
+Tells the builder to load properties from the gradle files in the project dir
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment(java.lang.String environment)
+Tells the builder to load properties from the gradle files in the project dir
+ but to look for an environment properties file with overrides
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static HubConfigBuilder newHubConfigBuilder(java.lang.String projectDir)+
HubConfigBuilder
instanceprojectDir
- - the hub's project directoryHubConfigBuilder
public HubConfigBuilder withPropertiesFromEnvironment()+
HubConfigBuilder
instancepublic HubConfigBuilder withPropertiesFromEnvironment(java.lang.String environment)+
environment
- - the name of the environment to use (local,dev,qa,prod,...)HubConfigBuilder
instancepublic HubConfigBuilder withProperties(java.util.Properties properties)+
properties
- - A Properties
object with properties setHubConfigBuilder
instancepublic HubConfigBuilder withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)+
AppConfig
for the HubConfig
appConfig
- - an AppConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
AdminConfig
for the HubConfig
adminConfig
- - an AdminConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
AdminManager
for the HubConfig
adminManager
- - an AdminManager
objectHubConfigBuilder
instancepublic HubConfigBuilder withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
ManageConfig
for the HubConfig
manageConfig
- - a ManageConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withManageClient(com.marklogic.mgmt.ManageClient manageClient)+
ManageClient
for the HubConfig
manageClient
- - a ManageClient
HubConfigBuilder
instancepublic enum HubDatabase +extends java.lang.Enum<HubDatabase>+
Enum Constant and Description | +
---|
FINAL |
+
STAGING |
+
Modifier and Type | +Method and Description | +
---|---|
static HubDatabase |
+getHubDatabase(java.lang.String database) |
+
java.lang.String |
+toString() |
+
static HubDatabase |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static HubDatabase[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final HubDatabase STAGING+
public static final HubDatabase FINAL+
public static HubDatabase[] values()+
+for (HubDatabase c : HubDatabase.values()) + System.out.println(c); +
public static HubDatabase valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static HubDatabase getHubDatabase(java.lang.String database)+
public java.lang.String toString()+
toString
in class java.lang.Enum<HubDatabase>
public class HubProject
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+ENTITY_CONFIG_DIR |
+
static java.lang.String |
+HUB_CONFIG_DIR |
+
protected org.slf4j.Logger |
+logger |
+
static java.lang.String |
+USER_CONFIG_DIR |
+
Constructor and Description | +
---|
HubProject(java.lang.String projectDirStr) |
+
Modifier and Type | +Method and Description | +
---|---|
java.nio.file.Path |
+getEntityConfigDir() |
+
java.nio.file.Path |
+getEntityDatabaseDir() |
+
java.nio.file.Path |
+getHubConfigDir() |
+
java.nio.file.Path |
+getHubDatabaseDir() |
+
java.nio.file.Path |
+getHubEntitiesDir() |
+
java.nio.file.Path |
+getHubMimetypesDir() |
+
java.nio.file.Path |
+getHubPluginsDir() |
+
java.nio.file.Path |
+getHubSecurityDir() |
+
java.nio.file.Path |
+getHubServersDir() |
+
java.nio.file.Path |
+getUserConfigDir() |
+
java.nio.file.Path |
+getUserDatabaseDir() |
+
java.nio.file.Path |
+getUserSchemasDir() |
+
java.nio.file.Path |
+getUserSecurityDir() |
+
java.nio.file.Path |
+getUserServersDir() |
+
void |
+init(java.util.Map<java.lang.String,java.lang.String> customTokens)
+Initializes a directory as a hub project directory.
+ |
+
boolean |
+isInitialized() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final java.lang.String HUB_CONFIG_DIR+
public static final java.lang.String USER_CONFIG_DIR+
public static final java.lang.String ENTITY_CONFIG_DIR+
protected final org.slf4j.Logger logger+
public HubProject(java.lang.String projectDirStr)+
public java.nio.file.Path getHubPluginsDir()+
public java.nio.file.Path getHubEntitiesDir()+
public java.nio.file.Path getHubConfigDir()+
public java.nio.file.Path getHubDatabaseDir()+
public java.nio.file.Path getHubServersDir()+
public java.nio.file.Path getHubSecurityDir()+
public java.nio.file.Path getHubMimetypesDir()+
public java.nio.file.Path getUserConfigDir()+
public java.nio.file.Path getUserSecurityDir()+
public java.nio.file.Path getUserDatabaseDir()+
public java.nio.file.Path getUserSchemasDir()+
public java.nio.file.Path getUserServersDir()+
public java.nio.file.Path getEntityConfigDir()+
public java.nio.file.Path getEntityDatabaseDir()+
public boolean isInitialized()+
public void init(java.util.Map<java.lang.String,java.lang.String> customTokens)+
customTokens
- - some custom tokens to start withpublic class InstallInfo
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
boolean |
+finalAppServerExists |
+
boolean |
+finalCollectionLexiconOn |
+
boolean |
+finalDbExists |
+
boolean |
+finalForestsExist |
+
boolean |
+finalTripleIndexOn |
+
boolean |
+jobAppServerExists |
+
boolean |
+jobDbExists |
+
boolean |
+jobForestsExist |
+
boolean |
+stagingAppServerExists |
+
boolean |
+stagingCollectionLexiconOn |
+
boolean |
+stagingDbExists |
+
boolean |
+stagingForestsExist |
+
boolean |
+stagingTripleIndexOn |
+
boolean |
+traceAppServerExists |
+
boolean |
+traceDbExists |
+
boolean |
+traceForestsExist |
+
Constructor and Description | +
---|
InstallInfo() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+isInstalled() |
+
boolean |
+isPartiallyInstalled() |
+
java.lang.String |
+toString() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public boolean stagingAppServerExists+
public boolean finalAppServerExists+
public boolean traceAppServerExists+
public boolean jobAppServerExists+
public boolean stagingDbExists+
public boolean finalDbExists+
public boolean traceDbExists+
public boolean jobDbExists+
public boolean stagingTripleIndexOn+
public boolean stagingCollectionLexiconOn+
public boolean finalTripleIndexOn+
public boolean finalCollectionLexiconOn+
public boolean stagingForestsExist+
public boolean finalForestsExist+
public boolean traceForestsExist+
public boolean jobForestsExist+
public class PreInstallCheck
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
boolean |
+finalPortInUse |
+
java.lang.String |
+finalPortInUseBy |
+
boolean |
+jobPortInUse |
+
java.lang.String |
+jobPortInUseBy |
+
java.lang.String |
+serverVersion |
+
boolean |
+serverVersionOk |
+
boolean |
+stagingPortInUse |
+
java.lang.String |
+stagingPortInUseBy |
+
boolean |
+tracePortInUse |
+
java.lang.String |
+tracePortInUseBy |
+
Constructor and Description | +
---|
PreInstallCheck() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+isSafeToInstall() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public boolean stagingPortInUse+
public java.lang.String stagingPortInUseBy+
public boolean finalPortInUse+
public java.lang.String finalPortInUseBy+
public boolean jobPortInUse+
public java.lang.String jobPortInUseBy+
public boolean tracePortInUse+
public java.lang.String tracePortInUseBy+
public boolean serverVersionOk+
public java.lang.String serverVersion+
public class Tracing
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
Tracing(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+disable()
+Disables tracing
+ |
+
void |
+enable()
+Enables tracing
+ |
+
boolean |
+isEnabled()
+Determines if the hub has tracing enabled or not
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public Tracing(com.marklogic.client.DatabaseClient client)+
public void enable()+
public void disable()+
public boolean isEnabled()+
public interface Collector
+Modifier and Type | +Method and Description | +
---|---|
com.marklogic.client.DatabaseClient |
+getClient() |
+
CodeFormat |
+getCodeFormat() |
+
HubConfig |
+getHubConfig() |
+
java.lang.String |
+getModule() |
+
DiskQueue<java.lang.String> |
+run(java.lang.String jobId,
+ java.lang.String entity,
+ java.lang.String flow,
+ int threadCount,
+ java.util.Map<java.lang.String,java.lang.Object> options) |
+
void |
+setClient(com.marklogic.client.DatabaseClient client) |
+
void |
+setHubConfig(HubConfig config) |
+
CodeFormat getCodeFormat()+
java.lang.String getModule()+
void setHubConfig(HubConfig config)+
HubConfig getHubConfig()+
void setClient(com.marklogic.client.DatabaseClient client)+
com.marklogic.client.DatabaseClient getClient()+
DiskQueue<java.lang.String> run(java.lang.String jobId, + java.lang.String entity, + java.lang.String flow, + int threadCount, + java.util.Map<java.lang.String,java.lang.Object> options)+
E
- - A Serializable Classpublic class DiskQueue<E extends java.io.Serializable>
+extends java.util.AbstractQueue<java.lang.String>
+Constructor and Description | +
---|
DiskQueue(int maxInMemorySize)
+Construct a disk-backed queue that keeps at most
+
+maxInMemorySize elements in memory. |
+
DiskQueue(int maxInMemorySize,
+ java.io.File tempDir)
+Construct a disk-backed queue that keeps at most
+
+maxInMemorySize elements in memory. |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+clear() |
+
protected void |
+finalize() |
+
java.util.Iterator<java.lang.String> |
+iterator() |
+
boolean |
+offer(java.lang.String element) |
+
java.lang.String |
+peek() |
+
java.lang.String |
+poll() |
+
java.lang.String |
+remove() |
+
int |
+size() |
+
add, addAll, element
contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray
forEach
public DiskQueue(int maxInMemorySize)+
maxInMemorySize
elements in memory.maxInMemorySize
- Maximum number of elements to keep in memory.public DiskQueue(int maxInMemorySize, + java.io.File tempDir)+
maxInMemorySize
elements in memory.maxInMemorySize
- Maximum number of elements to keep in memory.tempDir
- Directory where queue temporary files will be written to.protected void finalize() + throws java.lang.Throwable+
finalize
in class java.lang.Object
java.lang.Throwable
public java.util.Iterator<java.lang.String> iterator()+
iterator
in interface java.lang.Iterable<java.lang.String>
iterator
in interface java.util.Collection<java.lang.String>
iterator
in class java.util.AbstractCollection<java.lang.String>
public int size()+
size
in interface java.util.Collection<java.lang.String>
size
in class java.util.AbstractCollection<java.lang.String>
public boolean offer(java.lang.String element)+
public java.lang.String peek()+
public java.lang.String remove()+
remove
in interface java.util.Queue<java.lang.String>
remove
in class java.util.AbstractQueue<java.lang.String>
public java.lang.String poll()+
public void clear()+
clear
in interface java.util.Collection<java.lang.String>
clear
in class java.util.AbstractQueue<java.lang.String>
Constructor and Description | +
---|
CollectorImpl() |
+
CollectorImpl(java.lang.String module,
+ CodeFormat codeFormat) |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.client.DatabaseClient |
+getClient() |
+
CodeFormat |
+getCodeFormat() |
+
HubConfig |
+getHubConfig() |
+
java.lang.String |
+getModule() |
+
DiskQueue<java.lang.String> |
+run(java.lang.String jobId,
+ java.lang.String entity,
+ java.lang.String flow,
+ int threadCount,
+ java.util.Map<java.lang.String,java.lang.Object> options) |
+
void |
+setClient(com.marklogic.client.DatabaseClient client) |
+
void |
+setHubConfig(HubConfig config) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public CollectorImpl()+
public CollectorImpl(java.lang.String module, + CodeFormat codeFormat)+
public void setHubConfig(HubConfig config)+
setHubConfig
in interface Collector
public HubConfig getHubConfig()+
getHubConfig
in interface Collector
public void setClient(com.marklogic.client.DatabaseClient client)+ +
public com.marklogic.client.DatabaseClient getClient()+ +
public CodeFormat getCodeFormat()+
getCodeFormat
in interface Collector
public java.lang.String getModule()+ +
Class | +Description | +
---|---|
CollectorImpl | ++ |
public class HubAppDeployer
+extends com.marklogic.appdeployer.impl.SimpleAppDeployer
+logger
Constructor and Description | +
---|
HubAppDeployer(com.marklogic.mgmt.ManageClient manageClient,
+ com.marklogic.mgmt.admin.AdminManager adminManager,
+ HubDeployStatusListener listener) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+deploy(com.marklogic.appdeployer.AppConfig appConfig) |
+
void |
+undeploy(com.marklogic.appdeployer.AppConfig appConfig) |
+
buildModifiableCommandList, getCommand, getCommandOfType, getCommands, removeCommand, setCommands
executeCommand, prepareCommand, undoCommand
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public HubAppDeployer(com.marklogic.mgmt.ManageClient manageClient, + com.marklogic.mgmt.admin.AdminManager adminManager, + HubDeployStatusListener listener)+
public void deploy(com.marklogic.appdeployer.AppConfig appConfig)+
deploy
in interface com.marklogic.appdeployer.AppDeployer
deploy
in class com.marklogic.appdeployer.impl.AbstractAppDeployer
public void undeploy(com.marklogic.appdeployer.AppConfig appConfig)+
undeploy
in interface com.marklogic.appdeployer.AppDeployer
undeploy
in class com.marklogic.appdeployer.impl.AbstractAppDeployer
public class DeployHubDatabaseCommand
+extends com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubDatabaseCommand(HubConfig config,
+ java.lang.String databaseFilename) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.lang.String |
+buildDefaultDatabasePayload(com.marklogic.appdeployer.command.CommandContext context) |
+
protected com.marklogic.appdeployer.command.forests.DeployForestsCommand |
+buildDeployForestsCommand(java.lang.String dbPayload,
+ com.marklogic.mgmt.SaveReceipt receipt,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.String |
+buildPayload(com.marklogic.appdeployer.command.CommandContext context) |
+
protected int |
+determineForestCountPerHost(java.lang.String dbPayload,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.String |
+getDatabaseFilename() |
+
java.lang.String |
+getDatabaseName() |
+
java.lang.String |
+getForestDelete() |
+
java.lang.String |
+getForestFilename() |
+
int |
+getForestsPerHost() |
+
protected java.lang.String |
+getPayload(com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.Integer |
+getUndoSortOrder() |
+
boolean |
+isCreateDatabaseWithoutFile() |
+
boolean |
+isCreateForestsOnEachHost() |
+
protected com.fasterxml.jackson.databind.JsonNode |
+mergeDatabaseFiles(com.marklogic.appdeployer.AppConfig appConfig) |
+
void |
+setCreateDatabaseWithoutFile(boolean createDatabaseWithoutFile) |
+
void |
+setCreateForestsOnEachHost(boolean createForestsOnEachHost) |
+
void |
+setDatabaseFilename(java.lang.String databaseFilename) |
+
void |
+setDatabaseName(java.lang.String databaseName) |
+
void |
+setForestDelete(java.lang.String forestDelete) |
+
void |
+setForestFilename(java.lang.String forestFilename) |
+
void |
+setForestsPerHost(int forestsPerHost) |
+
void |
+setUndoSortOrder(int undoSortOrder) |
+
java.lang.String |
+toString() |
+
void |
+undo(com.marklogic.appdeployer.command.CommandContext context) |
+
addSubDatabases, buildForest, customForestsExist, getForestDeleteLevel, getSuperDatabaseName, isCheckForCustomForests, isSubDatabase, newDatabaseManageForDeleting, removeSubDatabases, setCheckForCustomForests, setDatabaseFile, setSubDatabase, setSuperDatabaseName, shouldCreateForests
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecuteSortOrder
public DeployHubDatabaseCommand(HubConfig config, + java.lang.String databaseFilename)+
public java.lang.String toString()+
toString
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.Integer getUndoSortOrder()+
getUndoSortOrder
in interface com.marklogic.appdeployer.command.UndoableCommand
getUndoSortOrder
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
execute
in interface com.marklogic.appdeployer.command.Command
execute
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void undo(com.marklogic.appdeployer.command.CommandContext context)+
undo
in interface com.marklogic.appdeployer.command.UndoableCommand
undo
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String buildPayload(com.marklogic.appdeployer.command.CommandContext context)+
buildPayload
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected java.lang.String getPayload(com.marklogic.appdeployer.command.CommandContext context)+
getPayload
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected com.fasterxml.jackson.databind.JsonNode mergeDatabaseFiles(com.marklogic.appdeployer.AppConfig appConfig)+
protected com.marklogic.appdeployer.command.forests.DeployForestsCommand buildDeployForestsCommand(java.lang.String dbPayload, + com.marklogic.mgmt.SaveReceipt receipt, + com.marklogic.appdeployer.command.CommandContext context)+
buildDeployForestsCommand
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected int determineForestCountPerHost(java.lang.String dbPayload, + com.marklogic.appdeployer.command.CommandContext context)+
determineForestCountPerHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected java.lang.String buildDefaultDatabasePayload(com.marklogic.appdeployer.command.CommandContext context)+
buildDefaultDatabasePayload
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getForestDelete()+
public void setForestDelete(java.lang.String forestDelete)+
public int getForestsPerHost()+
getForestsPerHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setForestsPerHost(int forestsPerHost)+
setForestsPerHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getForestFilename()+
getForestFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setForestFilename(java.lang.String forestFilename)+
setForestFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setUndoSortOrder(int undoSortOrder)+
setUndoSortOrder
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getDatabaseFilename()+
getDatabaseFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setDatabaseFilename(java.lang.String databaseFilename)+
setDatabaseFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public boolean isCreateDatabaseWithoutFile()+
isCreateDatabaseWithoutFile
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setCreateDatabaseWithoutFile(boolean createDatabaseWithoutFile)+
setCreateDatabaseWithoutFile
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getDatabaseName()+
getDatabaseName
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setDatabaseName(java.lang.String databaseName)+
setDatabaseName
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public boolean isCreateForestsOnEachHost()+
isCreateForestsOnEachHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setCreateForestsOnEachHost(boolean createForestsOnEachHost)+
setCreateForestsOnEachHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public class DeployHubDatabasesCommand
+extends com.marklogic.appdeployer.command.AbstractUndoableCommand
++ A key aspect of this class is its attempt to deploy/undeploy databases in the correct order. For each database file + that it finds that's not one of the default ones, a DeployDatabaseCommand will be created. All of those commands will + then be sorted based on the presence of "triggers-database" or "schema-database" within the payload for the command. +
+ If the above strategy doesn't work for you, you can always resort to naming your database files to control the order + that they're processed in. +
payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubDatabasesCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> |
+buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+undo(com.marklogic.appdeployer.command.CommandContext context) |
+
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public DeployHubDatabasesCommand(HubConfig config)+
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
public void undo(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context)+
public class DeployHubMimetypesCommand
+extends com.marklogic.appdeployer.command.mimetypes.DeployMimetypesCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubMimetypesCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
afterResourceSaved, getResourceManager
deleteResource, execute, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public class DeployHubOtherDatabasesCommand
+extends com.marklogic.appdeployer.command.AbstractUndoableCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubOtherDatabasesCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> |
+buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+undo(com.marklogic.appdeployer.command.CommandContext context) |
+
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public DeployHubOtherDatabasesCommand(HubConfig config)+
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
public void undo(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context)+
public class DeployHubRolesCommand
+extends com.marklogic.appdeployer.command.security.DeployRolesCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubRolesCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
adjustPayloadBeforeSavingResource, execute, getResourceManager
afterResourceSaved, deleteResource, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
getUndoSortOrder, setUndoSortOrder
adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public class DeployHubSchemasDatabaseCommand +extends DeployHubDatabaseCommand+
Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DATABASE_FILENAME |
+
payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubSchemasDatabaseCommand(HubConfig hubConfig) |
+
buildDefaultDatabasePayload, buildDeployForestsCommand, buildPayload, determineForestCountPerHost, execute, getDatabaseFilename, getDatabaseName, getForestDelete, getForestFilename, getForestsPerHost, getPayload, getUndoSortOrder, isCreateDatabaseWithoutFile, isCreateForestsOnEachHost, mergeDatabaseFiles, setCreateDatabaseWithoutFile, setCreateForestsOnEachHost, setDatabaseFilename, setDatabaseName, setForestDelete, setForestFilename, setForestsPerHost, setUndoSortOrder, toString, undo
addSubDatabases, buildForest, customForestsExist, getForestDeleteLevel, getSuperDatabaseName, isCheckForCustomForests, isSubDatabase, newDatabaseManageForDeleting, removeSubDatabases, setCheckForCustomForests, setDatabaseFile, setSubDatabase, setSuperDatabaseName, shouldCreateForests
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecuteSortOrder
public static final java.lang.String DATABASE_FILENAME+
public class DeployHubServersCommand
+extends com.marklogic.appdeployer.command.AbstractResourceCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubServersCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected void |
+deleteResource(com.marklogic.mgmt.resource.ResourceManager mgr,
+ com.marklogic.appdeployer.command.CommandContext context,
+ java.io.File f) |
+
protected java.lang.String |
+getPayload(java.io.File f,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
protected com.marklogic.mgmt.resource.ResourceManager |
+getResourceManager(com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.Integer |
+getUndoSortOrder() |
+
protected com.fasterxml.jackson.databind.JsonNode |
+mergeServerFiles(java.io.File f) |
+
protected com.marklogic.mgmt.SaveReceipt |
+saveResource(com.marklogic.mgmt.resource.ResourceManager mgr,
+ com.marklogic.appdeployer.command.CommandContext context,
+ java.io.File f) |
+
afterResourceSaved, execute, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public DeployHubServersCommand(HubConfig config)+
protected java.io.File[] getResourceDirs(com.marklogic.appdeployer.command.CommandContext context)+
getResourceDirs
in class com.marklogic.appdeployer.command.AbstractResourceCommand
protected com.marklogic.mgmt.resource.ResourceManager getResourceManager(com.marklogic.appdeployer.command.CommandContext context)+
getResourceManager
in class com.marklogic.appdeployer.command.AbstractResourceCommand
public java.lang.Integer getUndoSortOrder()+
getUndoSortOrder
in interface com.marklogic.appdeployer.command.UndoableCommand
getUndoSortOrder
in class com.marklogic.appdeployer.command.AbstractUndoableCommand
protected com.marklogic.mgmt.SaveReceipt saveResource(com.marklogic.mgmt.resource.ResourceManager mgr, + com.marklogic.appdeployer.command.CommandContext context, + java.io.File f)+
saveResource
in class com.marklogic.appdeployer.command.AbstractCommand
protected void deleteResource(com.marklogic.mgmt.resource.ResourceManager mgr, + com.marklogic.appdeployer.command.CommandContext context, + java.io.File f)+
deleteResource
in class com.marklogic.appdeployer.command.AbstractResourceCommand
protected java.lang.String getPayload(java.io.File f, + com.marklogic.appdeployer.command.CommandContext context)+
protected com.fasterxml.jackson.databind.JsonNode mergeServerFiles(java.io.File f)+
public class DeployHubTriggersDatabaseCommand +extends DeployHubDatabaseCommand+
Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DATABASE_FILENAME |
+
payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubTriggersDatabaseCommand(HubConfig hubConfig) |
+
buildDefaultDatabasePayload, buildDeployForestsCommand, buildPayload, determineForestCountPerHost, execute, getDatabaseFilename, getDatabaseName, getForestDelete, getForestFilename, getForestsPerHost, getPayload, getUndoSortOrder, isCreateDatabaseWithoutFile, isCreateForestsOnEachHost, mergeDatabaseFiles, setCreateDatabaseWithoutFile, setCreateForestsOnEachHost, setDatabaseFilename, setDatabaseName, setForestDelete, setForestFilename, setForestsPerHost, setUndoSortOrder, toString, undo
addSubDatabases, buildForest, customForestsExist, getForestDeleteLevel, getSuperDatabaseName, isCheckForCustomForests, isSubDatabase, newDatabaseManageForDeleting, removeSubDatabases, setCheckForCustomForests, setDatabaseFile, setSubDatabase, setSuperDatabaseName, shouldCreateForests
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecuteSortOrder
public static final java.lang.String DATABASE_FILENAME+
public class DeployHubUsersCommand
+extends com.marklogic.appdeployer.command.security.DeployUsersCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubUsersCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
getResourceManager
afterResourceSaved, deleteResource, execute, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public class GenerateHubTDETemplateCommand
+extends com.marklogic.appdeployer.command.es.GenerateModelArtifactsCommand
+Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
payloadTokenReplacer
Constructor and Description | +
---|
GenerateHubTDETemplateCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected static java.util.Map<java.lang.String,java.io.File> |
+createEntityNameFileMap(java.util.List<java.io.File> entityFiles) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
protected static java.util.Optional<java.lang.String> |
+extactEntityNameFromFilename(java.lang.String filename) |
+
protected void |
+filterEntities(java.util.Map<java.lang.String,java.io.File> entityNameFileMap) |
+
protected java.util.List<java.io.File> |
+findEntityFiles() |
+
java.lang.String |
+getEntityNames() |
+
void |
+setEntityNames(java.lang.String entityNames) |
+
buildCodeGenerationRequest, fileHasDifferentContent, generateDatabaseProperties, generateExtractionTemplate, generateInstanceConverter, generateSchema, generateSearchOptions, loadModelDefinition, loadModelDefinition, removeGeneratedAtTimestamp, selectModulesDir, setOptionsPath
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public GenerateHubTDETemplateCommand(HubConfig hubConfig)+
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
execute
in interface com.marklogic.appdeployer.command.Command
execute
in class com.marklogic.appdeployer.command.es.GenerateModelArtifactsCommand
public java.lang.String getEntityNames()+
public void setEntityNames(java.lang.String entityNames)+
protected void filterEntities(java.util.Map<java.lang.String,java.io.File> entityNameFileMap)+
protected static java.util.Map<java.lang.String,java.io.File> createEntityNameFileMap(java.util.List<java.io.File> entityFiles)+
protected java.util.List<java.io.File> findEntityFiles()+
protected static java.util.Optional<java.lang.String> extactEntityNameFromFilename(java.lang.String filename)+
public class LoadHubModulesCommand
+extends com.marklogic.appdeployer.command.AbstractCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
LoadHubModulesCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class LoadUserModulesCommand
+extends com.marklogic.appdeployer.command.AbstractCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
LoadUserModulesCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+setForceLoad(boolean forceLoad) |
+
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
DeployHubDatabaseCommand | +
+ Can be used for creating any kind of database with any sorts of forests.
+ |
+
DeployHubDatabasesCommand | +
+ This commands handles deploying/undeploying every database file except the "default" ones of content-database.json,
+ triggers-database.json, and schemas-database.json.
+ |
+
DeployHubMimetypesCommand | ++ |
DeployHubOtherDatabasesCommand | ++ |
DeployHubRolesCommand | ++ |
DeployHubSchemasDatabaseCommand | ++ |
DeployHubServersCommand | ++ |
DeployHubTriggersDatabaseCommand | ++ |
DeployHubUsersCommand | ++ |
GenerateHubTDETemplateCommand | ++ |
LoadHubModulesCommand | ++ |
LoadUserModulesCommand | ++ |
Class | +Description | +
---|---|
HubAppDeployer | ++ |
public interface HubDeployStatusListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+onError() |
+
void |
+onStatusChange(int percentComplete,
+ java.lang.String message) |
+
public class HubFileFilter
+extends java.lang.Object
+implements java.io.FileFilter
+Constructor and Description | +
---|
HubFileFilter() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+accept(java.io.File f) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Interface | +Description | +
---|---|
HubDeployStatusListener | ++ |
Class | +Description | +
---|---|
HubFileFilter | +
+ Simple implementation that accepts every file and ignores anything starting with ".".
+ |
+
public abstract class AbstractEntity +extends java.lang.Object +implements Entity+
Constructor and Description | +
---|
AbstractEntity(org.w3c.dom.Element xml) |
+
AbstractEntity(java.lang.String name) |
+
Modifier and Type | +Method and Description | +
---|---|
java.util.List<Flow> |
+getFlows()
+Returns the entity's flows
+ |
+
java.lang.String |
+getName()
+Returns the name of the Entity
+ |
+
java.lang.String |
+serialize()
+Serializes the entity to an XML string
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public AbstractEntity(org.w3c.dom.Element xml)+
public AbstractEntity(java.lang.String name)+
public interface Entity
+Modifier and Type | +Method and Description | +
---|---|
java.util.List<Flow> |
+getFlows()
+Returns all flows registered to the entity
+ |
+
java.lang.String |
+getName()
+Gets the Entity name
+ |
+
java.lang.String |
+serialize()
+Serializes the Entity as an XML string
+ |
+
java.lang.String getName()+
java.lang.String serialize()+
java.util.List<Flow> getFlows()+
public class EntityImpl +extends AbstractEntity+
Constructor and Description | +
---|
EntityImpl(org.w3c.dom.Element xml) |
+
EntityImpl(java.lang.String name) |
+
Interface | +Description | +
---|---|
Entity | +
+ A entity object.
+ |
+
Class | +Description | +
---|---|
AbstractEntity | +
+ Abstract Base class for entities
+ |
+
EntityImpl | +
+ An implementation of the Entity base class
+ |
+
public class CantUpgradeException
+extends java.lang.Exception
+Constructor and Description | +
---|
CantUpgradeException(java.lang.String version,
+ java.lang.String minVersion) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class LegacyFlowsException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
LegacyFlowsException(java.util.List<java.lang.String> legacyFlows) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class ScaffoldingValidationException
+extends java.lang.Exception
+Constructor and Description | +
---|
ScaffoldingValidationException(java.lang.String message) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class ServerValidationException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
ServerValidationException(java.lang.String message) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Exception | +Description | +
---|---|
CantUpgradeException | ++ |
LegacyFlowsException | ++ |
ScaffoldingValidationException | ++ |
ServerValidationException | ++ |
public enum CodeFormat +extends java.lang.Enum<CodeFormat>+
Enum Constant and Description | +
---|
JAVASCRIPT |
+
XQUERY |
+
Modifier and Type | +Method and Description | +
---|---|
static CodeFormat |
+getCodeFormat(java.lang.String format) |
+
java.lang.String |
+toString() |
+
static CodeFormat |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static CodeFormat[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final CodeFormat JAVASCRIPT+
public static final CodeFormat XQUERY+
public static CodeFormat[] values()+
+for (CodeFormat c : CodeFormat.values()) + System.out.println(c); +
public static CodeFormat valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static CodeFormat getCodeFormat(java.lang.String format)+
public java.lang.String toString()+
toString
in class java.lang.Enum<CodeFormat>
public enum DataFormat +extends java.lang.Enum<DataFormat>+
Enum Constant and Description | +
---|
JSON |
+
XML |
+
Modifier and Type | +Method and Description | +
---|---|
static DataFormat |
+getDataFormat(java.lang.String type) |
+
java.lang.String |
+toString() |
+
static DataFormat |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static DataFormat[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final DataFormat XML+
public static final DataFormat JSON+
public static DataFormat[] values()+
+for (DataFormat c : DataFormat.values()) + System.out.println(c); +
public static DataFormat valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static DataFormat getDataFormat(java.lang.String type)+
public java.lang.String toString()+
toString
in class java.lang.Enum<DataFormat>
public interface Flow
+Modifier and Type | +Method and Description | +
---|---|
CodeFormat |
+getCodeFormat() |
+
Collector |
+getCollector() |
+
DataFormat |
+getDataFormat() |
+
java.lang.String |
+getEntityName() |
+
java.lang.String |
+getFlowDbPath() |
+
MainPlugin |
+getMain() |
+
java.lang.String |
+getName() |
+
FlowType |
+getType() |
+
java.lang.String |
+serialize() |
+
void |
+setCodeFormat(CodeFormat codeFormat) |
+
void |
+setCollector(Collector collector) |
+
void |
+setDataFormat(DataFormat dataFormat) |
+
void |
+setEntityName(java.lang.String entityName) |
+
void |
+setMain(MainPlugin main) |
+
void |
+setName(java.lang.String name) |
+
void |
+setType(FlowType type) |
+
java.util.Properties |
+toProperties() |
+
void setEntityName(java.lang.String entityName)+
java.lang.String getEntityName()+
void setName(java.lang.String name)+
java.lang.String getName()+
void setType(FlowType type)+
FlowType getType()+
void setDataFormat(DataFormat dataFormat)+
DataFormat getDataFormat()+
void setCodeFormat(CodeFormat codeFormat)+
CodeFormat getCodeFormat()+
java.lang.String serialize()+
java.util.Properties toProperties()+
java.lang.String getFlowDbPath()+
Collector getCollector()+
void setCollector(Collector collector)+
MainPlugin getMain()+
void setMain(MainPlugin main)+
public class FlowBuilder
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
Flow |
+build() |
+
static FlowBuilder |
+newFlow() |
+
FlowBuilder |
+withCodeFormat(CodeFormat codeFormat) |
+
FlowBuilder |
+withCollector(Collector collector) |
+
FlowBuilder |
+withDataFormat(DataFormat dataFormat) |
+
FlowBuilder |
+withEntityName(java.lang.String entityName) |
+
FlowBuilder |
+withMain(MainPlugin main) |
+
FlowBuilder |
+withName(java.lang.String flowName) |
+
FlowBuilder |
+withType(FlowType type) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static FlowBuilder newFlow()+
public FlowBuilder withName(java.lang.String flowName)+
public FlowBuilder withEntityName(java.lang.String entityName)+
public FlowBuilder withType(FlowType type)+
public FlowBuilder withDataFormat(DataFormat dataFormat)+
public FlowBuilder withCodeFormat(CodeFormat codeFormat)+
public FlowBuilder withCollector(Collector collector)+
public FlowBuilder withMain(MainPlugin main)+
public Flow build()+
public interface FlowFinishedListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+onFlowFinished() |
+
public interface FlowItemCompleteListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+processCompletion(java.lang.String jobId,
+ java.lang.String itemId) |
+
public interface FlowItemFailureListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+processFailure(java.lang.String jobId,
+ java.lang.String itemId) |
+
public interface FlowRunner
+Modifier and Type | +Method and Description | +
---|---|
void |
+awaitCompletion()
+Blocks until the job is complete.
+ |
+
void |
+awaitCompletion(long timeout,
+ java.util.concurrent.TimeUnit unit)
+Blocks until the job is complete.
+ |
+
FlowRunner |
+onFinished(FlowFinishedListener listener) |
+
FlowRunner |
+onItemComplete(FlowItemCompleteListener listener) |
+
FlowRunner |
+onItemFailed(FlowItemFailureListener listener) |
+
FlowRunner |
+onStatusChanged(FlowStatusListener listener) |
+
com.marklogic.client.datamovement.JobTicket |
+run() |
+
FlowRunner |
+withBatchSize(int batchSize) |
+
FlowRunner |
+withDestinationDatabase(java.lang.String destinationDatabase) |
+
FlowRunner |
+withFlow(Flow flow) |
+
FlowRunner |
+withOptions(java.util.Map<java.lang.String,java.lang.Object> options) |
+
FlowRunner |
+withSourceClient(com.marklogic.client.DatabaseClient sourceClient) |
+
FlowRunner |
+withStopOnFailure(boolean stopOnFailure) |
+
FlowRunner |
+withThreadCount(int threadCount) |
+
FlowRunner withFlow(Flow flow)+
FlowRunner withBatchSize(int batchSize)+
FlowRunner withThreadCount(int threadCount)+
FlowRunner withSourceClient(com.marklogic.client.DatabaseClient sourceClient)+
FlowRunner withDestinationDatabase(java.lang.String destinationDatabase)+
FlowRunner withOptions(java.util.Map<java.lang.String,java.lang.Object> options)+
FlowRunner withStopOnFailure(boolean stopOnFailure)+
FlowRunner onItemComplete(FlowItemCompleteListener listener)+
FlowRunner onItemFailed(FlowItemFailureListener listener)+
FlowRunner onStatusChanged(FlowStatusListener listener)+
FlowRunner onFinished(FlowFinishedListener listener)+
void awaitCompletion()+
void awaitCompletion(long timeout, + java.util.concurrent.TimeUnit unit) + throws java.lang.InterruptedException+
timeout
- the maximum time to waitunit
- the time unit of the timeout argumentjava.lang.InterruptedException
- if interrupted while waitingcom.marklogic.client.datamovement.JobTicket run()+
public interface FlowStatusListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+onStatusChange(java.lang.String jobId,
+ int percentComplete,
+ java.lang.String message) |
+
Enum Constant and Description | +
---|
HARMONIZE |
+
INPUT |
+
Modifier and Type | +Method and Description | +
---|---|
static FlowType |
+getFlowType(java.lang.String type) |
+
java.lang.String |
+toString() |
+
static FlowType |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static FlowType[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final FlowType INPUT+
public static final FlowType HARMONIZE+
public static FlowType[] values()+
+for (FlowType c : FlowType.values()) + System.out.println(c); +
public static FlowType valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static FlowType getFlowType(java.lang.String type)+
public java.lang.String toString()+
toString
in class java.lang.Enum<FlowType>
public class RunFlowResponse
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
java.util.List<java.lang.String> |
+completedItems |
+
long |
+errorCount |
+
java.util.List<com.fasterxml.jackson.databind.JsonNode> |
+errors |
+
java.util.List<java.lang.String> |
+failedItems |
+
long |
+totalCount |
+
Constructor and Description | +
---|
RunFlowResponse() |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+toString() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public long totalCount+
public long errorCount+
public java.util.List<java.lang.String> completedItems+
public java.util.List<java.lang.String> failedItems+
public java.util.List<com.fasterxml.jackson.databind.JsonNode> errors+
Modifier and Type | +Method and Description | +
---|---|
static Flow |
+fromXml(org.w3c.dom.Node xml) |
+
CodeFormat |
+getCodeFormat() |
+
Collector |
+getCollector() |
+
DataFormat |
+getDataFormat() |
+
java.lang.String |
+getEntityName() |
+
java.lang.String |
+getFlowDbPath() |
+
MainPlugin |
+getMain() |
+
java.lang.String |
+getName() |
+
FlowType |
+getType() |
+
static Flow |
+loadFromFile(java.io.File file) |
+
java.lang.String |
+serialize()
+Serializes the flow into an xml string
+ |
+
void |
+setCodeFormat(CodeFormat codeFormat) |
+
void |
+setCollector(Collector collector) |
+
void |
+setDataFormat(DataFormat dataFormat) |
+
void |
+setEntityName(java.lang.String entityName) |
+
void |
+setMain(MainPlugin main) |
+
void |
+setName(java.lang.String name) |
+
void |
+setType(FlowType type) |
+
java.util.Properties |
+toProperties() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public void setEntityName(java.lang.String entityName)+
setEntityName
in interface Flow
public java.lang.String getEntityName()+
getEntityName
in interface Flow
public void setName(java.lang.String name)+ +
public void setDataFormat(DataFormat dataFormat)+
setDataFormat
in interface Flow
public DataFormat getDataFormat()+
getDataFormat
in interface Flow
public void setCodeFormat(CodeFormat codeFormat)+
setCodeFormat
in interface Flow
public CodeFormat getCodeFormat()+
getCodeFormat
in interface Flow
public Collector getCollector()+
getCollector
in interface Flow
public void setCollector(Collector collector)+
setCollector
in interface Flow
public MainPlugin getMain()+ +
public void setMain(MainPlugin main)+ +
public java.lang.String serialize()+
public java.util.Properties toProperties()+
toProperties
in interface Flow
public static Flow loadFromFile(java.io.File file)+
public static Flow fromXml(org.w3c.dom.Node xml)+
public java.lang.String getFlowDbPath()+
getFlowDbPath
in interface Flow
public class FlowRunnerImpl +extends java.lang.Object +implements FlowRunner+
Constructor and Description | +
---|
FlowRunnerImpl(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+awaitCompletion()
+Blocks until the job is complete.
+ |
+
void |
+awaitCompletion(long timeout,
+ java.util.concurrent.TimeUnit unit)
+Blocks until the job is complete.
+ |
+
FlowRunner |
+onFinished(FlowFinishedListener listener) |
+
FlowRunner |
+onItemComplete(FlowItemCompleteListener listener) |
+
FlowRunner |
+onItemFailed(FlowItemFailureListener listener) |
+
FlowRunner |
+onStatusChanged(FlowStatusListener listener) |
+
com.marklogic.client.datamovement.JobTicket |
+run() |
+
FlowRunner |
+withBatchSize(int batchSize) |
+
FlowRunner |
+withDestinationDatabase(java.lang.String destinationDatabase) |
+
FlowRunner |
+withFlow(Flow flow) |
+
FlowRunner |
+withOptions(java.util.Map<java.lang.String,java.lang.Object> options) |
+
FlowRunner |
+withSourceClient(com.marklogic.client.DatabaseClient sourceClient) |
+
FlowRunner |
+withStopOnFailure(boolean stopOnFailure) |
+
FlowRunner |
+withThreadCount(int threadCount) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public FlowRunnerImpl(HubConfig hubConfig)+
public FlowRunner withFlow(Flow flow)+
withFlow
in interface FlowRunner
public FlowRunner withBatchSize(int batchSize)+
withBatchSize
in interface FlowRunner
public FlowRunner withThreadCount(int threadCount)+
withThreadCount
in interface FlowRunner
public FlowRunner withSourceClient(com.marklogic.client.DatabaseClient sourceClient)+
withSourceClient
in interface FlowRunner
public FlowRunner withDestinationDatabase(java.lang.String destinationDatabase)+
withDestinationDatabase
in interface FlowRunner
public FlowRunner withStopOnFailure(boolean stopOnFailure)+
withStopOnFailure
in interface FlowRunner
public FlowRunner withOptions(java.util.Map<java.lang.String,java.lang.Object> options)+
withOptions
in interface FlowRunner
public FlowRunner onItemComplete(FlowItemCompleteListener listener)+
onItemComplete
in interface FlowRunner
public FlowRunner onItemFailed(FlowItemFailureListener listener)+
onItemFailed
in interface FlowRunner
public FlowRunner onStatusChanged(FlowStatusListener listener)+
onStatusChanged
in interface FlowRunner
public FlowRunner onFinished(FlowFinishedListener listener)+
onFinished
in interface FlowRunner
public void awaitCompletion()+
FlowRunner
awaitCompletion
in interface FlowRunner
public void awaitCompletion(long timeout, + java.util.concurrent.TimeUnit unit) + throws java.lang.InterruptedException+
FlowRunner
awaitCompletion
in interface FlowRunner
timeout
- the maximum time to waitunit
- the time unit of the timeout argumentjava.lang.InterruptedException
- if interrupted while waitingpublic com.marklogic.client.datamovement.JobTicket run()+
run
in interface FlowRunner
Class | +Description | +
---|---|
FlowImpl | ++ |
FlowRunnerImpl | ++ |
Interface | +Description | +
---|---|
Flow | ++ |
FlowFinishedListener | ++ |
FlowItemCompleteListener | ++ |
FlowItemFailureListener | ++ |
FlowRunner | ++ |
FlowStatusListener | ++ |
Class | +Description | +
---|---|
FlowBuilder | ++ |
RunFlowResponse | ++ |
Enum | +Description | +
---|---|
CodeFormat | ++ |
DataFormat | ++ |
FlowType | ++ |
Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
DEFAULT_AUTH_METHOD, DEFAULT_CUSTOM_FOREST_PATH, DEFAULT_FINAL_NAME, DEFAULT_FINAL_PORT, DEFAULT_FORESTS_PER_HOST, DEFAULT_JOB_NAME, DEFAULT_JOB_PORT, DEFAULT_MODULES_DB_NAME, DEFAULT_ROLE_NAME, DEFAULT_SCHEMAS_DB_NAME, DEFAULT_SCHEME, DEFAULT_STAGING_NAME, DEFAULT_STAGING_PORT, DEFAULT_TRACE_NAME, DEFAULT_TRACE_PORT, DEFAULT_TRIGGERS_DB_NAME, DEFAULT_USER_NAME, ENTITY_CONFIG_DIR, FINAL_ENTITY_SEARCH_OPTIONS_FILE, HUB_CONFIG_DIR, HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES, STAGING_ENTITY_SEARCH_OPTIONS_FILE, USER_CONFIG_DIR, USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES, USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
Constructor and Description | +
---|
HubConfigImpl() |
+
HubConfigImpl(java.lang.String projectDir) |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.mgmt.admin.AdminConfig |
+getAdminConfig() |
+
com.marklogic.mgmt.admin.AdminManager |
+getAdminManager() |
+
com.marklogic.appdeployer.AppConfig |
+getAppConfig() |
+
java.lang.String |
+getCustomForestPath() |
+
java.nio.file.Path |
+getEntityDatabaseDir() |
+
java.lang.String |
+getFinalAuthMethod() |
+
java.lang.String |
+getFinalCertFile() |
+
java.lang.String |
+getFinalCertPassword() |
+
java.lang.String |
+getFinalDbName() |
+
java.lang.String |
+getFinalExternalName() |
+
java.lang.Integer |
+getFinalForestsPerHost() |
+
java.lang.String |
+getFinalHttpName() |
+
java.lang.Integer |
+getFinalPort() |
+
java.lang.String |
+getFinalScheme() |
+
boolean |
+getFinalSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getFinalSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getFinalSslHostnameVerifier() |
+
java.lang.String |
+getHost() |
+
java.nio.file.Path |
+getHubConfigDir() |
+
java.nio.file.Path |
+getHubDatabaseDir() |
+
java.nio.file.Path |
+getHubEntitiesDir() |
+
java.nio.file.Path |
+getHubMimetypesDir() |
+
java.lang.String |
+getHubModulesDeployTimestampFile() |
+
java.nio.file.Path |
+getHubPluginsDir() |
+
HubProject |
+getHubProject() |
+
java.lang.String |
+getHubRoleName() |
+
java.nio.file.Path |
+getHubSecurityDir() |
+
java.nio.file.Path |
+getHubServersDir() |
+
java.lang.String |
+getHubUserName() |
+
java.lang.String |
+getJarVersion() |
+
java.lang.String |
+getJobAuthMethod() |
+
java.lang.String |
+getJobCertFile() |
+
java.lang.String |
+getJobCertPassword() |
+
java.lang.String |
+getJobDbName() |
+
java.lang.String |
+getJobExternalName() |
+
java.lang.Integer |
+getJobForestsPerHost() |
+
java.lang.String |
+getJobHttpName() |
+
java.lang.Integer |
+getJobPort() |
+
java.lang.String |
+getJobScheme() |
+
boolean |
+getJobSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getJobSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getJobSslHostnameVerifier() |
+
java.lang.String[] |
+getLoadBalancerHosts() |
+
com.marklogic.mgmt.ManageClient |
+getManageClient() |
+
com.marklogic.mgmt.ManageConfig |
+getManageConfig() |
+
java.lang.String |
+getModulePermissions() |
+
java.lang.String |
+getModulesDbName() |
+
java.lang.Integer |
+getModulesForestsPerHost() |
+
java.lang.String |
+getProjectDir() |
+
java.lang.String |
+getSchemasDbName() |
+
java.lang.Integer |
+getSchemasForestsPerHost() |
+
java.lang.String |
+getStagingAuthMethod() |
+
java.lang.String |
+getStagingCertFile() |
+
java.lang.String |
+getStagingCertPassword() |
+
java.lang.String |
+getStagingDbName() |
+
java.lang.String |
+getStagingExternalName() |
+
java.lang.Integer |
+getStagingForestsPerHost() |
+
java.lang.String |
+getStagingHttpName() |
+
java.lang.Integer |
+getStagingPort() |
+
java.lang.String |
+getStagingScheme() |
+
boolean |
+getStagingSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getStagingSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getStagingSslHostnameVerifier() |
+
java.lang.String |
+getTraceAuthMethod() |
+
java.lang.String |
+getTraceCertFile() |
+
java.lang.String |
+getTraceCertPassword() |
+
java.lang.String |
+getTraceDbName() |
+
java.lang.String |
+getTraceExternalName() |
+
java.lang.Integer |
+getTraceForestsPerHost() |
+
java.lang.String |
+getTraceHttpName() |
+
java.lang.Integer |
+getTracePort() |
+
java.lang.String |
+getTraceScheme() |
+
boolean |
+getTraceSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getTraceSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getTraceSslHostnameVerifier() |
+
java.lang.String |
+getTriggersDbName() |
+
java.lang.Integer |
+getTriggersForestsPerHost() |
+
java.nio.file.Path |
+getUserConfigDir() |
+
java.io.File |
+getUserContentDeployTimestampFile() |
+
java.nio.file.Path |
+getUserDatabaseDir() |
+
java.lang.String |
+getUserModulesDeployTimestampFile() |
+
java.nio.file.Path |
+getUserSecurityDir() |
+
java.nio.file.Path |
+getUserServersDir() |
+
void |
+initHubProject() |
+
void |
+loadConfigurationFromProperties(java.util.Properties environmentProperties) |
+
com.marklogic.client.DatabaseClient |
+newAppServicesClient() |
+
com.marklogic.client.DatabaseClient |
+newFinalClient()
+Creates a new DatabaseClient for accessing the Final database
+ |
+
com.marklogic.client.DatabaseClient |
+newJobDbClient()
+Creates a new DatabaseClient for accessing the Job database
+ |
+
com.marklogic.client.DatabaseClient |
+newModulesDbClient()
+Creates a new DatabaseClient for accessing the Hub Modules database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient()
+Creates a new DatabaseClient for accessing the Staging database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient(java.lang.String databaseName) |
+
com.marklogic.client.DatabaseClient |
+newTraceDbClient()
+Creates a new DatabaseClient for accessing the Trace database
+ |
+
void |
+setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig) |
+
void |
+setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager) |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config) |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config,
+ boolean skipUpdate) |
+
void |
+setCustomForestPath(java.lang.String customForestPath) |
+
void |
+setFinalAuthMethod(java.lang.String finalAuthMethod) |
+
void |
+setFinalCertFile(java.lang.String finalCertFile) |
+
void |
+setFinalCertPassword(java.lang.String finalCertPassword) |
+
void |
+setFinalDbName(java.lang.String finalDbName) |
+
void |
+setFinalExternalName(java.lang.String finalExternalName) |
+
void |
+setFinalForestsPerHost(java.lang.Integer finalForestsPerHost) |
+
void |
+setFinalHttpName(java.lang.String finalHttpName) |
+
void |
+setFinalPort(java.lang.Integer finalPort) |
+
void |
+setFinalScheme(java.lang.String finalScheme) |
+
void |
+setFinalSimpleSsl(boolean finalSimpleSsl) |
+
void |
+setFinalSslContext(javax.net.ssl.SSLContext finalSslContext) |
+
void |
+setFinalSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier finalSslHostnameVerifier) |
+
void |
+setHubRoleName(java.lang.String hubRoleName) |
+
void |
+setHubUserName(java.lang.String hubUserName) |
+
void |
+setJobAuthMethod(java.lang.String jobAuthMethod) |
+
void |
+setJobCertFile(java.lang.String jobCertFile) |
+
void |
+setJobCertPassword(java.lang.String jobCertPassword) |
+
void |
+setJobDbName(java.lang.String jobDbName) |
+
void |
+setJobExternalName(java.lang.String jobExternalName) |
+
void |
+setJobForestsPerHost(java.lang.Integer jobForestsPerHost) |
+
void |
+setJobHttpName(java.lang.String jobHttpName) |
+
void |
+setJobPort(java.lang.Integer jobPort) |
+
void |
+setJobScheme(java.lang.String jobScheme) |
+
void |
+setJobSimpleSsl(boolean jobSimpleSsl) |
+
void |
+setJobSslContext(javax.net.ssl.SSLContext jobSslContext) |
+
void |
+setJobSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier jobSslHostnameVerifier) |
+
void |
+setLoadBalancerHosts(java.lang.String[] loadBalancerHosts) |
+
void |
+setManageClient(com.marklogic.mgmt.ManageClient manageClient) |
+
void |
+setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig) |
+
void |
+setModulePermissions(java.lang.String modulePermissions) |
+
void |
+setModulesDbName(java.lang.String modulesDbName) |
+
void |
+setModulesForestsPerHost(java.lang.Integer modulesForestsPerHost) |
+
void |
+setProjectDir(java.lang.String projectDir) |
+
void |
+setSchemasDbName(java.lang.String schemasDbName) |
+
void |
+setSchemasForestsPerHost(java.lang.Integer schemasForestsPerHost) |
+
void |
+setStagingAuthMethod(java.lang.String stagingAuthMethod) |
+
void |
+setStagingCertFile(java.lang.String stagingCertFile) |
+
void |
+setStagingCertPassword(java.lang.String stagingCertPassword) |
+
void |
+setStagingDbName(java.lang.String stagingDbName) |
+
void |
+setStagingExternalName(java.lang.String stagingExternalName) |
+
void |
+setStagingForestsPerHost(java.lang.Integer stagingForestsPerHost) |
+
void |
+setStagingHttpName(java.lang.String stagingHttpName) |
+
void |
+setStagingPort(java.lang.Integer stagingPort) |
+
void |
+setStagingScheme(java.lang.String stagingScheme) |
+
void |
+setStagingSimpleSsl(boolean stagingSimpleSsl) |
+
void |
+setStagingSslContext(javax.net.ssl.SSLContext stagingSslContext) |
+
void |
+setStagingSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier) |
+
void |
+setTraceAuthMethod(java.lang.String traceAuthMethod) |
+
void |
+setTraceCertFile(java.lang.String traceCertFile) |
+
void |
+setTraceCertPassword(java.lang.String traceCertPassword) |
+
void |
+setTraceDbName(java.lang.String traceDbName) |
+
void |
+setTraceExternalName(java.lang.String traceExternalName) |
+
void |
+setTraceForestsPerHost(java.lang.Integer traceForestsPerHost) |
+
void |
+setTraceHttpName(java.lang.String traceHttpName) |
+
void |
+setTracePort(java.lang.Integer tracePort) |
+
void |
+setTraceScheme(java.lang.String traceScheme) |
+
void |
+setTraceSimpleSsl(boolean traceSimpleSsl) |
+
void |
+setTraceSslContext(javax.net.ssl.SSLContext traceSslContext) |
+
void |
+setTraceSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier traceSslHostnameVerifier) |
+
void |
+setTriggersDbName(java.lang.String triggersDbName) |
+
void |
+setTriggersForestsPerHost(java.lang.Integer triggersForestsPerHost) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public HubConfigImpl(java.lang.String projectDir)+
public HubConfigImpl()+
public java.lang.String getHost()+ +
public java.lang.String getStagingDbName()+
getStagingDbName
in interface HubConfig
public void setStagingDbName(java.lang.String stagingDbName)+
setStagingDbName
in interface HubConfig
public java.lang.String getStagingHttpName()+
getStagingHttpName
in interface HubConfig
public void setStagingHttpName(java.lang.String stagingHttpName)+
setStagingHttpName
in interface HubConfig
public java.lang.Integer getStagingForestsPerHost()+
getStagingForestsPerHost
in interface HubConfig
public void setStagingForestsPerHost(java.lang.Integer stagingForestsPerHost)+
setStagingForestsPerHost
in interface HubConfig
public java.lang.Integer getStagingPort()+
getStagingPort
in interface HubConfig
public void setStagingPort(java.lang.Integer stagingPort)+
setStagingPort
in interface HubConfig
public java.lang.String getStagingAuthMethod()+
getStagingAuthMethod
in interface HubConfig
public void setStagingAuthMethod(java.lang.String stagingAuthMethod)+
setStagingAuthMethod
in interface HubConfig
public java.lang.String getStagingScheme()+
getStagingScheme
in interface HubConfig
public void setStagingScheme(java.lang.String stagingScheme)+
setStagingScheme
in interface HubConfig
public boolean getStagingSimpleSsl()+
getStagingSimpleSsl
in interface HubConfig
public void setStagingSimpleSsl(boolean stagingSimpleSsl)+
setStagingSimpleSsl
in interface HubConfig
public javax.net.ssl.SSLContext getStagingSslContext()+
getStagingSslContext
in interface HubConfig
public void setStagingSslContext(javax.net.ssl.SSLContext stagingSslContext)+
setStagingSslContext
in interface HubConfig
public com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getStagingSslHostnameVerifier()+
getStagingSslHostnameVerifier
in interface HubConfig
public void setStagingSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier)+
setStagingSslHostnameVerifier
in interface HubConfig
public java.lang.String getStagingCertFile()+
getStagingCertFile
in interface HubConfig
public void setStagingCertFile(java.lang.String stagingCertFile)+
setStagingCertFile
in interface HubConfig
public java.lang.String getStagingCertPassword()+
getStagingCertPassword
in interface HubConfig
public void setStagingCertPassword(java.lang.String stagingCertPassword)+
setStagingCertPassword
in interface HubConfig
public java.lang.String getStagingExternalName()+
getStagingExternalName
in interface HubConfig
public void setStagingExternalName(java.lang.String stagingExternalName)+
setStagingExternalName
in interface HubConfig
public java.lang.String getFinalDbName()+
getFinalDbName
in interface HubConfig
public void setFinalDbName(java.lang.String finalDbName)+
setFinalDbName
in interface HubConfig
public java.lang.String getFinalHttpName()+
getFinalHttpName
in interface HubConfig
public void setFinalHttpName(java.lang.String finalHttpName)+
setFinalHttpName
in interface HubConfig
public java.lang.Integer getFinalForestsPerHost()+
getFinalForestsPerHost
in interface HubConfig
public void setFinalForestsPerHost(java.lang.Integer finalForestsPerHost)+
setFinalForestsPerHost
in interface HubConfig
public java.lang.Integer getFinalPort()+
getFinalPort
in interface HubConfig
public void setFinalPort(java.lang.Integer finalPort)+
setFinalPort
in interface HubConfig
public java.lang.String getFinalAuthMethod()+
getFinalAuthMethod
in interface HubConfig
public void setFinalAuthMethod(java.lang.String finalAuthMethod)+
setFinalAuthMethod
in interface HubConfig
public java.lang.String getFinalScheme()+
getFinalScheme
in interface HubConfig
public void setFinalScheme(java.lang.String finalScheme)+
setFinalScheme
in interface HubConfig
public boolean getFinalSimpleSsl()+
getFinalSimpleSsl
in interface HubConfig
public void setFinalSimpleSsl(boolean finalSimpleSsl)+
setFinalSimpleSsl
in interface HubConfig
public javax.net.ssl.SSLContext getFinalSslContext()+
getFinalSslContext
in interface HubConfig
public void setFinalSslContext(javax.net.ssl.SSLContext finalSslContext)+
setFinalSslContext
in interface HubConfig
public com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getFinalSslHostnameVerifier()+
getFinalSslHostnameVerifier
in interface HubConfig
public void setFinalSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier finalSslHostnameVerifier)+
setFinalSslHostnameVerifier
in interface HubConfig
public java.lang.String getFinalCertFile()+
getFinalCertFile
in interface HubConfig
public void setFinalCertFile(java.lang.String finalCertFile)+
setFinalCertFile
in interface HubConfig
public java.lang.String getFinalCertPassword()+
getFinalCertPassword
in interface HubConfig
public void setFinalCertPassword(java.lang.String finalCertPassword)+
setFinalCertPassword
in interface HubConfig
public java.lang.String getFinalExternalName()+
getFinalExternalName
in interface HubConfig
public void setFinalExternalName(java.lang.String finalExternalName)+
setFinalExternalName
in interface HubConfig
public java.lang.String getTraceDbName()+
getTraceDbName
in interface HubConfig
public void setTraceDbName(java.lang.String traceDbName)+
setTraceDbName
in interface HubConfig
public java.lang.String getTraceHttpName()+
getTraceHttpName
in interface HubConfig
public void setTraceHttpName(java.lang.String traceHttpName)+
setTraceHttpName
in interface HubConfig
public java.lang.Integer getTraceForestsPerHost()+
getTraceForestsPerHost
in interface HubConfig
public void setTraceForestsPerHost(java.lang.Integer traceForestsPerHost)+
setTraceForestsPerHost
in interface HubConfig
public java.lang.Integer getTracePort()+
getTracePort
in interface HubConfig
public void setTracePort(java.lang.Integer tracePort)+
setTracePort
in interface HubConfig
public java.lang.String getTraceAuthMethod()+
getTraceAuthMethod
in interface HubConfig
public void setTraceAuthMethod(java.lang.String traceAuthMethod)+
setTraceAuthMethod
in interface HubConfig
public java.lang.String getTraceScheme()+
getTraceScheme
in interface HubConfig
public void setTraceScheme(java.lang.String traceScheme)+
setTraceScheme
in interface HubConfig
public boolean getTraceSimpleSsl()+
getTraceSimpleSsl
in interface HubConfig
public void setTraceSimpleSsl(boolean traceSimpleSsl)+
setTraceSimpleSsl
in interface HubConfig
public javax.net.ssl.SSLContext getTraceSslContext()+
getTraceSslContext
in interface HubConfig
public void setTraceSslContext(javax.net.ssl.SSLContext traceSslContext)+
setTraceSslContext
in interface HubConfig
public com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getTraceSslHostnameVerifier()+
getTraceSslHostnameVerifier
in interface HubConfig
public void setTraceSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier traceSslHostnameVerifier)+
setTraceSslHostnameVerifier
in interface HubConfig
public java.lang.String getTraceCertFile()+
getTraceCertFile
in interface HubConfig
public void setTraceCertFile(java.lang.String traceCertFile)+
setTraceCertFile
in interface HubConfig
public java.lang.String getTraceCertPassword()+
getTraceCertPassword
in interface HubConfig
public void setTraceCertPassword(java.lang.String traceCertPassword)+
setTraceCertPassword
in interface HubConfig
public java.lang.String getTraceExternalName()+
getTraceExternalName
in interface HubConfig
public void setTraceExternalName(java.lang.String traceExternalName)+
setTraceExternalName
in interface HubConfig
public java.lang.String getJobDbName()+
getJobDbName
in interface HubConfig
public void setJobDbName(java.lang.String jobDbName)+
setJobDbName
in interface HubConfig
public java.lang.String getJobHttpName()+
getJobHttpName
in interface HubConfig
public void setJobHttpName(java.lang.String jobHttpName)+
setJobHttpName
in interface HubConfig
public java.lang.Integer getJobForestsPerHost()+
getJobForestsPerHost
in interface HubConfig
public void setJobForestsPerHost(java.lang.Integer jobForestsPerHost)+
setJobForestsPerHost
in interface HubConfig
public java.lang.Integer getJobPort()+
getJobPort
in interface HubConfig
public void setJobPort(java.lang.Integer jobPort)+
setJobPort
in interface HubConfig
public java.lang.String getJobAuthMethod()+
getJobAuthMethod
in interface HubConfig
public void setJobAuthMethod(java.lang.String jobAuthMethod)+
setJobAuthMethod
in interface HubConfig
public java.lang.String getJobScheme()+
getJobScheme
in interface HubConfig
public void setJobScheme(java.lang.String jobScheme)+
setJobScheme
in interface HubConfig
public boolean getJobSimpleSsl()+
getJobSimpleSsl
in interface HubConfig
public void setJobSimpleSsl(boolean jobSimpleSsl)+
setJobSimpleSsl
in interface HubConfig
public javax.net.ssl.SSLContext getJobSslContext()+
getJobSslContext
in interface HubConfig
public void setJobSslContext(javax.net.ssl.SSLContext jobSslContext)+
setJobSslContext
in interface HubConfig
public com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getJobSslHostnameVerifier()+
getJobSslHostnameVerifier
in interface HubConfig
public void setJobSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier jobSslHostnameVerifier)+
setJobSslHostnameVerifier
in interface HubConfig
public java.lang.String getJobCertFile()+
getJobCertFile
in interface HubConfig
public void setJobCertFile(java.lang.String jobCertFile)+
setJobCertFile
in interface HubConfig
public java.lang.String getJobCertPassword()+
getJobCertPassword
in interface HubConfig
public void setJobCertPassword(java.lang.String jobCertPassword)+
setJobCertPassword
in interface HubConfig
public java.lang.String getJobExternalName()+
getJobExternalName
in interface HubConfig
public void setJobExternalName(java.lang.String jobExternalName)+
setJobExternalName
in interface HubConfig
public java.lang.String getModulesDbName()+
getModulesDbName
in interface HubConfig
public void setModulesDbName(java.lang.String modulesDbName)+
setModulesDbName
in interface HubConfig
public java.lang.Integer getModulesForestsPerHost()+
getModulesForestsPerHost
in interface HubConfig
public void setModulesForestsPerHost(java.lang.Integer modulesForestsPerHost)+
setModulesForestsPerHost
in interface HubConfig
public java.lang.String getTriggersDbName()+
getTriggersDbName
in interface HubConfig
public void setTriggersDbName(java.lang.String triggersDbName)+
setTriggersDbName
in interface HubConfig
public java.lang.Integer getTriggersForestsPerHost()+
getTriggersForestsPerHost
in interface HubConfig
public void setTriggersForestsPerHost(java.lang.Integer triggersForestsPerHost)+
setTriggersForestsPerHost
in interface HubConfig
public java.lang.String getSchemasDbName()+
getSchemasDbName
in interface HubConfig
public void setSchemasDbName(java.lang.String schemasDbName)+
setSchemasDbName
in interface HubConfig
public java.lang.Integer getSchemasForestsPerHost()+
getSchemasForestsPerHost
in interface HubConfig
public void setSchemasForestsPerHost(java.lang.Integer schemasForestsPerHost)+
setSchemasForestsPerHost
in interface HubConfig
public java.lang.String getHubRoleName()+
getHubRoleName
in interface HubConfig
public void setHubRoleName(java.lang.String hubRoleName)+
setHubRoleName
in interface HubConfig
public java.lang.String getHubUserName()+
getHubUserName
in interface HubConfig
public void setHubUserName(java.lang.String hubUserName)+
setHubUserName
in interface HubConfig
public java.lang.String[] getLoadBalancerHosts()+
getLoadBalancerHosts
in interface HubConfig
public void setLoadBalancerHosts(java.lang.String[] loadBalancerHosts)+
setLoadBalancerHosts
in interface HubConfig
public java.lang.String getCustomForestPath()+
getCustomForestPath
in interface HubConfig
public void setCustomForestPath(java.lang.String customForestPath)+
setCustomForestPath
in interface HubConfig
public java.lang.String getModulePermissions()+
getModulePermissions
in interface HubConfig
public void setModulePermissions(java.lang.String modulePermissions)+
setModulePermissions
in interface HubConfig
public java.lang.String getProjectDir()+
getProjectDir
in interface HubConfig
public void setProjectDir(java.lang.String projectDir)+
setProjectDir
in interface HubConfig
public HubProject getHubProject()+
getHubProject
in interface HubConfig
public void initHubProject()+
initHubProject
in interface HubConfig
public java.lang.String getHubModulesDeployTimestampFile()+
getHubModulesDeployTimestampFile
in interface HubConfig
public java.lang.String getUserModulesDeployTimestampFile()+
getUserModulesDeployTimestampFile
in interface HubConfig
public java.io.File getUserContentDeployTimestampFile()+
getUserContentDeployTimestampFile
in interface HubConfig
public void loadConfigurationFromProperties(java.util.Properties environmentProperties)+
public com.marklogic.mgmt.ManageConfig getManageConfig()+
getManageConfig
in interface HubConfig
public void setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
setManageConfig
in interface HubConfig
public com.marklogic.mgmt.ManageClient getManageClient()+
getManageClient
in interface HubConfig
public void setManageClient(com.marklogic.mgmt.ManageClient manageClient)+
setManageClient
in interface HubConfig
public com.marklogic.mgmt.admin.AdminConfig getAdminConfig()+
getAdminConfig
in interface HubConfig
public void setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
setAdminConfig
in interface HubConfig
public com.marklogic.mgmt.admin.AdminManager getAdminManager()+
getAdminManager
in interface HubConfig
public void setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
setAdminManager
in interface HubConfig
public com.marklogic.client.DatabaseClient newAppServicesClient()+
newAppServicesClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newStagingClient()+
newStagingClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newStagingClient(java.lang.String databaseName)+
newStagingClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newFinalClient()+
newFinalClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newJobDbClient()+
newJobDbClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newTraceDbClient()+
newTraceDbClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newModulesDbClient()+
newModulesDbClient
in interface HubConfig
public java.nio.file.Path getHubPluginsDir()+
getHubPluginsDir
in interface HubConfig
public java.nio.file.Path getHubEntitiesDir()+
getHubEntitiesDir
in interface HubConfig
public java.nio.file.Path getHubConfigDir()+
getHubConfigDir
in interface HubConfig
public java.nio.file.Path getHubDatabaseDir()+
getHubDatabaseDir
in interface HubConfig
public java.nio.file.Path getHubServersDir()+
getHubServersDir
in interface HubConfig
public java.nio.file.Path getHubSecurityDir()+
getHubSecurityDir
in interface HubConfig
public java.nio.file.Path getUserSecurityDir()+
getUserSecurityDir
in interface HubConfig
public java.nio.file.Path getUserConfigDir()+
getUserConfigDir
in interface HubConfig
public java.nio.file.Path getUserDatabaseDir()+
getUserDatabaseDir
in interface HubConfig
public java.nio.file.Path getEntityDatabaseDir()+
getEntityDatabaseDir
in interface HubConfig
public java.nio.file.Path getUserServersDir()+
getUserServersDir
in interface HubConfig
public java.nio.file.Path getHubMimetypesDir()+
getHubMimetypesDir
in interface HubConfig
public com.marklogic.appdeployer.AppConfig getAppConfig()+
getAppConfig
in interface HubConfig
public void setAppConfig(com.marklogic.appdeployer.AppConfig config)+
setAppConfig
in interface HubConfig
public void setAppConfig(com.marklogic.appdeployer.AppConfig config, + boolean skipUpdate)+
setAppConfig
in interface HubConfig
public java.lang.String getJarVersion() + throws java.io.IOException+
getJarVersion
in interface HubConfig
java.io.IOException
Class | +Description | +
---|---|
HubConfigImpl | ++ |
public class Job
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
java.util.Date |
+getEndTime() |
+
java.lang.String |
+getEntityName() |
+
long |
+getFailedBatches() |
+
long |
+getFailedEvents() |
+
java.lang.String |
+getFlowName() |
+
java.lang.String |
+getFlowType() |
+
java.lang.String |
+getJobId() |
+
java.lang.String |
+getJobName() |
+
java.util.List<java.lang.String> |
+getJobOutput() |
+
java.util.Date |
+getStartTime() |
+
JobStatus |
+getStatus() |
+
long |
+getSuccessfulBatches() |
+
long |
+getSuccessfulEvents() |
+
Job |
+setCounts(long successfulEvents,
+ long failedEvents,
+ long successfulBatches,
+ long failedBatches) |
+
Job |
+withEndTime(java.util.Date endTime) |
+
static Job |
+withFlow(Flow flow) |
+
Job |
+withJobId(java.lang.String jobId) |
+
Job |
+withJobName(java.lang.String jobName) |
+
Job |
+withJobOutput(java.util.List<java.lang.String> jobOutput) |
+
Job |
+withJobOutput(java.lang.String jobOutput) |
+
Job |
+withStartTime(java.util.Date startTime) |
+
Job |
+withStatus(JobStatus status) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public Job withJobId(java.lang.String jobId)+
public Job withJobName(java.lang.String jobName)+
public Job withJobOutput(java.util.List<java.lang.String> jobOutput)+
public Job withJobOutput(java.lang.String jobOutput)+
public Job withStartTime(java.util.Date startTime)+
public Job withEndTime(java.util.Date endTime)+
public Job setCounts(long successfulEvents, + long failedEvents, + long successfulBatches, + long failedBatches)+
public java.lang.String getJobId()+
public java.lang.String getFlowType()+
public java.lang.String getFlowName()+
public java.lang.String getEntityName()+
public java.lang.String getJobName()+
public java.util.Date getStartTime()+
public java.util.Date getEndTime()+
public JobStatus getStatus()+
public java.util.List<java.lang.String> getJobOutput()+
public long getSuccessfulEvents()+
public long getFailedEvents()+
public long getSuccessfulBatches()+
public long getFailedBatches()+
public class JobDeleteResponse
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
java.util.List<java.lang.String> |
+deletedJobs |
+
java.util.List<java.lang.String> |
+deletedTraces |
+
long |
+errorCount |
+
java.util.List<com.fasterxml.jackson.databind.JsonNode> |
+errors |
+
java.util.List<java.lang.String> |
+failedJobs |
+
java.util.List<java.lang.String> |
+failedTraces |
+
long |
+totalCount |
+
Constructor and Description | +
---|
JobDeleteResponse() |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+toString() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public long totalCount+
public long errorCount+
public java.util.List<java.lang.String> deletedJobs+
public java.util.List<java.lang.String> deletedTraces+
public java.util.List<java.lang.String> failedJobs+
public java.util.List<java.lang.String> failedTraces+
public java.util.List<com.fasterxml.jackson.databind.JsonNode> errors+
public class JobManager.JobDeleteResource
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
JobDeleteResource(com.marklogic.client.DatabaseClient srcClient) |
+
Modifier and Type | +Method and Description | +
---|---|
JobDeleteResponse |
+deleteJobs(java.lang.String jobIds) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public JobDeleteResource(com.marklogic.client.DatabaseClient srcClient)+
public JobDeleteResponse deleteJobs(java.lang.String jobIds)+
jobIds
- comma-separated list of jobIds to delete.public class JobManager
+extends java.lang.Object
+Modifier and Type | +Class and Description | +
---|---|
class |
+JobManager.JobDeleteResource |
+
Constructor and Description | +
---|
JobManager(com.marklogic.client.DatabaseClient jobClient) |
+
Modifier and Type | +Method and Description | +
---|---|
JobDeleteResponse |
+deleteJobs(java.lang.String jobIds) |
+
void |
+saveJob(Job job) |
+
void |
+saveJob(Job job,
+ com.marklogic.client.Transaction transaction) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Enum Constant and Description | +
---|
CANCELED |
+
FAILED |
+
FINISHED |
+
FINISHED_WITH_ERRORS |
+
RUNNING_COLLECTOR |
+
RUNNING_HARMONIZE |
+
STARTED |
+
STOP_ON_ERROR |
+
Modifier and Type | +Method and Description | +
---|---|
static JobStatus |
+getJobStatus(java.lang.String status) |
+
java.lang.String |
+toString() |
+
static JobStatus |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static JobStatus[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final JobStatus STARTED+
public static final JobStatus RUNNING_COLLECTOR+
public static final JobStatus RUNNING_HARMONIZE+
public static final JobStatus FINISHED+
public static final JobStatus FINISHED_WITH_ERRORS+
public static final JobStatus FAILED+
public static final JobStatus STOP_ON_ERROR+
public static final JobStatus CANCELED+
public static JobStatus[] values()+
+for (JobStatus c : JobStatus.values()) + System.out.println(c); +
public static JobStatus valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static JobStatus getJobStatus(java.lang.String status)+
public java.lang.String toString()+
toString
in class java.lang.Enum<JobStatus>
Class | +Description | +
---|---|
Job | ++ |
JobDeleteResponse | ++ |
JobManager | ++ |
Enum | +Description | +
---|---|
JobStatus | ++ |
public interface MainPlugin
+Modifier and Type | +Method and Description | +
---|---|
CodeFormat |
+getCodeFormat() |
+
java.lang.String |
+getModule() |
+
java.lang.String getModule()+
CodeFormat getCodeFormat()+
public class MainPluginImpl +extends java.lang.Object +implements MainPlugin+
Constructor and Description | +
---|
MainPluginImpl() |
+
MainPluginImpl(java.lang.String module,
+ CodeFormat codeFormat) |
+
Modifier and Type | +Method and Description | +
---|---|
CodeFormat |
+getCodeFormat() |
+
java.lang.String |
+getModule() |
+
void |
+setCodeFormat(CodeFormat codeFormat) |
+
void |
+setModule(java.lang.String module) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public MainPluginImpl()+
public MainPluginImpl(java.lang.String module, + CodeFormat codeFormat)+
public void setModule(java.lang.String module)+
public java.lang.String getModule()+
getModule
in interface MainPlugin
public void setCodeFormat(CodeFormat codeFormat)+
public CodeFormat getCodeFormat()+
getCodeFormat
in interface MainPlugin
Class | +Description | +
---|---|
MainPluginImpl | ++ |
Interface | +Description | +
---|---|
MainPlugin | ++ |
Interface | +Description | +
---|---|
HubConfig | +
+ A class for passing around the Data Hub's Configuration
+ |
+
Class | +Description | +
---|---|
DataHub | ++ |
DataHubUpgrader | ++ |
Debugging | ++ |
EntityManager | ++ |
FlowManager | ++ |
HubConfigBuilder | +
+ A class for building a HubConfig class.
+ |
+
HubProject | +
+ Class for creating a hub Project
+ |
+
InstallInfo | ++ |
PreInstallCheck | ++ |
Tracing | ++ |
Enum | +Description | +
---|---|
HubDatabase | ++ |
public class Scaffolding.ContentPlugin
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
ContentPlugin(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+getContents(java.lang.String entityName,
+ CodeFormat codeFormat,
+ FlowType flowType) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public ContentPlugin(com.marklogic.client.DatabaseClient client)+
public java.lang.String getContents(java.lang.String entityName, + CodeFormat codeFormat, + FlowType flowType)+
public class Scaffolding
+extends java.lang.Object
+Modifier and Type | +Class and Description | +
---|---|
class |
+Scaffolding.ContentPlugin |
+
Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
Constructor and Description | +
---|
Scaffolding(java.lang.String projectDir,
+ com.marklogic.client.DatabaseClient databaseClient) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+createEntity(java.lang.String entityName) |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat) |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat,
+ boolean useEsModel) |
+
void |
+createRestExtension(java.lang.String entityName,
+ java.lang.String extensionName,
+ FlowType flowType,
+ CodeFormat codeFormat) |
+
void |
+createRestTransform(java.lang.String entityName,
+ java.lang.String transformName,
+ FlowType flowType,
+ CodeFormat codeFormat) |
+
static java.lang.String |
+getAbsolutePath(java.lang.String first,
+ java.lang.String... more) |
+
java.nio.file.Path |
+getEntityDir(java.lang.String entityName) |
+
java.nio.file.Path |
+getFlowDir(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType) |
+
void |
+updateLegacyEntity(java.lang.String entityName) |
+
boolean |
+updateLegacyFlow(java.lang.String fromVersion,
+ java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType) |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion,
+ java.lang.String entityName) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public Scaffolding(java.lang.String projectDir, + com.marklogic.client.DatabaseClient databaseClient)+
public java.nio.file.Path getFlowDir(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
public void createEntity(java.lang.String entityName)+
public void createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat)+
public void createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat, + boolean useEsModel)+
public java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion, + java.lang.String entityName)+
public void updateLegacyEntity(java.lang.String entityName)+
public boolean updateLegacyFlow(java.lang.String fromVersion, + java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
public void createRestExtension(java.lang.String entityName, + java.lang.String extensionName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
ScaffoldingValidationException
public void createRestTransform(java.lang.String entityName, + java.lang.String transformName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
ScaffoldingValidationException
public java.nio.file.Path getEntityDir(java.lang.String entityName)+
public static java.lang.String getAbsolutePath(java.lang.String first, + java.lang.String... more)+
public class ScaffoldingValidator
+extends java.nio.file.SimpleFileVisitor<java.nio.file.Path>
+Constructor and Description | +
---|
ScaffoldingValidator(java.lang.String projectDir) |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+isUniqueRestServiceExtension(java.lang.String name) |
+
boolean |
+isUniqueRestTransform(java.lang.String name) |
+
postVisitDirectory, preVisitDirectory, visitFile, visitFileFailed
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
Scaffolding | ++ |
ScaffoldingValidator | ++ |
public class FileUtil
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
static void |
+copy(java.io.InputStream source,
+ java.io.File destination) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class HubModuleManager
+extends com.marklogic.client.ext.helper.LoggingObject
+implements com.marklogic.client.ext.modulesloader.ModulesManager
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DEFAULT_FILE_PATH |
+
logger
Constructor and Description | +
---|
HubModuleManager(java.lang.String propertiesFilePath) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.lang.String |
+buildKey(java.io.File file)
+Lower-casing avoids some annoying issues on Windows where sometimes you get "C:" at the start, and other times
+ you get "c:".
+ |
+
void |
+deletePropertiesFile() |
+
boolean |
+hasFileBeenModifiedSinceLastLoaded(java.io.File file) |
+
boolean |
+hasKeyBeenModified(java.lang.String key,
+ long lastModified) |
+
void |
+initialize() |
+
void |
+saveLastLoadedTimestamp(java.io.File file,
+ java.util.Date date) |
+
void |
+saveLastLoadedTimestamp(java.lang.String key,
+ java.util.Date date) |
+
void |
+setMinimumFileTimestampToLoad(long minimumFileTimestampToLoad) |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final java.lang.String DEFAULT_FILE_PATH+
public HubModuleManager(java.lang.String propertiesFilePath)+
public void initialize()+
initialize
in interface com.marklogic.client.ext.modulesloader.ModulesManager
public void deletePropertiesFile()+
public boolean hasFileBeenModifiedSinceLastLoaded(java.io.File file)+
hasFileBeenModifiedSinceLastLoaded
in interface com.marklogic.client.ext.modulesloader.ModulesManager
public boolean hasKeyBeenModified(java.lang.String key, + long lastModified)+
public void saveLastLoadedTimestamp(java.io.File file, + java.util.Date date)+
saveLastLoadedTimestamp
in interface com.marklogic.client.ext.modulesloader.ModulesManager
public void saveLastLoadedTimestamp(java.lang.String key, + java.util.Date date)+
protected java.lang.String buildKey(java.io.File file)+
file
- - the file to build a key forpublic void setMinimumFileTimestampToLoad(long minimumFileTimestampToLoad)+
public class JsonXor
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
static com.fasterxml.jackson.databind.JsonNode |
+xor(java.io.File original,
+ java.io.File changed) |
+
static com.fasterxml.jackson.databind.JsonNode |
+xor(java.io.InputStream original,
+ java.io.InputStream changed) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static com.fasterxml.jackson.databind.JsonNode xor(java.io.File original, + java.io.File changed) + throws java.io.IOException+
java.io.IOException
public static com.fasterxml.jackson.databind.JsonNode xor(java.io.InputStream original, + java.io.InputStream changed) + throws java.io.IOException+
java.io.IOException
public class MlcpConsumer
+extends java.lang.Object
+implements java.util.function.Consumer<java.lang.String>
+Constructor and Description | +
---|
MlcpConsumer(java.util.concurrent.atomic.AtomicLong successfulEvents,
+ java.util.concurrent.atomic.AtomicLong failedEvents,
+ FlowStatusListener statusListener,
+ java.lang.String jobId) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+accept(java.lang.String status) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
andThen
public MlcpConsumer(java.util.concurrent.atomic.AtomicLong successfulEvents, + java.util.concurrent.atomic.AtomicLong failedEvents, + FlowStatusListener statusListener, + java.lang.String jobId)+
public class MlcpRunner +extends ProcessRunner+
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
Constructor and Description | +
---|
MlcpRunner(java.lang.String mlcpPath,
+ java.lang.String mainClass,
+ HubConfig hubConfig,
+ Flow flow,
+ com.marklogic.client.DatabaseClient databaseClient,
+ com.fasterxml.jackson.databind.JsonNode mlcpOptions,
+ FlowStatusListener statusListener) |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+getJobId() |
+
void |
+run() |
+
getHubConfig, getProcessOutput, newRunner, withArgs, withHubconfig, withStreamConsumer
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public MlcpRunner(java.lang.String mlcpPath, + java.lang.String mainClass, + HubConfig hubConfig, + Flow flow, + com.marklogic.client.DatabaseClient databaseClient, + com.fasterxml.jackson.databind.JsonNode mlcpOptions, + FlowStatusListener statusListener)+
public java.lang.String getJobId()+
public void run()+
run
in interface java.lang.Runnable
run
in class ProcessRunner
public class PerformanceLogger
+extends java.lang.Object
+Constructor and Description | +
---|
PerformanceLogger() |
+
Modifier and Type | +Method and Description | +
---|---|
static void |
+logTimeInsideMethod(long startTime,
+ java.lang.String location) |
+
static long |
+monitorTimeInsideMethod() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class ProcessRunner
+extends java.lang.Thread
+java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
Constructor and Description | +
---|
ProcessRunner() |
+
Modifier and Type | +Method and Description | +
---|---|
HubConfig |
+getHubConfig() |
+
java.lang.String |
+getProcessOutput() |
+
static ProcessRunner |
+newRunner() |
+
void |
+run() |
+
ProcessRunner |
+withArgs(java.util.List<java.lang.String> args) |
+
ProcessRunner |
+withHubconfig(HubConfig hubConfig) |
+
ProcessRunner |
+withStreamConsumer(java.util.function.Consumer<java.lang.String> consumer) |
+
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public HubConfig getHubConfig()+
public java.lang.String getProcessOutput()+
public static ProcessRunner newRunner()+
public ProcessRunner withArgs(java.util.List<java.lang.String> args)+
public ProcessRunner withHubconfig(HubConfig hubConfig)+
public ProcessRunner withStreamConsumer(java.util.function.Consumer<java.lang.String> consumer)+
public void run()+
run
in interface java.lang.Runnable
run
in class java.lang.Thread
public class StreamGobbler
+extends java.lang.Thread
+java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
Constructor and Description | +
---|
StreamGobbler(java.io.InputStream inputStream,
+ java.util.function.Consumer<java.lang.String> consumeInputLine) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+run() |
+
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class Versions
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
Versions(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
static int |
+compare(java.lang.String v1,
+ java.lang.String v2) |
+
java.lang.String |
+getHubVersion() |
+
java.lang.String |
+getMarkLogicVersion() |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
FileUtil | ++ |
HubModuleManager | ++ |
JsonXor | ++ |
MlcpConsumer | ++ |
MlcpRunner | ++ |
PerformanceLogger | ++ |
ProcessRunner | ++ |
StreamGobbler | ++ |
Versions | ++ |
public class EntitiesValidator
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
EntitiesValidator(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.databind.JsonNode |
+validate(java.lang.String entity,
+ java.lang.String flow,
+ java.lang.String plugin,
+ java.lang.String type,
+ java.lang.String content) |
+
com.fasterxml.jackson.databind.JsonNode |
+validateAll() |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public EntitiesValidator(com.marklogic.client.DatabaseClient client)+
public com.fasterxml.jackson.databind.JsonNode validateAll()+
public com.fasterxml.jackson.databind.JsonNode validate(java.lang.String entity, + java.lang.String flow, + java.lang.String plugin, + java.lang.String type, + java.lang.String content)+
Class | +Description | +
---|---|
EntitiesValidator | ++ |
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DEFAULT_AUTH_METHOD |
+"digest" |
+
+
+public static final java.lang.String |
+DEFAULT_CUSTOM_FOREST_PATH |
+"forests" |
+
+
+public static final java.lang.String |
+DEFAULT_FINAL_NAME |
+"data-hub-FINAL" |
+
+
+public static final java.lang.String |
+DEFAULT_JOB_NAME |
+"data-hub-JOBS" |
+
+
+public static final java.lang.String |
+DEFAULT_MODULES_DB_NAME |
+"data-hub-MODULES" |
+
+
+public static final java.lang.String |
+DEFAULT_ROLE_NAME |
+"data-hub-role" |
+
+
+public static final java.lang.String |
+DEFAULT_SCHEMAS_DB_NAME |
+"data-hub-SCHEMAS" |
+
+
+public static final java.lang.String |
+DEFAULT_SCHEME |
+"http" |
+
+
+public static final java.lang.String |
+DEFAULT_STAGING_NAME |
+"data-hub-STAGING" |
+
+
+public static final java.lang.String |
+DEFAULT_TRACE_NAME |
+"data-hub-TRACING" |
+
+
+public static final java.lang.String |
+DEFAULT_TRIGGERS_DB_NAME |
+"data-hub-TRIGGERS" |
+
+
+public static final java.lang.String |
+DEFAULT_USER_NAME |
+"data-hub-user" |
+
+
+public static final java.lang.String |
+ENTITY_CONFIG_DIR |
+"entity-config" |
+
+
+public static final java.lang.String |
+FINAL_ENTITY_SEARCH_OPTIONS_FILE |
+"final-entity-options.xml" |
+
+
+public static final java.lang.String |
+HUB_CONFIG_DIR |
+"hub-internal-config" |
+
+
+public static final java.lang.String |
+HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+"hub-modules-deploy-timestamps.properties" |
+
+
+public static final java.lang.String |
+STAGING_ENTITY_SEARCH_OPTIONS_FILE |
+"staging-entity-options.xml" |
+
+
+public static final java.lang.String |
+USER_CONFIG_DIR |
+"user-config" |
+
+
+public static final java.lang.String |
+USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES |
+"user-content-deploy-timestamps.properties" |
+
+
+public static final java.lang.String |
+USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+"user-modules-deploy-timestamps.properties" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+ENTITY_CONFIG_DIR |
+"entity-config" |
+
+
+public static final java.lang.String |
+HUB_CONFIG_DIR |
+"hub-internal-config" |
+
+
+public static final java.lang.String |
+USER_CONFIG_DIR |
+"user-config" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DATABASE_FILENAME |
+"schemas-database.json" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DATABASE_FILENAME |
+"triggers-database.json" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DEFAULT_FILE_PATH |
+"build/ml-javaclient-util/module-timestamps.properties" |
+
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object
. The interfaces do not inherit from java.lang.Object
.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+HubConfig
instancemaxInMemorySize
elements in memory.maxInMemorySize
elements in memory.HubConfigBuilder
instanceAdminConfig
for the HubConfig
AdminManager
for the HubConfig
AppConfig
for the HubConfig
ManageClient
for the HubConfig
ManageConfig
for the HubConfig
+ + diff --git a/javadocs/2.0.3/overview-summary.html b/javadocs/2.0.3/overview-summary.html new file mode 100644 index 0000000000..ebc07a941d --- /dev/null +++ b/javadocs/2.0.3/overview-summary.html @@ -0,0 +1,223 @@ + + + + + +
See: Description
+Package | +Description | +
---|---|
com.marklogic.com.marklogic.client.ext.file | ++ |
com.marklogic.com.marklogic.client.ext.modulesloader.impl | ++ |
com.marklogic.hub | ++ |
com.marklogic.hub.collector | ++ |
com.marklogic.hub.collector.impl | ++ |
com.marklogic.hub.deploy | ++ |
com.marklogic.hub.deploy.commands | ++ |
com.marklogic.hub.deploy.util | ++ |
com.marklogic.hub.entity | ++ |
com.marklogic.hub.error | ++ |
com.marklogic.hub.flow | ++ |
com.marklogic.hub.flow.impl | ++ |
com.marklogic.hub.impl | ++ |
com.marklogic.hub.job | ++ |
com.marklogic.hub.main | ++ |
com.marklogic.hub.main.impl | ++ |
com.marklogic.hub.scaffold | ++ |
com.marklogic.hub.util | ++ |
com.marklogic.hub.validate | ++ |
public class CacheBusterDocumentFileProcessor
+extends com.marklogic.client.ext.helper.LoggingObject
+implements com.marklogic.client.ext.file.DocumentFileProcessor
+logger
Constructor and Description | +
---|
CacheBusterDocumentFileProcessor() |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.client.ext.file.DocumentFile |
+processDocumentFile(com.marklogic.client.ext.file.DocumentFile documentFile) |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
CacheBusterDocumentFileProcessor | ++ |
public class EntityDefModulesFinder
+extends com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
+logger
Constructor and Description | +
---|
EntityDefModulesFinder() |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.marklogic.client.ext.modulesloader.Modules |
+findModulesWithResolvedBaseDir(java.lang.String baseDir) |
+
addAssetDirectories, addNamespaces, addOptions, addPropertiesFile, addServices, addTransforms, decodeAssetDirectoryResource, findModules, findResources, getNamespaceFilenameFilter, getRecognizedPaths, getTransformFilenameFilter, isIncludeUnrecognizedPathsAsAssetPaths, setIncludeUnrecognizedPathsAsAssetPaths, setNamespaceFilenameFilter, setNamespacesPath, setOptionsPath, setServicesPath, setTransformFilenameFilter, setTransformsPath
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public EntityDefModulesFinder()+
protected com.marklogic.client.ext.modulesloader.Modules findModulesWithResolvedBaseDir(java.lang.String baseDir)+
findModulesWithResolvedBaseDir
in class com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
public class SearchOptionsFinder
+extends com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
+logger
Constructor and Description | +
---|
SearchOptionsFinder() |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.marklogic.client.ext.modulesloader.Modules |
+findModulesWithResolvedBaseDir(java.lang.String baseDir) |
+
addAssetDirectories, addNamespaces, addOptions, addPropertiesFile, addServices, addTransforms, decodeAssetDirectoryResource, findModules, findResources, getNamespaceFilenameFilter, getRecognizedPaths, getTransformFilenameFilter, isIncludeUnrecognizedPathsAsAssetPaths, setIncludeUnrecognizedPathsAsAssetPaths, setNamespaceFilenameFilter, setNamespacesPath, setOptionsPath, setServicesPath, setTransformFilenameFilter, setTransformsPath
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
protected com.marklogic.client.ext.modulesloader.Modules findModulesWithResolvedBaseDir(java.lang.String baseDir)+
findModulesWithResolvedBaseDir
in class com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
public class UserModulesFinder
+extends com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
+implements com.marklogic.client.ext.modulesloader.ModulesFinder
+logger
Constructor and Description | +
---|
UserModulesFinder() |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.marklogic.client.ext.modulesloader.Modules |
+findModulesWithResolvedBaseDir(java.lang.String baseDir) |
+
addAssetDirectories, addNamespaces, addOptions, addPropertiesFile, addServices, addTransforms, decodeAssetDirectoryResource, findModules, findResources, getNamespaceFilenameFilter, getRecognizedPaths, getTransformFilenameFilter, isIncludeUnrecognizedPathsAsAssetPaths, setIncludeUnrecognizedPathsAsAssetPaths, setNamespaceFilenameFilter, setNamespacesPath, setOptionsPath, setServicesPath, setTransformFilenameFilter, setTransformsPath
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
findModules
protected com.marklogic.client.ext.modulesloader.Modules findModulesWithResolvedBaseDir(java.lang.String baseDir)+
findModulesWithResolvedBaseDir
in class com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
Class | +Description | +
---|---|
EntityDefModulesFinder | ++ |
SearchOptionsFinder | ++ |
UserModulesFinder | ++ |
public class DataHub
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
Constructor and Description | +
---|
DataHub(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+clearUserModules()
+Removes user's modules from the modules db
+ TODO: this becomes much simpler when we move code into the server dir
+ |
+
com.marklogic.mgmt.admin.AdminManager |
+getAdminManager() |
+
java.util.List<com.marklogic.appdeployer.command.Command> |
+getCommandList() |
+
com.marklogic.mgmt.resource.databases.DatabaseManager |
+getDatabaseManager() |
+
com.marklogic.mgmt.ManageClient |
+getManageClient() |
+
com.marklogic.mgmt.resource.appservers.ServerManager |
+getServerManager() |
+
void |
+initProject() |
+
void |
+install()
+Installs the data hub configuration and server-side modules into MarkLogic
+ |
+
void |
+install(HubDeployStatusListener listener)
+Installs the data hub configuration and server-side modules into MarkLogic
+ |
+
InstallInfo |
+isInstalled()
+Determines if the data hub is installed in MarkLogic
+ |
+
boolean |
+isServerVersionValid(java.lang.String versionString)
+Validates the MarkLogic server to ensure compatibility with the hub
+ |
+
PreInstallCheck |
+runPreInstallCheck() |
+
PreInstallCheck |
+runPreInstallCheck(Versions versions) |
+
void |
+uninstall()
+Uninstalls the data hub configuration and server-side modules from MarkLogic
+ |
+
void |
+uninstall(HubDeployStatusListener listener)
+Uninstalls the data hub configuration and server-side modules from MarkLogic
+ |
+
void |
+updateIndexes() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public com.marklogic.mgmt.ManageClient getManageClient()+
public com.marklogic.mgmt.admin.AdminManager getAdminManager()+
public com.marklogic.mgmt.resource.databases.DatabaseManager getDatabaseManager()+
public com.marklogic.mgmt.resource.appservers.ServerManager getServerManager()+
public InstallInfo isInstalled()+
public boolean isServerVersionValid(java.lang.String versionString)+
versionString
- - the version of the server to validateServerValidationException
- if the server is not compatiblepublic void initProject()+
public void clearUserModules()+
public java.util.List<com.marklogic.appdeployer.command.Command> getCommandList()+
public PreInstallCheck runPreInstallCheck()+
public PreInstallCheck runPreInstallCheck(Versions versions)+
public void install()+
public void install(HubDeployStatusListener listener)+
listener
- - the callback method to receive status updatespublic void updateIndexes()+
public void uninstall()+
public void uninstall(HubDeployStatusListener listener)+
listener
- - the callback method to receive status updatespublic class DataHubUpgrader
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+MIN_UPGRADE_VERSION |
+
Constructor and Description | +
---|
DataHubUpgrader(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+upgradeHub() |
+
boolean |
+upgradeHub(java.util.List<java.lang.String> updatedFlows) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static java.lang.String MIN_UPGRADE_VERSION+
public DataHubUpgrader(HubConfig hubConfig)+
public boolean upgradeHub() + throws CantUpgradeException+
CantUpgradeException
public boolean upgradeHub(java.util.List<java.lang.String> updatedFlows) + throws CantUpgradeException+
CantUpgradeException
public enum DatabaseKind +extends java.lang.Enum<DatabaseKind>+
Enum Constant and Description | +
---|
FINAL |
+
JOB |
+
MODULES |
+
SCHEMAS |
+
STAGING |
+
TRACE |
+
TRIGGERS |
+
Modifier and Type | +Method and Description | +
---|---|
static java.lang.String |
+getName(DatabaseKind databaseKind)
+Validates the MarkLogic server to ensure compatibility with the hub
+ |
+
static DatabaseKind |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static DatabaseKind[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final DatabaseKind STAGING+
public static final DatabaseKind FINAL+
public static final DatabaseKind JOB+
public static final DatabaseKind TRACE+
public static final DatabaseKind SCHEMAS+
public static final DatabaseKind TRIGGERS+
public static final DatabaseKind MODULES+
public static DatabaseKind[] values()+
+for (DatabaseKind c : DatabaseKind.values()) + System.out.println(c); +
public static DatabaseKind valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static java.lang.String getName(DatabaseKind databaseKind)+
databaseKind
- - the enum for the type of databaseInvalidDBOperationError
- if the database kind is not found in enumerationpublic class Debugging
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
Debugging(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+disable()
+Disables debugging
+ |
+
void |
+enable()
+Enables debugging
+ |
+
boolean |
+isEnabled()
+Determines if the hub has debugging enabled or not
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public Debugging(com.marklogic.client.DatabaseClient client)+
public void enable()+
public void disable()+
public boolean isEnabled()+
public class EntityManager
+extends com.marklogic.client.ext.helper.LoggingObject
+logger
Constructor and Description | +
---|
EntityManager(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
java.util.List<org.springframework.core.io.Resource> |
+deploySearchOptions() |
+
boolean |
+saveDbIndexes() |
+
boolean |
+saveSearchOptions() |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class FlowManager
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
FlowManager(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
static Flow |
+flowFromXml(org.w3c.dom.Element doc)
+Turns an XML document into a flow
+ |
+
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName)
+Retrieves a named flow from a given entity
+ |
+
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType) |
+
Flow |
+getFlowFromProperties(java.nio.file.Path propertiesFile) |
+
java.util.List<Flow> |
+getFlows(java.lang.String entityName)
+Retrieves a list of flows installed on the MarkLogic server
+ |
+
java.util.List<java.lang.String> |
+getLegacyFlows() |
+
java.util.List<Flow> |
+getLocalFlows()
+retrieves a list of all the flows on the local files systems
+ |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName) |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName,
+ FlowType flowType) |
+
FlowRunner |
+newFlowRunner() |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public java.util.List<Flow> getLocalFlows()+
public java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName)+
public java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName, + FlowType flowType)+
public Flow getFlowFromProperties(java.nio.file.Path propertiesFile)+
public java.util.List<Flow> getFlows(java.lang.String entityName)+
entityName
- - the entity from which to fetch the flowspublic Flow getFlow(java.lang.String entityName, + java.lang.String flowName)+
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getpublic Flow getFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
public java.util.List<java.lang.String> getLegacyFlows()+
public java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion)+
public FlowRunner newFlowRunner()+
public static Flow flowFromXml(org.w3c.dom.Element doc)+
doc
- - the xml document representing a flowpublic interface HubConfig
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DEFAULT_AUTH_METHOD |
+
static java.lang.String |
+DEFAULT_CUSTOM_FOREST_PATH |
+
static java.lang.String |
+DEFAULT_FINAL_NAME |
+
static java.lang.Integer |
+DEFAULT_FINAL_PORT |
+
static java.lang.Integer |
+DEFAULT_FORESTS_PER_HOST |
+
static java.lang.String |
+DEFAULT_JOB_NAME |
+
static java.lang.Integer |
+DEFAULT_JOB_PORT |
+
static java.lang.String |
+DEFAULT_MODULES_DB_NAME |
+
static java.lang.String |
+DEFAULT_ROLE_NAME |
+
static java.lang.String |
+DEFAULT_SCHEMAS_DB_NAME |
+
static java.lang.String |
+DEFAULT_SCHEME |
+
static java.lang.String |
+DEFAULT_STAGING_NAME |
+
static java.lang.Integer |
+DEFAULT_STAGING_PORT |
+
static java.lang.String |
+DEFAULT_TRACE_NAME |
+
static java.lang.Integer |
+DEFAULT_TRACE_PORT |
+
static java.lang.String |
+DEFAULT_TRIGGERS_DB_NAME |
+
static java.lang.String |
+DEFAULT_USER_NAME |
+
static java.lang.String |
+ENTITY_CONFIG_DIR |
+
static java.lang.String |
+FINAL_ENTITY_SEARCH_OPTIONS_FILE |
+
static java.lang.String |
+HUB_CONFIG_DIR |
+
static java.lang.String |
+HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+
static java.lang.String |
+STAGING_ENTITY_SEARCH_OPTIONS_FILE |
+
static java.lang.String |
+USER_CONFIG_DIR |
+
static java.lang.String |
+USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES |
+
static java.lang.String |
+USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.mgmt.admin.AdminConfig |
+getAdminConfig() |
+
com.marklogic.mgmt.admin.AdminManager |
+getAdminManager() |
+
com.marklogic.appdeployer.AppConfig |
+getAppConfig() |
+
java.lang.String |
+getCustomForestPath() |
+
java.nio.file.Path |
+getEntityDatabaseDir() |
+
java.lang.String |
+getFinalAuthMethod() |
+
java.lang.String |
+getFinalCertFile() |
+
java.lang.String |
+getFinalCertPassword() |
+
java.lang.String |
+getFinalDbName() |
+
java.lang.String |
+getFinalExternalName() |
+
java.lang.Integer |
+getFinalForestsPerHost() |
+
java.lang.String |
+getFinalHttpName() |
+
java.lang.Integer |
+getFinalPort() |
+
java.lang.String |
+getFinalScheme() |
+
boolean |
+getFinalSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getFinalSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getFinalSslHostnameVerifier() |
+
java.lang.String |
+getHost() |
+
java.nio.file.Path |
+getHubConfigDir() |
+
java.nio.file.Path |
+getHubDatabaseDir() |
+
java.nio.file.Path |
+getHubEntitiesDir() |
+
java.nio.file.Path |
+getHubMimetypesDir() |
+
java.lang.String |
+getHubModulesDeployTimestampFile() |
+
java.nio.file.Path |
+getHubPluginsDir() |
+
HubProject |
+getHubProject() |
+
java.lang.String |
+getHubRoleName() |
+
java.nio.file.Path |
+getHubSecurityDir() |
+
java.nio.file.Path |
+getHubServersDir() |
+
java.lang.String |
+getHubUserName() |
+
java.lang.String |
+getJarVersion() |
+
java.lang.String |
+getJobAuthMethod() |
+
java.lang.String |
+getJobCertFile() |
+
java.lang.String |
+getJobCertPassword() |
+
java.lang.String |
+getJobDbName() |
+
java.lang.String |
+getJobExternalName() |
+
java.lang.Integer |
+getJobForestsPerHost() |
+
java.lang.String |
+getJobHttpName() |
+
java.lang.Integer |
+getJobPort() |
+
java.lang.String |
+getJobScheme() |
+
boolean |
+getJobSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getJobSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getJobSslHostnameVerifier() |
+
java.lang.String[] |
+getLoadBalancerHosts() |
+
com.marklogic.mgmt.ManageClient |
+getManageClient() |
+
com.marklogic.mgmt.ManageConfig |
+getManageConfig() |
+
java.lang.String |
+getModulePermissions() |
+
java.lang.String |
+getModulesDbName() |
+
java.lang.Integer |
+getModulesForestsPerHost() |
+
java.lang.String |
+getProjectDir() |
+
java.lang.String |
+getSchemasDbName() |
+
java.lang.Integer |
+getSchemasForestsPerHost() |
+
java.lang.String |
+getStagingAuthMethod() |
+
java.lang.String |
+getStagingCertFile() |
+
java.lang.String |
+getStagingCertPassword() |
+
java.lang.String |
+getStagingDbName() |
+
java.lang.String |
+getStagingExternalName() |
+
java.lang.Integer |
+getStagingForestsPerHost() |
+
java.lang.String |
+getStagingHttpName() |
+
java.lang.Integer |
+getStagingPort() |
+
java.lang.String |
+getStagingScheme() |
+
boolean |
+getStagingSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getStagingSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getStagingSslHostnameVerifier() |
+
java.lang.String |
+getTraceAuthMethod() |
+
java.lang.String |
+getTraceCertFile() |
+
java.lang.String |
+getTraceCertPassword() |
+
java.lang.String |
+getTraceDbName() |
+
java.lang.String |
+getTraceExternalName() |
+
java.lang.Integer |
+getTraceForestsPerHost() |
+
java.lang.String |
+getTraceHttpName() |
+
java.lang.Integer |
+getTracePort() |
+
java.lang.String |
+getTraceScheme() |
+
boolean |
+getTraceSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getTraceSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getTraceSslHostnameVerifier() |
+
java.lang.String |
+getTriggersDbName() |
+
java.lang.Integer |
+getTriggersForestsPerHost() |
+
java.nio.file.Path |
+getUserConfigDir() |
+
java.io.File |
+getUserContentDeployTimestampFile() |
+
java.nio.file.Path |
+getUserDatabaseDir() |
+
java.lang.String |
+getUserModulesDeployTimestampFile() |
+
java.nio.file.Path |
+getUserSecurityDir() |
+
java.nio.file.Path |
+getUserServersDir() |
+
void |
+initHubProject() |
+
com.marklogic.client.DatabaseClient |
+newAppServicesClient() |
+
com.marklogic.client.DatabaseClient |
+newFinalClient()
+Creates a new DatabaseClient for accessing the Final database
+ |
+
com.marklogic.client.DatabaseClient |
+newJobDbClient()
+Creates a new DatabaseClient for accessing the Job database
+ |
+
com.marklogic.client.DatabaseClient |
+newModulesDbClient()
+Creates a new DatabaseClient for accessing the Hub Modules database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient()
+Creates a new DatabaseClient for accessing the Staging database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient(java.lang.String databaseName) |
+
com.marklogic.client.DatabaseClient |
+newTraceDbClient()
+Creates a new DatabaseClient for accessing the Trace database
+ |
+
void |
+setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig) |
+
void |
+setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager) |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config) |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config,
+ boolean skipUpdate) |
+
void |
+setCustomForestPath(java.lang.String customForestPath) |
+
void |
+setFinalAuthMethod(java.lang.String finalAuthMethod) |
+
void |
+setFinalCertFile(java.lang.String finalCertFile) |
+
void |
+setFinalCertPassword(java.lang.String finalCertPassword) |
+
void |
+setFinalDbName(java.lang.String finalDbName) |
+
void |
+setFinalExternalName(java.lang.String finalExternalName) |
+
void |
+setFinalForestsPerHost(java.lang.Integer finalForestsPerHost) |
+
void |
+setFinalHttpName(java.lang.String finalHttpName) |
+
void |
+setFinalPort(java.lang.Integer finalPort) |
+
void |
+setFinalScheme(java.lang.String finalScheme) |
+
void |
+setFinalSimpleSsl(boolean finalSimpleSsl) |
+
void |
+setFinalSslContext(javax.net.ssl.SSLContext finalSslContext) |
+
void |
+setFinalSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier finalSslHostnameVerifier) |
+
void |
+setHubRoleName(java.lang.String hubRoleName) |
+
void |
+setHubUserName(java.lang.String hubUserName) |
+
void |
+setJobAuthMethod(java.lang.String jobAuthMethod) |
+
void |
+setJobCertFile(java.lang.String jobCertFile) |
+
void |
+setJobCertPassword(java.lang.String jobCertPassword) |
+
void |
+setJobDbName(java.lang.String jobDbName) |
+
void |
+setJobExternalName(java.lang.String jobExternalName) |
+
void |
+setJobForestsPerHost(java.lang.Integer jobForestsPerHost) |
+
void |
+setJobHttpName(java.lang.String jobHttpName) |
+
void |
+setJobPort(java.lang.Integer jobPort) |
+
void |
+setJobScheme(java.lang.String jobScheme) |
+
void |
+setJobSimpleSsl(boolean jobSimpleSsl) |
+
void |
+setJobSslContext(javax.net.ssl.SSLContext jobSslContext) |
+
void |
+setJobSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier jobSslHostnameVerifier) |
+
void |
+setLoadBalancerHosts(java.lang.String[] loadBalancerHosts) |
+
void |
+setManageClient(com.marklogic.mgmt.ManageClient manageClient) |
+
void |
+setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig) |
+
void |
+setModulePermissions(java.lang.String modulePermissions) |
+
void |
+setModulesDbName(java.lang.String modulesDbName) |
+
void |
+setModulesForestsPerHost(java.lang.Integer modulesForestsPerHost) |
+
void |
+setProjectDir(java.lang.String projectDir) |
+
void |
+setSchemasDbName(java.lang.String schemasDbName) |
+
void |
+setSchemasForestsPerHost(java.lang.Integer schemasForestsPerHost) |
+
void |
+setStagingAuthMethod(java.lang.String stagingAuthMethod) |
+
void |
+setStagingCertFile(java.lang.String stagingCertFile) |
+
void |
+setStagingCertPassword(java.lang.String stagingCertPassword) |
+
void |
+setStagingDbName(java.lang.String stagingDbName) |
+
void |
+setStagingExternalName(java.lang.String stagingExternalName) |
+
void |
+setStagingForestsPerHost(java.lang.Integer stagingForestsPerHost) |
+
void |
+setStagingHttpName(java.lang.String stagingHttpName) |
+
void |
+setStagingPort(java.lang.Integer stagingPort) |
+
void |
+setStagingScheme(java.lang.String stagingScheme) |
+
void |
+setStagingSimpleSsl(boolean stagingSimpleSsl) |
+
void |
+setStagingSslContext(javax.net.ssl.SSLContext stagingSslContext) |
+
void |
+setStagingSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier) |
+
void |
+setTraceAuthMethod(java.lang.String traceAuthMethod) |
+
void |
+setTraceCertFile(java.lang.String traceCertFile) |
+
void |
+setTraceCertPassword(java.lang.String traceCertPassword) |
+
void |
+setTraceDbName(java.lang.String traceDbName) |
+
void |
+setTraceExternalName(java.lang.String traceExternalName) |
+
void |
+setTraceForestsPerHost(java.lang.Integer traceForestsPerHost) |
+
void |
+setTraceHttpName(java.lang.String traceHttpName) |
+
void |
+setTracePort(java.lang.Integer tracePort) |
+
void |
+setTraceScheme(java.lang.String traceScheme) |
+
void |
+setTraceSimpleSsl(boolean traceSimpleSsl) |
+
void |
+setTraceSslContext(javax.net.ssl.SSLContext traceSslContext) |
+
void |
+setTraceSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier traceSslHostnameVerifier) |
+
void |
+setTriggersDbName(java.lang.String triggersDbName) |
+
void |
+setTriggersForestsPerHost(java.lang.Integer triggersForestsPerHost) |
+
static final java.lang.String HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES+
static final java.lang.String USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES+
static final java.lang.String USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES+
static final java.lang.String HUB_CONFIG_DIR+
static final java.lang.String USER_CONFIG_DIR+
static final java.lang.String ENTITY_CONFIG_DIR+
static final java.lang.String STAGING_ENTITY_SEARCH_OPTIONS_FILE+
static final java.lang.String FINAL_ENTITY_SEARCH_OPTIONS_FILE+
static final java.lang.String DEFAULT_STAGING_NAME+
static final java.lang.String DEFAULT_FINAL_NAME+
static final java.lang.String DEFAULT_TRACE_NAME+
static final java.lang.String DEFAULT_JOB_NAME+
static final java.lang.String DEFAULT_MODULES_DB_NAME+
static final java.lang.String DEFAULT_TRIGGERS_DB_NAME+
static final java.lang.String DEFAULT_SCHEMAS_DB_NAME+
static final java.lang.String DEFAULT_ROLE_NAME+
static final java.lang.String DEFAULT_USER_NAME+
static final java.lang.Integer DEFAULT_STAGING_PORT+
static final java.lang.Integer DEFAULT_FINAL_PORT+
static final java.lang.Integer DEFAULT_TRACE_PORT+
static final java.lang.Integer DEFAULT_JOB_PORT+
static final java.lang.String DEFAULT_AUTH_METHOD+
static final java.lang.String DEFAULT_SCHEME+
static final java.lang.Integer DEFAULT_FORESTS_PER_HOST+
static final java.lang.String DEFAULT_CUSTOM_FOREST_PATH+
java.lang.String getHost()+
java.lang.String getStagingDbName()+
void setStagingDbName(java.lang.String stagingDbName)+
java.lang.String getStagingHttpName()+
void setStagingHttpName(java.lang.String stagingHttpName)+
java.lang.Integer getStagingForestsPerHost()+
void setStagingForestsPerHost(java.lang.Integer stagingForestsPerHost)+
java.lang.Integer getStagingPort()+
void setStagingPort(java.lang.Integer stagingPort)+
java.lang.String getStagingAuthMethod()+
void setStagingAuthMethod(java.lang.String stagingAuthMethod)+
java.lang.String getStagingScheme()+
void setStagingScheme(java.lang.String stagingScheme)+
boolean getStagingSimpleSsl()+
void setStagingSimpleSsl(boolean stagingSimpleSsl)+
javax.net.ssl.SSLContext getStagingSslContext()+
void setStagingSslContext(javax.net.ssl.SSLContext stagingSslContext)+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getStagingSslHostnameVerifier()+
void setStagingSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier)+
java.lang.String getStagingCertFile()+
void setStagingCertFile(java.lang.String stagingCertFile)+
java.lang.String getStagingCertPassword()+
void setStagingCertPassword(java.lang.String stagingCertPassword)+
java.lang.String getStagingExternalName()+
void setStagingExternalName(java.lang.String stagingExternalName)+
java.lang.String getFinalDbName()+
void setFinalDbName(java.lang.String finalDbName)+
java.lang.String getFinalHttpName()+
void setFinalHttpName(java.lang.String finalHttpName)+
java.lang.Integer getFinalForestsPerHost()+
void setFinalForestsPerHost(java.lang.Integer finalForestsPerHost)+
java.lang.Integer getFinalPort()+
void setFinalPort(java.lang.Integer finalPort)+
java.lang.String getFinalAuthMethod()+
void setFinalAuthMethod(java.lang.String finalAuthMethod)+
java.lang.String getFinalScheme()+
void setFinalScheme(java.lang.String finalScheme)+
boolean getFinalSimpleSsl()+
void setFinalSimpleSsl(boolean finalSimpleSsl)+
javax.net.ssl.SSLContext getFinalSslContext()+
void setFinalSslContext(javax.net.ssl.SSLContext finalSslContext)+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getFinalSslHostnameVerifier()+
void setFinalSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier finalSslHostnameVerifier)+
java.lang.String getFinalCertFile()+
void setFinalCertFile(java.lang.String finalCertFile)+
java.lang.String getFinalCertPassword()+
void setFinalCertPassword(java.lang.String finalCertPassword)+
java.lang.String getFinalExternalName()+
void setFinalExternalName(java.lang.String finalExternalName)+
java.lang.String getTraceDbName()+
void setTraceDbName(java.lang.String traceDbName)+
java.lang.String getTraceHttpName()+
void setTraceHttpName(java.lang.String traceHttpName)+
java.lang.Integer getTraceForestsPerHost()+
void setTraceForestsPerHost(java.lang.Integer traceForestsPerHost)+
java.lang.Integer getTracePort()+
void setTracePort(java.lang.Integer tracePort)+
java.lang.String getTraceAuthMethod()+
void setTraceAuthMethod(java.lang.String traceAuthMethod)+
java.lang.String getTraceScheme()+
void setTraceScheme(java.lang.String traceScheme)+
boolean getTraceSimpleSsl()+
void setTraceSimpleSsl(boolean traceSimpleSsl)+
javax.net.ssl.SSLContext getTraceSslContext()+
void setTraceSslContext(javax.net.ssl.SSLContext traceSslContext)+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getTraceSslHostnameVerifier()+
void setTraceSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier traceSslHostnameVerifier)+
java.lang.String getTraceCertFile()+
void setTraceCertFile(java.lang.String traceCertFile)+
java.lang.String getTraceCertPassword()+
void setTraceCertPassword(java.lang.String traceCertPassword)+
java.lang.String getTraceExternalName()+
void setTraceExternalName(java.lang.String traceExternalName)+
java.lang.String getJobDbName()+
void setJobDbName(java.lang.String jobDbName)+
java.lang.String getJobHttpName()+
void setJobHttpName(java.lang.String jobHttpName)+
java.lang.Integer getJobForestsPerHost()+
void setJobForestsPerHost(java.lang.Integer jobForestsPerHost)+
java.lang.Integer getJobPort()+
void setJobPort(java.lang.Integer jobPort)+
java.lang.String getJobAuthMethod()+
void setJobAuthMethod(java.lang.String jobAuthMethod)+
java.lang.String getJobScheme()+
void setJobScheme(java.lang.String jobScheme)+
boolean getJobSimpleSsl()+
void setJobSimpleSsl(boolean jobSimpleSsl)+
javax.net.ssl.SSLContext getJobSslContext()+
void setJobSslContext(javax.net.ssl.SSLContext jobSslContext)+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getJobSslHostnameVerifier()+
void setJobSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier jobSslHostnameVerifier)+
java.lang.String getJobCertFile()+
void setJobCertFile(java.lang.String jobCertFile)+
java.lang.String getJobCertPassword()+
void setJobCertPassword(java.lang.String jobCertPassword)+
java.lang.String getJobExternalName()+
void setJobExternalName(java.lang.String jobExternalName)+
java.lang.String getModulesDbName()+
void setModulesDbName(java.lang.String modulesDbName)+
java.lang.Integer getModulesForestsPerHost()+
void setModulesForestsPerHost(java.lang.Integer modulesForestsPerHost)+
java.lang.String getTriggersDbName()+
void setTriggersDbName(java.lang.String triggersDbName)+
java.lang.Integer getTriggersForestsPerHost()+
void setTriggersForestsPerHost(java.lang.Integer triggersForestsPerHost)+
java.lang.String getSchemasDbName()+
void setSchemasDbName(java.lang.String schemasDbName)+
java.lang.Integer getSchemasForestsPerHost()+
void setSchemasForestsPerHost(java.lang.Integer schemasForestsPerHost)+
java.lang.String getHubRoleName()+
void setHubRoleName(java.lang.String hubRoleName)+
java.lang.String getHubUserName()+
void setHubUserName(java.lang.String hubUserName)+
java.lang.String[] getLoadBalancerHosts()+
void setLoadBalancerHosts(java.lang.String[] loadBalancerHosts)+
java.lang.String getCustomForestPath()+
void setCustomForestPath(java.lang.String customForestPath)+
java.lang.String getModulePermissions()+
void setModulePermissions(java.lang.String modulePermissions)+
java.lang.String getProjectDir()+
void setProjectDir(java.lang.String projectDir)+
HubProject getHubProject()+
void initHubProject()+
java.lang.String getHubModulesDeployTimestampFile()+
java.lang.String getUserModulesDeployTimestampFile()+
java.io.File getUserContentDeployTimestampFile()+
com.marklogic.mgmt.ManageConfig getManageConfig()+
void setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
com.marklogic.mgmt.ManageClient getManageClient()+
void setManageClient(com.marklogic.mgmt.ManageClient manageClient)+
com.marklogic.mgmt.admin.AdminConfig getAdminConfig()+
void setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
com.marklogic.mgmt.admin.AdminManager getAdminManager()+
void setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
com.marklogic.client.DatabaseClient newAppServicesClient()+
com.marklogic.client.DatabaseClient newStagingClient()+
com.marklogic.client.DatabaseClient newStagingClient(java.lang.String databaseName)+
com.marklogic.client.DatabaseClient newFinalClient()+
com.marklogic.client.DatabaseClient newJobDbClient()+
com.marklogic.client.DatabaseClient newTraceDbClient()+
com.marklogic.client.DatabaseClient newModulesDbClient()+
java.nio.file.Path getHubPluginsDir()+
java.nio.file.Path getHubEntitiesDir()+
java.nio.file.Path getHubConfigDir()+
java.nio.file.Path getHubDatabaseDir()+
java.nio.file.Path getHubServersDir()+
java.nio.file.Path getHubSecurityDir()+
java.nio.file.Path getUserSecurityDir()+
java.nio.file.Path getUserConfigDir()+
java.nio.file.Path getUserDatabaseDir()+
java.nio.file.Path getEntityDatabaseDir()+
java.nio.file.Path getUserServersDir()+
java.nio.file.Path getHubMimetypesDir()+
com.marklogic.appdeployer.AppConfig getAppConfig()+
void setAppConfig(com.marklogic.appdeployer.AppConfig config)+
void setAppConfig(com.marklogic.appdeployer.AppConfig config, + boolean skipUpdate)+
java.lang.String getJarVersion() + throws java.io.IOException+
java.io.IOException
public class HubConfigBuilder
+extends java.lang.Object
+
+ HubConfig hubConfig = HubConfigBuilder.newHubConfigBuilder("/path/to/your/project")
+ .withPropertiesFromEnvironment("local")
+ .build();
+
Modifier and Type | +Method and Description | +
---|---|
HubConfig |
+build()
+Builds the
+HubConfig instance |
+
static HubConfigBuilder |
+newHubConfigBuilder(java.lang.String projectDir)
+Returns a new
+HubConfigBuilder instance |
+
HubConfigBuilder |
+withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)
+Sets the
+AdminConfig for the HubConfig |
+
HubConfigBuilder |
+withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)
+Sets the
+AdminManager for the HubConfig |
+
HubConfigBuilder |
+withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)
+Sets the
+AppConfig for the HubConfig |
+
HubConfigBuilder |
+withManageClient(com.marklogic.mgmt.ManageClient manageClient)
+Sets the
+ManageClient for the HubConfig |
+
HubConfigBuilder |
+withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)
+Sets the
+ManageConfig for the HubConfig |
+
HubConfigBuilder |
+withProperties(java.util.Properties properties)
+Tells the builder to use the given properties.
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment()
+Tells the builder to load properties from the gradle files in the project dir
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment(java.lang.String environment)
+Tells the builder to load properties from the gradle files in the project dir
+ but to look for an environment properties file with overrides
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static HubConfigBuilder newHubConfigBuilder(java.lang.String projectDir)+
HubConfigBuilder
instanceprojectDir
- - the hub's project directoryHubConfigBuilder
public HubConfigBuilder withPropertiesFromEnvironment()+
HubConfigBuilder
instancepublic HubConfigBuilder withPropertiesFromEnvironment(java.lang.String environment)+
environment
- - the name of the environment to use (local,dev,qa,prod,...)HubConfigBuilder
instancepublic HubConfigBuilder withProperties(java.util.Properties properties)+
properties
- - A Properties
object with properties setHubConfigBuilder
instancepublic HubConfigBuilder withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)+
AppConfig
for the HubConfig
appConfig
- - an AppConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
AdminConfig
for the HubConfig
adminConfig
- - an AdminConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
AdminManager
for the HubConfig
adminManager
- - an AdminManager
objectHubConfigBuilder
instancepublic HubConfigBuilder withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
ManageConfig
for the HubConfig
manageConfig
- - a ManageConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withManageClient(com.marklogic.mgmt.ManageClient manageClient)+
ManageClient
for the HubConfig
manageClient
- - a ManageClient
HubConfigBuilder
instancepublic enum HubDatabase +extends java.lang.Enum<HubDatabase>+
Enum Constant and Description | +
---|
FINAL |
+
STAGING |
+
Modifier and Type | +Method and Description | +
---|---|
static HubDatabase |
+getHubDatabase(java.lang.String database) |
+
java.lang.String |
+toString() |
+
static HubDatabase |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static HubDatabase[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final HubDatabase STAGING+
public static final HubDatabase FINAL+
public static HubDatabase[] values()+
+for (HubDatabase c : HubDatabase.values()) + System.out.println(c); +
public static HubDatabase valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static HubDatabase getHubDatabase(java.lang.String database)+
public java.lang.String toString()+
toString
in class java.lang.Enum<HubDatabase>
public class HubProject
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+ENTITY_CONFIG_DIR |
+
static java.lang.String |
+HUB_CONFIG_DIR |
+
protected org.slf4j.Logger |
+logger |
+
static java.lang.String |
+USER_CONFIG_DIR |
+
Constructor and Description | +
---|
HubProject(java.lang.String projectDirStr) |
+
Modifier and Type | +Method and Description | +
---|---|
java.nio.file.Path |
+getEntityConfigDir() |
+
java.nio.file.Path |
+getEntityDatabaseDir() |
+
java.nio.file.Path |
+getHubConfigDir() |
+
java.nio.file.Path |
+getHubDatabaseDir() |
+
java.nio.file.Path |
+getHubEntitiesDir() |
+
java.nio.file.Path |
+getHubMimetypesDir() |
+
java.nio.file.Path |
+getHubPluginsDir() |
+
java.nio.file.Path |
+getHubSecurityDir() |
+
java.nio.file.Path |
+getHubServersDir() |
+
java.nio.file.Path |
+getUserConfigDir() |
+
java.nio.file.Path |
+getUserDatabaseDir() |
+
java.nio.file.Path |
+getUserSchemasDir() |
+
java.nio.file.Path |
+getUserSecurityDir() |
+
java.nio.file.Path |
+getUserServersDir() |
+
void |
+init(java.util.Map<java.lang.String,java.lang.String> customTokens)
+Initializes a directory as a hub project directory.
+ |
+
boolean |
+isInitialized() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final java.lang.String HUB_CONFIG_DIR+
public static final java.lang.String USER_CONFIG_DIR+
public static final java.lang.String ENTITY_CONFIG_DIR+
protected final org.slf4j.Logger logger+
public HubProject(java.lang.String projectDirStr)+
public java.nio.file.Path getHubPluginsDir()+
public java.nio.file.Path getHubEntitiesDir()+
public java.nio.file.Path getHubConfigDir()+
public java.nio.file.Path getHubDatabaseDir()+
public java.nio.file.Path getHubServersDir()+
public java.nio.file.Path getHubSecurityDir()+
public java.nio.file.Path getHubMimetypesDir()+
public java.nio.file.Path getUserConfigDir()+
public java.nio.file.Path getUserSecurityDir()+
public java.nio.file.Path getUserDatabaseDir()+
public java.nio.file.Path getUserSchemasDir()+
public java.nio.file.Path getUserServersDir()+
public java.nio.file.Path getEntityConfigDir()+
public java.nio.file.Path getEntityDatabaseDir()+
public boolean isInitialized()+
public void init(java.util.Map<java.lang.String,java.lang.String> customTokens)+
customTokens
- - some custom tokens to start withpublic class InstallInfo
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
boolean |
+finalAppServerExists |
+
boolean |
+finalCollectionLexiconOn |
+
boolean |
+finalDbExists |
+
boolean |
+finalForestsExist |
+
boolean |
+finalTripleIndexOn |
+
boolean |
+jobAppServerExists |
+
boolean |
+jobDbExists |
+
boolean |
+jobForestsExist |
+
boolean |
+stagingAppServerExists |
+
boolean |
+stagingCollectionLexiconOn |
+
boolean |
+stagingDbExists |
+
boolean |
+stagingForestsExist |
+
boolean |
+stagingTripleIndexOn |
+
boolean |
+traceAppServerExists |
+
boolean |
+traceDbExists |
+
boolean |
+traceForestsExist |
+
Constructor and Description | +
---|
InstallInfo() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+isInstalled() |
+
boolean |
+isPartiallyInstalled() |
+
java.lang.String |
+toString() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public boolean stagingAppServerExists+
public boolean finalAppServerExists+
public boolean traceAppServerExists+
public boolean jobAppServerExists+
public boolean stagingDbExists+
public boolean finalDbExists+
public boolean traceDbExists+
public boolean jobDbExists+
public boolean stagingTripleIndexOn+
public boolean stagingCollectionLexiconOn+
public boolean finalTripleIndexOn+
public boolean finalCollectionLexiconOn+
public boolean stagingForestsExist+
public boolean finalForestsExist+
public boolean traceForestsExist+
public boolean jobForestsExist+
public class PreInstallCheck
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
boolean |
+finalPortInUse |
+
java.lang.String |
+finalPortInUseBy |
+
boolean |
+jobPortInUse |
+
java.lang.String |
+jobPortInUseBy |
+
java.lang.String |
+serverVersion |
+
boolean |
+serverVersionOk |
+
boolean |
+stagingPortInUse |
+
java.lang.String |
+stagingPortInUseBy |
+
boolean |
+tracePortInUse |
+
java.lang.String |
+tracePortInUseBy |
+
Constructor and Description | +
---|
PreInstallCheck() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+isSafeToInstall() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public boolean stagingPortInUse+
public java.lang.String stagingPortInUseBy+
public boolean finalPortInUse+
public java.lang.String finalPortInUseBy+
public boolean jobPortInUse+
public java.lang.String jobPortInUseBy+
public boolean tracePortInUse+
public java.lang.String tracePortInUseBy+
public boolean serverVersionOk+
public java.lang.String serverVersion+
public class Tracing
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
Tracing(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+disable()
+Disables tracing
+ |
+
void |
+enable()
+Enables tracing
+ |
+
boolean |
+isEnabled()
+Determines if the hub has tracing enabled or not
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public Tracing(com.marklogic.client.DatabaseClient client)+
public void enable()+
public void disable()+
public boolean isEnabled()+
public interface Collector
+Modifier and Type | +Method and Description | +
---|---|
com.marklogic.client.DatabaseClient |
+getClient() |
+
CodeFormat |
+getCodeFormat() |
+
HubConfig |
+getHubConfig() |
+
java.lang.String |
+getModule() |
+
DiskQueue<java.lang.String> |
+run(java.lang.String jobId,
+ java.lang.String entity,
+ java.lang.String flow,
+ int threadCount,
+ java.util.Map<java.lang.String,java.lang.Object> options) |
+
void |
+setClient(com.marklogic.client.DatabaseClient client) |
+
void |
+setHubConfig(HubConfig config) |
+
CodeFormat getCodeFormat()+
java.lang.String getModule()+
void setHubConfig(HubConfig config)+
HubConfig getHubConfig()+
void setClient(com.marklogic.client.DatabaseClient client)+
com.marklogic.client.DatabaseClient getClient()+
DiskQueue<java.lang.String> run(java.lang.String jobId, + java.lang.String entity, + java.lang.String flow, + int threadCount, + java.util.Map<java.lang.String,java.lang.Object> options)+
E
- - A Serializable Classpublic class DiskQueue<E extends java.io.Serializable>
+extends java.util.AbstractQueue<java.lang.String>
+Constructor and Description | +
---|
DiskQueue(int maxInMemorySize)
+Construct a disk-backed queue that keeps at most
+
+maxInMemorySize elements in memory. |
+
DiskQueue(int maxInMemorySize,
+ java.io.File tempDir)
+Construct a disk-backed queue that keeps at most
+
+maxInMemorySize elements in memory. |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+clear() |
+
protected void |
+finalize() |
+
java.util.Iterator<java.lang.String> |
+iterator() |
+
boolean |
+offer(java.lang.String element) |
+
java.lang.String |
+peek() |
+
java.lang.String |
+poll() |
+
java.lang.String |
+remove() |
+
int |
+size() |
+
add, addAll, element
contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray
forEach
public DiskQueue(int maxInMemorySize)+
maxInMemorySize
elements in memory.maxInMemorySize
- Maximum number of elements to keep in memory.public DiskQueue(int maxInMemorySize, + java.io.File tempDir)+
maxInMemorySize
elements in memory.maxInMemorySize
- Maximum number of elements to keep in memory.tempDir
- Directory where queue temporary files will be written to.protected void finalize() + throws java.lang.Throwable+
finalize
in class java.lang.Object
java.lang.Throwable
public java.util.Iterator<java.lang.String> iterator()+
iterator
in interface java.lang.Iterable<java.lang.String>
iterator
in interface java.util.Collection<java.lang.String>
iterator
in class java.util.AbstractCollection<java.lang.String>
public int size()+
size
in interface java.util.Collection<java.lang.String>
size
in class java.util.AbstractCollection<java.lang.String>
public boolean offer(java.lang.String element)+
public java.lang.String peek()+
public java.lang.String remove()+
remove
in interface java.util.Queue<java.lang.String>
remove
in class java.util.AbstractQueue<java.lang.String>
public java.lang.String poll()+
public void clear()+
clear
in interface java.util.Collection<java.lang.String>
clear
in class java.util.AbstractQueue<java.lang.String>
Constructor and Description | +
---|
CollectorImpl() |
+
CollectorImpl(java.lang.String module,
+ CodeFormat codeFormat) |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.client.DatabaseClient |
+getClient() |
+
CodeFormat |
+getCodeFormat() |
+
HubConfig |
+getHubConfig() |
+
java.lang.String |
+getModule() |
+
DiskQueue<java.lang.String> |
+run(java.lang.String jobId,
+ java.lang.String entity,
+ java.lang.String flow,
+ int threadCount,
+ java.util.Map<java.lang.String,java.lang.Object> options) |
+
void |
+setClient(com.marklogic.client.DatabaseClient client) |
+
void |
+setHubConfig(HubConfig config) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public CollectorImpl()+
public CollectorImpl(java.lang.String module, + CodeFormat codeFormat)+
public void setHubConfig(HubConfig config)+
setHubConfig
in interface Collector
public HubConfig getHubConfig()+
getHubConfig
in interface Collector
public void setClient(com.marklogic.client.DatabaseClient client)+ +
public com.marklogic.client.DatabaseClient getClient()+ +
public CodeFormat getCodeFormat()+
getCodeFormat
in interface Collector
public java.lang.String getModule()+ +
Class | +Description | +
---|---|
CollectorImpl | ++ |
public class HubAppDeployer
+extends com.marklogic.appdeployer.impl.SimpleAppDeployer
+logger
Constructor and Description | +
---|
HubAppDeployer(com.marklogic.mgmt.ManageClient manageClient,
+ com.marklogic.mgmt.admin.AdminManager adminManager,
+ HubDeployStatusListener listener) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+deploy(com.marklogic.appdeployer.AppConfig appConfig) |
+
void |
+undeploy(com.marklogic.appdeployer.AppConfig appConfig) |
+
buildModifiableCommandList, getCommand, getCommandOfType, getCommands, removeCommand, setCommands
executeCommand, prepareCommand, undoCommand
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public HubAppDeployer(com.marklogic.mgmt.ManageClient manageClient, + com.marklogic.mgmt.admin.AdminManager adminManager, + HubDeployStatusListener listener)+
public void deploy(com.marklogic.appdeployer.AppConfig appConfig)+
deploy
in interface com.marklogic.appdeployer.AppDeployer
deploy
in class com.marklogic.appdeployer.impl.AbstractAppDeployer
public void undeploy(com.marklogic.appdeployer.AppConfig appConfig)+
undeploy
in interface com.marklogic.appdeployer.AppDeployer
undeploy
in class com.marklogic.appdeployer.impl.AbstractAppDeployer
public class DeployHubDatabaseCommand
+extends com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubDatabaseCommand(HubConfig config,
+ java.lang.String databaseFilename) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.lang.String |
+buildDefaultDatabasePayload(com.marklogic.appdeployer.command.CommandContext context) |
+
protected com.marklogic.appdeployer.command.forests.DeployForestsCommand |
+buildDeployForestsCommand(java.lang.String dbPayload,
+ com.marklogic.mgmt.SaveReceipt receipt,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.String |
+buildPayload(com.marklogic.appdeployer.command.CommandContext context) |
+
protected int |
+determineForestCountPerHost(java.lang.String dbPayload,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.String |
+getDatabaseFilename() |
+
java.lang.String |
+getDatabaseName() |
+
java.lang.String |
+getForestDelete() |
+
java.lang.String |
+getForestFilename() |
+
int |
+getForestsPerHost() |
+
protected java.lang.String |
+getPayload(com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.Integer |
+getUndoSortOrder() |
+
boolean |
+isCreateDatabaseWithoutFile() |
+
boolean |
+isCreateForestsOnEachHost() |
+
protected com.fasterxml.jackson.databind.JsonNode |
+mergeDatabaseFiles(com.marklogic.appdeployer.AppConfig appConfig) |
+
void |
+setCreateDatabaseWithoutFile(boolean createDatabaseWithoutFile) |
+
void |
+setCreateForestsOnEachHost(boolean createForestsOnEachHost) |
+
void |
+setDatabaseFilename(java.lang.String databaseFilename) |
+
void |
+setDatabaseName(java.lang.String databaseName) |
+
void |
+setForestDelete(java.lang.String forestDelete) |
+
void |
+setForestFilename(java.lang.String forestFilename) |
+
void |
+setForestsPerHost(int forestsPerHost) |
+
void |
+setUndoSortOrder(int undoSortOrder) |
+
java.lang.String |
+toString() |
+
void |
+undo(com.marklogic.appdeployer.command.CommandContext context) |
+
addSubDatabases, buildForest, customForestsExist, getForestDeleteLevel, getSuperDatabaseName, isCheckForCustomForests, isSubDatabase, newDatabaseManageForDeleting, removeSubDatabases, setCheckForCustomForests, setDatabaseFile, setSubDatabase, setSuperDatabaseName, shouldCreateForests
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecuteSortOrder
public DeployHubDatabaseCommand(HubConfig config, + java.lang.String databaseFilename)+
public java.lang.String toString()+
toString
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.Integer getUndoSortOrder()+
getUndoSortOrder
in interface com.marklogic.appdeployer.command.UndoableCommand
getUndoSortOrder
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
execute
in interface com.marklogic.appdeployer.command.Command
execute
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void undo(com.marklogic.appdeployer.command.CommandContext context)+
undo
in interface com.marklogic.appdeployer.command.UndoableCommand
undo
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String buildPayload(com.marklogic.appdeployer.command.CommandContext context)+
buildPayload
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected java.lang.String getPayload(com.marklogic.appdeployer.command.CommandContext context)+
getPayload
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected com.fasterxml.jackson.databind.JsonNode mergeDatabaseFiles(com.marklogic.appdeployer.AppConfig appConfig)+
protected com.marklogic.appdeployer.command.forests.DeployForestsCommand buildDeployForestsCommand(java.lang.String dbPayload, + com.marklogic.mgmt.SaveReceipt receipt, + com.marklogic.appdeployer.command.CommandContext context)+
buildDeployForestsCommand
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected int determineForestCountPerHost(java.lang.String dbPayload, + com.marklogic.appdeployer.command.CommandContext context)+
determineForestCountPerHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected java.lang.String buildDefaultDatabasePayload(com.marklogic.appdeployer.command.CommandContext context)+
buildDefaultDatabasePayload
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getForestDelete()+
public void setForestDelete(java.lang.String forestDelete)+
public int getForestsPerHost()+
getForestsPerHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setForestsPerHost(int forestsPerHost)+
setForestsPerHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getForestFilename()+
getForestFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setForestFilename(java.lang.String forestFilename)+
setForestFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setUndoSortOrder(int undoSortOrder)+
setUndoSortOrder
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getDatabaseFilename()+
getDatabaseFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setDatabaseFilename(java.lang.String databaseFilename)+
setDatabaseFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public boolean isCreateDatabaseWithoutFile()+
isCreateDatabaseWithoutFile
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setCreateDatabaseWithoutFile(boolean createDatabaseWithoutFile)+
setCreateDatabaseWithoutFile
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getDatabaseName()+
getDatabaseName
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setDatabaseName(java.lang.String databaseName)+
setDatabaseName
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public boolean isCreateForestsOnEachHost()+
isCreateForestsOnEachHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setCreateForestsOnEachHost(boolean createForestsOnEachHost)+
setCreateForestsOnEachHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public class DeployHubDatabasesCommand
+extends com.marklogic.appdeployer.command.AbstractUndoableCommand
++ A key aspect of this class is its attempt to deploy/undeploy databases in the correct order. For each database file + that it finds that's not one of the default ones, a DeployDatabaseCommand will be created. All of those commands will + then be sorted based on the presence of "triggers-database" or "schema-database" within the payload for the command. +
+ If the above strategy doesn't work for you, you can always resort to naming your database files to control the order + that they're processed in. +
payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubDatabasesCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> |
+buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+undo(com.marklogic.appdeployer.command.CommandContext context) |
+
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public DeployHubDatabasesCommand(HubConfig config)+
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
public void undo(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context)+
public class DeployHubMimetypesCommand
+extends com.marklogic.appdeployer.command.mimetypes.DeployMimetypesCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubMimetypesCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
afterResourceSaved, getResourceManager
deleteResource, execute, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public class DeployHubOtherDatabasesCommand
+extends com.marklogic.appdeployer.command.AbstractUndoableCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubOtherDatabasesCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> |
+buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+undo(com.marklogic.appdeployer.command.CommandContext context) |
+
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public DeployHubOtherDatabasesCommand(HubConfig config)+
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
public void undo(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context)+
public class DeployHubRolesCommand
+extends com.marklogic.appdeployer.command.security.DeployRolesCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubRolesCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
adjustPayloadBeforeSavingResource, execute, getResourceManager
afterResourceSaved, deleteResource, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
getUndoSortOrder, setUndoSortOrder
adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public class DeployHubSchemasDatabaseCommand +extends DeployHubDatabaseCommand+
Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DATABASE_FILENAME |
+
payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubSchemasDatabaseCommand(HubConfig hubConfig) |
+
buildDefaultDatabasePayload, buildDeployForestsCommand, buildPayload, determineForestCountPerHost, execute, getDatabaseFilename, getDatabaseName, getForestDelete, getForestFilename, getForestsPerHost, getPayload, getUndoSortOrder, isCreateDatabaseWithoutFile, isCreateForestsOnEachHost, mergeDatabaseFiles, setCreateDatabaseWithoutFile, setCreateForestsOnEachHost, setDatabaseFilename, setDatabaseName, setForestDelete, setForestFilename, setForestsPerHost, setUndoSortOrder, toString, undo
addSubDatabases, buildForest, customForestsExist, getForestDeleteLevel, getSuperDatabaseName, isCheckForCustomForests, isSubDatabase, newDatabaseManageForDeleting, removeSubDatabases, setCheckForCustomForests, setDatabaseFile, setSubDatabase, setSuperDatabaseName, shouldCreateForests
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecuteSortOrder
public static final java.lang.String DATABASE_FILENAME+
public class DeployHubServersCommand
+extends com.marklogic.appdeployer.command.AbstractResourceCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubServersCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected void |
+deleteResource(com.marklogic.mgmt.resource.ResourceManager mgr,
+ com.marklogic.appdeployer.command.CommandContext context,
+ java.io.File f) |
+
protected java.lang.String |
+getPayload(java.io.File f,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
protected com.marklogic.mgmt.resource.ResourceManager |
+getResourceManager(com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.Integer |
+getUndoSortOrder() |
+
protected com.fasterxml.jackson.databind.JsonNode |
+mergeServerFiles(java.io.File f) |
+
protected com.marklogic.mgmt.SaveReceipt |
+saveResource(com.marklogic.mgmt.resource.ResourceManager mgr,
+ com.marklogic.appdeployer.command.CommandContext context,
+ java.io.File f) |
+
afterResourceSaved, execute, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public DeployHubServersCommand(HubConfig config)+
protected java.io.File[] getResourceDirs(com.marklogic.appdeployer.command.CommandContext context)+
getResourceDirs
in class com.marklogic.appdeployer.command.AbstractResourceCommand
protected com.marklogic.mgmt.resource.ResourceManager getResourceManager(com.marklogic.appdeployer.command.CommandContext context)+
getResourceManager
in class com.marklogic.appdeployer.command.AbstractResourceCommand
public java.lang.Integer getUndoSortOrder()+
getUndoSortOrder
in interface com.marklogic.appdeployer.command.UndoableCommand
getUndoSortOrder
in class com.marklogic.appdeployer.command.AbstractUndoableCommand
protected com.marklogic.mgmt.SaveReceipt saveResource(com.marklogic.mgmt.resource.ResourceManager mgr, + com.marklogic.appdeployer.command.CommandContext context, + java.io.File f)+
saveResource
in class com.marklogic.appdeployer.command.AbstractCommand
protected void deleteResource(com.marklogic.mgmt.resource.ResourceManager mgr, + com.marklogic.appdeployer.command.CommandContext context, + java.io.File f)+
deleteResource
in class com.marklogic.appdeployer.command.AbstractResourceCommand
protected java.lang.String getPayload(java.io.File f, + com.marklogic.appdeployer.command.CommandContext context)+
protected com.fasterxml.jackson.databind.JsonNode mergeServerFiles(java.io.File f)+
public class DeployHubTriggersDatabaseCommand +extends DeployHubDatabaseCommand+
Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DATABASE_FILENAME |
+
payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubTriggersDatabaseCommand(HubConfig hubConfig) |
+
buildDefaultDatabasePayload, buildDeployForestsCommand, buildPayload, determineForestCountPerHost, execute, getDatabaseFilename, getDatabaseName, getForestDelete, getForestFilename, getForestsPerHost, getPayload, getUndoSortOrder, isCreateDatabaseWithoutFile, isCreateForestsOnEachHost, mergeDatabaseFiles, setCreateDatabaseWithoutFile, setCreateForestsOnEachHost, setDatabaseFilename, setDatabaseName, setForestDelete, setForestFilename, setForestsPerHost, setUndoSortOrder, toString, undo
addSubDatabases, buildForest, customForestsExist, getForestDeleteLevel, getSuperDatabaseName, isCheckForCustomForests, isSubDatabase, newDatabaseManageForDeleting, removeSubDatabases, setCheckForCustomForests, setDatabaseFile, setSubDatabase, setSuperDatabaseName, shouldCreateForests
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecuteSortOrder
public static final java.lang.String DATABASE_FILENAME+
public class DeployHubUsersCommand
+extends com.marklogic.appdeployer.command.security.DeployUsersCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubUsersCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
getResourceManager
afterResourceSaved, deleteResource, execute, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public class GenerateHubTDETemplateCommand
+extends com.marklogic.appdeployer.command.es.GenerateModelArtifactsCommand
+Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
payloadTokenReplacer
Constructor and Description | +
---|
GenerateHubTDETemplateCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected static java.util.Map<java.lang.String,java.io.File> |
+createEntityNameFileMap(java.util.List<java.io.File> entityFiles) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
protected static java.util.Optional<java.lang.String> |
+extactEntityNameFromFilename(java.lang.String filename) |
+
protected void |
+filterEntities(java.util.Map<java.lang.String,java.io.File> entityNameFileMap) |
+
protected java.util.List<java.io.File> |
+findEntityFiles() |
+
java.lang.String |
+getEntityNames() |
+
void |
+setEntityNames(java.lang.String entityNames) |
+
buildCodeGenerationRequest, buildDatabaseClient, fileHasDifferentContent, generateDatabaseProperties, generateExtractionTemplate, generateInstanceConverter, generateSchema, generateSearchOptions, loadModelDefinition, loadModelDefinition, removeGeneratedAtTimestamp, selectModulesDir, setOptionsPath
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public GenerateHubTDETemplateCommand(HubConfig hubConfig)+
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
execute
in interface com.marklogic.appdeployer.command.Command
execute
in class com.marklogic.appdeployer.command.es.GenerateModelArtifactsCommand
public java.lang.String getEntityNames()+
public void setEntityNames(java.lang.String entityNames)+
protected void filterEntities(java.util.Map<java.lang.String,java.io.File> entityNameFileMap)+
protected static java.util.Map<java.lang.String,java.io.File> createEntityNameFileMap(java.util.List<java.io.File> entityFiles)+
protected java.util.List<java.io.File> findEntityFiles()+
protected static java.util.Optional<java.lang.String> extactEntityNameFromFilename(java.lang.String filename)+
public class LoadHubModulesCommand
+extends com.marklogic.appdeployer.command.AbstractCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
LoadHubModulesCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class LoadUserModulesCommand
+extends com.marklogic.appdeployer.command.AbstractCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
LoadUserModulesCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+setForceLoad(boolean forceLoad) |
+
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
DeployHubDatabaseCommand | +
+ Can be used for creating any kind of database with any sorts of forests.
+ |
+
DeployHubDatabasesCommand | +
+ This commands handles deploying/undeploying every database file except the "default" ones of content-database.json,
+ triggers-database.json, and schemas-database.json.
+ |
+
DeployHubMimetypesCommand | ++ |
DeployHubOtherDatabasesCommand | ++ |
DeployHubRolesCommand | ++ |
DeployHubSchemasDatabaseCommand | ++ |
DeployHubServersCommand | ++ |
DeployHubTriggersDatabaseCommand | ++ |
DeployHubUsersCommand | ++ |
LoadHubModulesCommand | ++ |
LoadUserModulesCommand | ++ |
Class | +Description | +
---|---|
HubAppDeployer | ++ |
public interface HubDeployStatusListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+onError() |
+
void |
+onStatusChange(int percentComplete,
+ java.lang.String message) |
+
public class HubFileFilter
+extends java.lang.Object
+implements java.io.FileFilter
+Constructor and Description | +
---|
HubFileFilter() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+accept(java.io.File f) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Interface | +Description | +
---|---|
HubDeployStatusListener | ++ |
Class | +Description | +
---|---|
HubFileFilter | +
+ Simple implementation that accepts every file and ignores anything starting with ".".
+ |
+
public abstract class AbstractEntity +extends java.lang.Object +implements Entity+
Constructor and Description | +
---|
AbstractEntity(org.w3c.dom.Element xml) |
+
AbstractEntity(java.lang.String name) |
+
Modifier and Type | +Method and Description | +
---|---|
java.util.List<Flow> |
+getFlows()
+Returns the entity's flows
+ |
+
java.lang.String |
+getName()
+Returns the name of the Entity
+ |
+
java.lang.String |
+serialize()
+Serializes the entity to an XML string
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public AbstractEntity(org.w3c.dom.Element xml)+
public AbstractEntity(java.lang.String name)+
public interface Entity
+Modifier and Type | +Method and Description | +
---|---|
java.util.List<Flow> |
+getFlows()
+Returns all flows registered to the entity
+ |
+
java.lang.String |
+getName()
+Gets the Entity name
+ |
+
java.lang.String |
+serialize()
+Serializes the Entity as an XML string
+ |
+
java.lang.String getName()+
java.lang.String serialize()+
java.util.List<Flow> getFlows()+
public class EntityImpl +extends AbstractEntity+
Constructor and Description | +
---|
EntityImpl(org.w3c.dom.Element xml) |
+
EntityImpl(java.lang.String name) |
+
Interface | +Description | +
---|---|
Entity | +
+ A entity object.
+ |
+
Class | +Description | +
---|---|
AbstractEntity | +
+ Abstract Base class for entities
+ |
+
EntityImpl | +
+ An implementation of the Entity base class
+ |
+
public class CantUpgradeException
+extends java.lang.Exception
+Constructor and Description | +
---|
CantUpgradeException(java.lang.String version,
+ java.lang.String minVersion) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class DataHubConfigurationException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
DataHubConfigurationException() |
+
DataHubConfigurationException(java.lang.String message) |
+
DataHubConfigurationException(java.lang.String message,
+ java.lang.Throwable t) |
+
DataHubConfigurationException(java.lang.Throwable t) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public DataHubConfigurationException()+
public DataHubConfigurationException(java.lang.String message)+
public DataHubConfigurationException(java.lang.String message, + java.lang.Throwable t)+
public DataHubConfigurationException(java.lang.Throwable t)+
public class DataHubProjectException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
DataHubProjectException() |
+
DataHubProjectException(java.lang.String message) |
+
DataHubProjectException(java.lang.String message,
+ java.lang.Throwable t) |
+
DataHubProjectException(java.lang.Throwable t) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public DataHubProjectException()+
public DataHubProjectException(java.lang.String message)+
public DataHubProjectException(java.lang.String message, + java.lang.Throwable t)+
public DataHubProjectException(java.lang.Throwable t)+
public class EntityServicesGenerationException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
EntityServicesGenerationException() |
+
EntityServicesGenerationException(java.lang.String message) |
+
EntityServicesGenerationException(java.lang.String message,
+ java.lang.Throwable e) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public EntityServicesGenerationException()+
public EntityServicesGenerationException(java.lang.String message)+
public EntityServicesGenerationException(java.lang.String message, + java.lang.Throwable e)+
public class InvalidDBOperationError
+extends java.lang.Error
+Constructor and Description | +
---|
InvalidDBOperationError(DatabaseKind kind,
+ java.lang.String operation) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public InvalidDBOperationError(DatabaseKind kind, + java.lang.String operation)+
public class LegacyFlowsException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
LegacyFlowsException(java.util.List<java.lang.String> legacyFlows) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class ScaffoldingValidationException
+extends java.lang.Exception
+Constructor and Description | +
---|
ScaffoldingValidationException(java.lang.String message) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class ServerValidationException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
ServerValidationException(java.lang.String message) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Exception | +Description | +
---|---|
CantUpgradeException | ++ |
LegacyFlowsException | ++ |
ScaffoldingValidationException | ++ |
ServerValidationException | ++ |
public enum CodeFormat +extends java.lang.Enum<CodeFormat>+
Enum Constant and Description | +
---|
JAVASCRIPT |
+
XQUERY |
+
Modifier and Type | +Method and Description | +
---|---|
static CodeFormat |
+getCodeFormat(java.lang.String format) |
+
java.lang.String |
+toString() |
+
static CodeFormat |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static CodeFormat[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final CodeFormat JAVASCRIPT+
public static final CodeFormat XQUERY+
public static CodeFormat[] values()+
+for (CodeFormat c : CodeFormat.values()) + System.out.println(c); +
public static CodeFormat valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static CodeFormat getCodeFormat(java.lang.String format)+
public java.lang.String toString()+
toString
in class java.lang.Enum<CodeFormat>
public enum DataFormat +extends java.lang.Enum<DataFormat>+
Enum Constant and Description | +
---|
JSON |
+
XML |
+
Modifier and Type | +Method and Description | +
---|---|
static DataFormat |
+getDataFormat(java.lang.String type) |
+
java.lang.String |
+toString() |
+
static DataFormat |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static DataFormat[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final DataFormat XML+
public static final DataFormat JSON+
public static DataFormat[] values()+
+for (DataFormat c : DataFormat.values()) + System.out.println(c); +
public static DataFormat valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static DataFormat getDataFormat(java.lang.String type)+
public java.lang.String toString()+
toString
in class java.lang.Enum<DataFormat>
public interface Flow
+Modifier and Type | +Method and Description | +
---|---|
CodeFormat |
+getCodeFormat() |
+
Collector |
+getCollector() |
+
DataFormat |
+getDataFormat() |
+
java.lang.String |
+getEntityName() |
+
java.lang.String |
+getFlowDbPath() |
+
MainPlugin |
+getMain() |
+
java.lang.String |
+getName() |
+
FlowType |
+getType() |
+
java.lang.String |
+serialize() |
+
void |
+setCodeFormat(CodeFormat codeFormat) |
+
void |
+setCollector(Collector collector) |
+
void |
+setDataFormat(DataFormat dataFormat) |
+
void |
+setEntityName(java.lang.String entityName) |
+
void |
+setMain(MainPlugin main) |
+
void |
+setName(java.lang.String name) |
+
void |
+setType(FlowType type) |
+
java.util.Properties |
+toProperties() |
+
void setEntityName(java.lang.String entityName)+
java.lang.String getEntityName()+
void setName(java.lang.String name)+
java.lang.String getName()+
void setType(FlowType type)+
FlowType getType()+
void setDataFormat(DataFormat dataFormat)+
DataFormat getDataFormat()+
void setCodeFormat(CodeFormat codeFormat)+
CodeFormat getCodeFormat()+
java.lang.String serialize()+
java.util.Properties toProperties()+
java.lang.String getFlowDbPath()+
Collector getCollector()+
void setCollector(Collector collector)+
MainPlugin getMain()+
void setMain(MainPlugin main)+
public class FlowBuilder
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
Flow |
+build() |
+
static FlowBuilder |
+newFlow() |
+
FlowBuilder |
+withCodeFormat(CodeFormat codeFormat) |
+
FlowBuilder |
+withCollector(Collector collector) |
+
FlowBuilder |
+withDataFormat(DataFormat dataFormat) |
+
FlowBuilder |
+withEntityName(java.lang.String entityName) |
+
FlowBuilder |
+withMain(MainPlugin main) |
+
FlowBuilder |
+withName(java.lang.String flowName) |
+
FlowBuilder |
+withType(FlowType type) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static FlowBuilder newFlow()+
public FlowBuilder withName(java.lang.String flowName)+
public FlowBuilder withEntityName(java.lang.String entityName)+
public FlowBuilder withType(FlowType type)+
public FlowBuilder withDataFormat(DataFormat dataFormat)+
public FlowBuilder withCodeFormat(CodeFormat codeFormat)+
public FlowBuilder withCollector(Collector collector)+
public FlowBuilder withMain(MainPlugin main)+
public Flow build()+
public interface FlowFinishedListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+onFlowFinished() |
+
public interface FlowItemCompleteListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+processCompletion(java.lang.String jobId,
+ java.lang.String itemId) |
+
public interface FlowItemFailureListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+processFailure(java.lang.String jobId,
+ java.lang.String itemId) |
+
public interface FlowRunner
+Modifier and Type | +Method and Description | +
---|---|
void |
+awaitCompletion()
+Blocks until the job is complete.
+ |
+
void |
+awaitCompletion(long timeout,
+ java.util.concurrent.TimeUnit unit)
+Blocks until the job is complete.
+ |
+
FlowRunner |
+onFinished(FlowFinishedListener listener) |
+
FlowRunner |
+onItemComplete(FlowItemCompleteListener listener) |
+
FlowRunner |
+onItemFailed(FlowItemFailureListener listener) |
+
FlowRunner |
+onStatusChanged(FlowStatusListener listener) |
+
com.marklogic.client.datamovement.JobTicket |
+run() |
+
FlowRunner |
+withBatchSize(int batchSize) |
+
FlowRunner |
+withDestinationDatabase(java.lang.String destinationDatabase) |
+
FlowRunner |
+withFlow(Flow flow) |
+
FlowRunner |
+withOptions(java.util.Map<java.lang.String,java.lang.Object> options) |
+
FlowRunner |
+withSourceClient(com.marklogic.client.DatabaseClient sourceClient) |
+
FlowRunner |
+withStopOnFailure(boolean stopOnFailure) |
+
FlowRunner |
+withThreadCount(int threadCount) |
+
FlowRunner withFlow(Flow flow)+
FlowRunner withBatchSize(int batchSize)+
FlowRunner withThreadCount(int threadCount)+
FlowRunner withSourceClient(com.marklogic.client.DatabaseClient sourceClient)+
FlowRunner withDestinationDatabase(java.lang.String destinationDatabase)+
FlowRunner withOptions(java.util.Map<java.lang.String,java.lang.Object> options)+
FlowRunner withStopOnFailure(boolean stopOnFailure)+
FlowRunner onItemComplete(FlowItemCompleteListener listener)+
FlowRunner onItemFailed(FlowItemFailureListener listener)+
FlowRunner onStatusChanged(FlowStatusListener listener)+
FlowRunner onFinished(FlowFinishedListener listener)+
void awaitCompletion()+
void awaitCompletion(long timeout, + java.util.concurrent.TimeUnit unit) + throws java.lang.InterruptedException+
timeout
- the maximum time to waitunit
- the time unit of the timeout argumentjava.lang.InterruptedException
- if interrupted while waitingcom.marklogic.client.datamovement.JobTicket run()+
public interface FlowStatusListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+onStatusChange(java.lang.String jobId,
+ int percentComplete,
+ java.lang.String message) |
+
Enum Constant and Description | +
---|
HARMONIZE |
+
INPUT |
+
Modifier and Type | +Method and Description | +
---|---|
static FlowType |
+getFlowType(java.lang.String type) |
+
java.lang.String |
+toString() |
+
static FlowType |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static FlowType[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final FlowType INPUT+
public static final FlowType HARMONIZE+
public static FlowType[] values()+
+for (FlowType c : FlowType.values()) + System.out.println(c); +
public static FlowType valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static FlowType getFlowType(java.lang.String type)+
public java.lang.String toString()+
toString
in class java.lang.Enum<FlowType>
public class RunFlowResponse
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
java.util.List<java.lang.String> |
+completedItems |
+
long |
+errorCount |
+
java.util.List<com.fasterxml.jackson.databind.JsonNode> |
+errors |
+
java.util.List<java.lang.String> |
+failedItems |
+
long |
+totalCount |
+
Constructor and Description | +
---|
RunFlowResponse() |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+toString() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public long totalCount+
public long errorCount+
public java.util.List<java.lang.String> completedItems+
public java.util.List<java.lang.String> failedItems+
public java.util.List<com.fasterxml.jackson.databind.JsonNode> errors+
Modifier and Type | +Method and Description | +
---|---|
static Flow |
+fromXml(org.w3c.dom.Node xml) |
+
CodeFormat |
+getCodeFormat() |
+
Collector |
+getCollector() |
+
DataFormat |
+getDataFormat() |
+
java.lang.String |
+getEntityName() |
+
java.lang.String |
+getFlowDbPath() |
+
MainPlugin |
+getMain() |
+
java.lang.String |
+getName() |
+
FlowType |
+getType() |
+
static Flow |
+loadFromFile(java.io.File file) |
+
java.lang.String |
+serialize()
+Serializes the flow into an xml string
+ |
+
void |
+setCodeFormat(CodeFormat codeFormat) |
+
void |
+setCollector(Collector collector) |
+
void |
+setDataFormat(DataFormat dataFormat) |
+
void |
+setEntityName(java.lang.String entityName) |
+
void |
+setMain(MainPlugin main) |
+
void |
+setName(java.lang.String name) |
+
void |
+setType(FlowType type) |
+
java.util.Properties |
+toProperties() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public void setEntityName(java.lang.String entityName)+
setEntityName
in interface Flow
public java.lang.String getEntityName()+
getEntityName
in interface Flow
public void setName(java.lang.String name)+ +
public void setDataFormat(DataFormat dataFormat)+
setDataFormat
in interface Flow
public DataFormat getDataFormat()+
getDataFormat
in interface Flow
public void setCodeFormat(CodeFormat codeFormat)+
setCodeFormat
in interface Flow
public CodeFormat getCodeFormat()+
getCodeFormat
in interface Flow
public Collector getCollector()+
getCollector
in interface Flow
public void setCollector(Collector collector)+
setCollector
in interface Flow
public MainPlugin getMain()+ +
public void setMain(MainPlugin main)+ +
public java.lang.String serialize()+
public java.util.Properties toProperties()+
toProperties
in interface Flow
public static Flow loadFromFile(java.io.File file)+
public static Flow fromXml(org.w3c.dom.Node xml)+
public java.lang.String getFlowDbPath()+
getFlowDbPath
in interface Flow
public class FlowRunnerImpl +extends java.lang.Object +implements FlowRunner+
Constructor and Description | +
---|
FlowRunnerImpl(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+awaitCompletion()
+Blocks until the job is complete.
+ |
+
void |
+awaitCompletion(long timeout,
+ java.util.concurrent.TimeUnit unit)
+Blocks until the job is complete.
+ |
+
FlowRunner |
+onFinished(FlowFinishedListener listener) |
+
FlowRunner |
+onItemComplete(FlowItemCompleteListener listener) |
+
FlowRunner |
+onItemFailed(FlowItemFailureListener listener) |
+
FlowRunner |
+onStatusChanged(FlowStatusListener listener) |
+
com.marklogic.client.datamovement.JobTicket |
+run() |
+
FlowRunner |
+withBatchSize(int batchSize) |
+
FlowRunner |
+withDestinationDatabase(java.lang.String destinationDatabase) |
+
FlowRunner |
+withFlow(Flow flow) |
+
FlowRunner |
+withOptions(java.util.Map<java.lang.String,java.lang.Object> options) |
+
FlowRunner |
+withSourceClient(com.marklogic.client.DatabaseClient sourceClient) |
+
FlowRunner |
+withStopOnFailure(boolean stopOnFailure) |
+
FlowRunner |
+withThreadCount(int threadCount) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public FlowRunnerImpl(HubConfig hubConfig)+
public FlowRunner withFlow(Flow flow)+
withFlow
in interface FlowRunner
public FlowRunner withBatchSize(int batchSize)+
withBatchSize
in interface FlowRunner
public FlowRunner withThreadCount(int threadCount)+
withThreadCount
in interface FlowRunner
public FlowRunner withSourceClient(com.marklogic.client.DatabaseClient sourceClient)+
withSourceClient
in interface FlowRunner
public FlowRunner withDestinationDatabase(java.lang.String destinationDatabase)+
withDestinationDatabase
in interface FlowRunner
public FlowRunner withStopOnFailure(boolean stopOnFailure)+
withStopOnFailure
in interface FlowRunner
public FlowRunner withOptions(java.util.Map<java.lang.String,java.lang.Object> options)+
withOptions
in interface FlowRunner
public FlowRunner onItemComplete(FlowItemCompleteListener listener)+
onItemComplete
in interface FlowRunner
public FlowRunner onItemFailed(FlowItemFailureListener listener)+
onItemFailed
in interface FlowRunner
public FlowRunner onStatusChanged(FlowStatusListener listener)+
onStatusChanged
in interface FlowRunner
public FlowRunner onFinished(FlowFinishedListener listener)+
onFinished
in interface FlowRunner
public void awaitCompletion()+
FlowRunner
awaitCompletion
in interface FlowRunner
public void awaitCompletion(long timeout, + java.util.concurrent.TimeUnit unit) + throws java.lang.InterruptedException+
FlowRunner
awaitCompletion
in interface FlowRunner
timeout
- the maximum time to waitunit
- the time unit of the timeout argumentjava.lang.InterruptedException
- if interrupted while waitingpublic com.marklogic.client.datamovement.JobTicket run()+
run
in interface FlowRunner
Class | +Description | +
---|---|
FlowImpl | ++ |
FlowRunnerImpl | ++ |
Interface | +Description | +
---|---|
Flow | ++ |
FlowFinishedListener | ++ |
FlowItemCompleteListener | ++ |
FlowItemFailureListener | ++ |
FlowRunner | ++ |
FlowStatusListener | ++ |
Class | +Description | +
---|---|
FlowBuilder | ++ |
RunFlowResponse | ++ |
Enum | +Description | +
---|---|
CodeFormat | ++ |
DataFormat | ++ |
FlowType | ++ |
Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
static java.lang.String |
+MIN_UPGRADE_VERSION |
+
Constructor and Description | +
---|
DataHubImpl(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+clearDatabase(java.lang.String database)
+Clears the database of all documents
+ |
+
void |
+clearUserModules()
+Removes user's modules from the modules db
+ |
+
java.util.List<com.marklogic.appdeployer.command.Command> |
+getCommandList() |
+
java.lang.String |
+getPortInUseBy(DatabaseKind kind)
+Returns name of what is using the port
+ |
+
java.lang.String |
+getServerVersion()
+Returns the string presentation of the server version, eg: "9.03-1"
+ |
+
void |
+initProject()
+Initializes the project on disk, creates scaffold project code
+ |
+
void |
+install()
+Installs the data hub configuration and server-side config files into MarkLogic
+ |
+
void |
+install(HubDeployStatusListener listener)
+Installs the data hub configuration and server-side config files into MarkLogic
+ |
+
InstallInfo |
+isInstalled()
+Determines if the data hub is installed in MarkLogic
+ |
+
boolean |
+isPortInUse(DatabaseKind kind)
+Checks to see if the port is in use
+ |
+
boolean |
+isSafeToInstall()
+Checks to make sure all the versions and database in a valid configuration with version check
+ |
+
boolean |
+isServerVersionOk()
+Checks to see if the datahub and server versions are compatible
+ |
+
boolean |
+isServerVersionValid(java.lang.String versionString)
+Validates the MarkLogic server to ensure compatibility with the hub
+ |
+
java.util.HashMap |
+runPreInstallCheck()
+Runs the pre-install check for the datahub populating the object
+ with variables necessary to perform the install.
+ |
+
java.util.HashMap |
+runPreInstallCheck(Versions versions)
+Runs the pre-install check for the datahub populating the object
+ with variables necessary to perform the install.
+ |
+
void |
+setPortInUseBy(DatabaseKind kind,
+ java.lang.String usedBy)
+Sets what appserver name is using the port
+ |
+
void |
+setServerManager(com.marklogic.mgmt.resource.appservers.ServerManager manager) |
+
void |
+setServerVersion(java.lang.String serverVersion)
+Sets the server version holder on the datahub object - currently unused
+ |
+
void |
+setServerVersionOk(boolean serverVersionOk)
+Sets true or false if the server version is okay with this version of DHF
+ |
+
void |
+uninstall()
+Uninstalls the data hub configuration and server-side config files from MarkLogic
+ |
+
void |
+uninstall(HubDeployStatusListener listener)
+Uninstalls the data hub configuration and server-side config files from MarkLogic
+ |
+
void |
+updateIndexes()
+Updates the indexes in the database based on the project
+ |
+
boolean |
+upgradeHub()
+Upgrades the installed datahub on the server to this version of the DataHub
+ |
+
boolean |
+upgradeHub(java.util.List<java.lang.String> updatedFlows)
+Upgrades the hub based on list of provided updated flows.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
protected final org.slf4j.Logger logger+
public static java.lang.String MIN_UPGRADE_VERSION+
public void clearDatabase(java.lang.String database)+
DataHub
clearDatabase
in interface DataHub
database
- - the name of the database in string formpublic void setServerManager(com.marklogic.mgmt.resource.appservers.ServerManager manager)+
public InstallInfo isInstalled()+
DataHub
isInstalled
in interface DataHub
public boolean isServerVersionValid(java.lang.String versionString)+
DataHub
isServerVersionValid
in interface DataHub
versionString
- - the version of the server to validatepublic void initProject()+
DataHub
initProject
in interface DataHub
public void clearUserModules()+
DataHub
clearUserModules
in interface DataHub
public java.util.List<com.marklogic.appdeployer.command.Command> getCommandList()+
public java.util.HashMap runPreInstallCheck()+
DataHub
runPreInstallCheck
in interface DataHub
public java.util.HashMap runPreInstallCheck(Versions versions)+
DataHub
runPreInstallCheck
in interface DataHub
versions
- - the versions that the check is to be run againstpublic void install()+
public void install(HubDeployStatusListener listener)+
public void updateIndexes()+
DataHub
updateIndexes
in interface DataHub
public void uninstall()+
public void uninstall(HubDeployStatusListener listener)+
public boolean isSafeToInstall()+
DataHub
isSafeToInstall
in interface DataHub
public boolean isPortInUse(DatabaseKind kind)+
DataHub
isPortInUse
in interface DataHub
kind
- - the DatabaseKind enum value (ex STAGING or JOB)public void setPortInUseBy(DatabaseKind kind, + java.lang.String usedBy)+
DataHub
setPortInUseBy
in interface DataHub
kind
- - the DatabaseKind enum value (ex STAGING or JOB)usedBy
- - string name of what is using the portpublic java.lang.String getPortInUseBy(DatabaseKind kind)+
DataHub
getPortInUseBy
in interface DataHub
kind
- - the DatabaseKind enum value (ex STAGING or JOB)public boolean isServerVersionOk()+
DataHub
isServerVersionOk
in interface DataHub
public void setServerVersionOk(boolean serverVersionOk)+
DataHub
setServerVersionOk
in interface DataHub
serverVersionOk
- - true if it compatible or false if it is notpublic java.lang.String getServerVersion()+
DataHub
getServerVersion
in interface DataHub
public void setServerVersion(java.lang.String serverVersion)+
DataHub
setServerVersion
in interface DataHub
serverVersion
- - server version as a string, eg: "9.03-1"public boolean upgradeHub() + throws CantUpgradeException+
DataHub
upgradeHub
in interface DataHub
CantUpgradeException
- - exception thrown when an upgrade can't happenpublic boolean upgradeHub(java.util.List<java.lang.String> updatedFlows) + throws CantUpgradeException+
DataHub
upgradeHub
in interface DataHub
CantUpgradeException
- - should the hub fail to upgrade for incompatibility reasonsConstructor and Description | +
---|
DebuggingImpl(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+disable()
+Disables debugging
+ |
+
void |
+enable()
+Enables debugging
+ |
+
boolean |
+isEnabled()
+Determines if the hub has debugging enabled or not
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public DebuggingImpl(com.marklogic.client.DatabaseClient client)+
public class EntityManagerImpl +extends com.marklogic.client.ext.helper.LoggingObject +implements EntityManager+
logger
Constructor and Description | +
---|
EntityManagerImpl(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
java.util.HashMap<java.lang.Enum,java.lang.Boolean> |
+deployQueryOptions()
+Deploys the query option
+ |
+
boolean |
+saveDbIndexes()
+Updates the indexes for the entity on the filesystem
+ |
+
boolean |
+saveQueryOptions()
+Updates the query options to the file system
+ |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public EntityManagerImpl(HubConfig hubConfig)+
public boolean saveQueryOptions()+
EntityManager
saveQueryOptions
in interface EntityManager
public java.util.HashMap<java.lang.Enum,java.lang.Boolean> deployQueryOptions()+
EntityManager
deployQueryOptions
in interface EntityManager
public boolean saveDbIndexes()+
EntityManager
saveDbIndexes
in interface EntityManager
public class FlowManagerImpl +extends com.marklogic.client.extensions.ResourceManager +implements FlowManager+
Constructor and Description | +
---|
FlowManagerImpl(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName)
+Retrieves a named flow from a given entity
+ |
+
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType)
+Retrieves a named flow from a given entity
+ |
+
Flow |
+getFlowFromProperties(java.nio.file.Path propertiesFile)
+Obtains a flow from a property file
+ |
+
java.util.List<Flow> |
+getFlows(java.lang.String entityName)
+Retrieves a list of flows installed on the MarkLogic server
+ |
+
java.util.List<java.lang.String> |
+getLegacyFlows()
+Updates the indexes in the database based on the project
+ |
+
java.util.List<Flow> |
+getLocalFlows()
+retrieves a list of all the flows on the local files systems
+ |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName)
+retrieves a list of all the flows on the local files systems
+ |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName,
+ FlowType flowType)
+retrieves a list of all the flows on the local files systems
+ |
+
FlowRunner |
+newFlowRunner()
+Creates and returns a new FlowRunner object using the FlowManager's hubconfig
+ |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion)
+Sets the version that the legacy flow is to be updated from
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create, flowFromXml
public FlowManagerImpl(HubConfig hubConfig)+
public java.util.List<Flow> getLocalFlows()+
FlowManager
getLocalFlows
in interface FlowManager
public java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName)+
FlowManager
getLocalFlowsForEntity
in interface FlowManager
entityName
- - string name of the entity for the flowpublic java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName, + FlowType flowType)+
FlowManager
getLocalFlowsForEntity
in interface FlowManager
entityName
- - string name of the entity for the flowflowType
- - the FlowType enum, eg: ingest or harmonizepublic Flow getFlowFromProperties(java.nio.file.Path propertiesFile)+
FlowManager
getFlowFromProperties
in interface FlowManager
propertiesFile
- - the Path to the property filepublic java.util.List<Flow> getFlows(java.lang.String entityName)+
FlowManager
getFlows
in interface FlowManager
entityName
- - the entity from which to fetch the flowspublic Flow getFlow(java.lang.String entityName, + java.lang.String flowName)+
FlowManager
getFlow
in interface FlowManager
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getpublic Flow getFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
FlowManager
getFlow
in interface FlowManager
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getflowType
- - the type of flow (ingest/harmonize)public java.util.List<java.lang.String> getLegacyFlows()+
FlowManager
getLegacyFlows
in interface FlowManager
public java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion)+
FlowManager
updateLegacyFlows
in interface FlowManager
fromVersion
- - string representation of DHF versionpublic FlowRunner newFlowRunner()+
FlowManager
newFlowRunner
in interface FlowManager
public class HubConfigBuilderImpl +extends java.lang.Object +implements HubConfigBuilder+
+ HubConfig hubConfig = HubConfigBuilder.newHubConfigBuilder("/path/to/your/project")
+ .withPropertiesFromEnvironment("local")
+ .build();
+
Constructor and Description | +
---|
HubConfigBuilderImpl(java.lang.String projectDir) |
+
Modifier and Type | +Method and Description | +
---|---|
HubConfig |
+build()
+Builds the
+HubConfig instance |
+
HubConfigBuilder |
+withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)
+Sets the
+AdminConfig for the HubConfig |
+
HubConfigBuilder |
+withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)
+Sets the
+AdminManager for the HubConfig |
+
HubConfigBuilder |
+withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)
+Sets the
+AppConfig for the HubConfig |
+
HubConfigBuilder |
+withManageClient(com.marklogic.mgmt.ManageClient manageClient)
+Sets the
+ManageClient for the HubConfig |
+
HubConfigBuilder |
+withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)
+Sets the
+ManageConfig for the HubConfig |
+
HubConfigBuilder |
+withProperties(java.util.Properties properties)
+Tells the builder to use the given properties.
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment()
+Tells the builder to load properties from the gradle files in the project dir
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment(java.lang.String environment)
+Tells the builder to load properties from the gradle files in the project dir
+ but to look for an environment properties file with overrides
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
newHubConfigBuilder
public HubConfigBuilderImpl(java.lang.String projectDir)+
public HubConfigBuilder withPropertiesFromEnvironment()+
HubConfigBuilder
withPropertiesFromEnvironment
in interface HubConfigBuilder
HubConfigBuilder
instancepublic HubConfigBuilder withPropertiesFromEnvironment(java.lang.String environment)+
HubConfigBuilder
withPropertiesFromEnvironment
in interface HubConfigBuilder
environment
- - the name of the environment to use (local,dev,qa,prod,...)HubConfigBuilder
instancepublic HubConfigBuilder withProperties(java.util.Properties properties)+
HubConfigBuilder
withProperties
in interface HubConfigBuilder
properties
- - A Properties
object with properties setHubConfigBuilder
instancepublic HubConfigBuilder withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)+
HubConfigBuilder
AppConfig
for the HubConfig
withAppConfig
in interface HubConfigBuilder
appConfig
- - an AppConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
HubConfigBuilder
AdminConfig
for the HubConfig
withAdminConfig
in interface HubConfigBuilder
adminConfig
- - an AdminConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
HubConfigBuilder
AdminManager
for the HubConfig
withAdminManager
in interface HubConfigBuilder
adminManager
- - an AdminManager
objectHubConfigBuilder
instancepublic HubConfigBuilder withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
HubConfigBuilder
ManageConfig
for the HubConfig
withManageConfig
in interface HubConfigBuilder
manageConfig
- - a ManageConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withManageClient(com.marklogic.mgmt.ManageClient manageClient)+
HubConfigBuilder
ManageClient
for the HubConfig
withManageClient
in interface HubConfigBuilder
manageClient
- - a ManageClient
HubConfigBuilder
instancepublic HubConfig build()+
HubConfigBuilder
HubConfig
instancebuild
in interface HubConfigBuilder
HubConfig
Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
DEFAULT_AUTH_METHOD, DEFAULT_CUSTOM_FOREST_PATH, DEFAULT_FINAL_NAME, DEFAULT_FINAL_PORT, DEFAULT_FORESTS_PER_HOST, DEFAULT_JOB_NAME, DEFAULT_JOB_PORT, DEFAULT_MODULES_DB_NAME, DEFAULT_ROLE_NAME, DEFAULT_SCHEMAS_DB_NAME, DEFAULT_SCHEME, DEFAULT_STAGING_NAME, DEFAULT_STAGING_PORT, DEFAULT_TRACE_NAME, DEFAULT_TRACE_PORT, DEFAULT_TRIGGERS_DB_NAME, DEFAULT_USER_NAME, ENTITY_CONFIG_DIR, FINAL_ENTITY_SEARCH_OPTIONS_FILE, HUB_CONFIG_DIR, HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES, STAGING_ENTITY_SEARCH_OPTIONS_FILE, USER_CONFIG_DIR, USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES, USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
Constructor and Description | +
---|
HubConfigImpl() |
+
HubConfigImpl(java.lang.String projectDir) |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.mgmt.admin.AdminConfig |
+getAdminConfig() |
+
com.marklogic.mgmt.admin.AdminManager |
+getAdminManager() |
+
com.marklogic.appdeployer.AppConfig |
+getAppConfig() |
+
java.lang.String |
+getCustomForestPath() |
+
java.nio.file.Path |
+getEntityDatabaseDir() |
+
java.lang.String |
+getFinalAuthMethod() |
+
java.lang.String |
+getFinalCertFile() |
+
java.lang.String |
+getFinalCertPassword() |
+
java.lang.String |
+getFinalDbName() |
+
java.lang.String |
+getFinalExternalName() |
+
java.lang.Integer |
+getFinalForestsPerHost() |
+
java.lang.String |
+getFinalHttpName() |
+
java.lang.Integer |
+getFinalPort() |
+
java.lang.String |
+getFinalScheme() |
+
boolean |
+getFinalSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getFinalSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getFinalSslHostnameVerifier() |
+
java.lang.String |
+getHost() |
+
java.nio.file.Path |
+getHubConfigDir() |
+
java.nio.file.Path |
+getHubDatabaseDir() |
+
java.nio.file.Path |
+getHubEntitiesDir() |
+
java.nio.file.Path |
+getHubMimetypesDir() |
+
java.lang.String |
+getHubModulesDeployTimestampFile() |
+
java.nio.file.Path |
+getHubPluginsDir() |
+
HubProject |
+getHubProject() |
+
java.lang.String |
+getHubRoleName() |
+
java.nio.file.Path |
+getHubSecurityDir() |
+
java.nio.file.Path |
+getHubServersDir() |
+
java.lang.String |
+getHubUserName() |
+
java.lang.String |
+getJarVersion() |
+
java.lang.String |
+getJobAuthMethod() |
+
java.lang.String |
+getJobCertFile() |
+
java.lang.String |
+getJobCertPassword() |
+
java.lang.String |
+getJobDbName() |
+
java.lang.String |
+getJobExternalName() |
+
java.lang.Integer |
+getJobForestsPerHost() |
+
java.lang.String |
+getJobHttpName() |
+
java.lang.Integer |
+getJobPort() |
+
java.lang.String |
+getJobScheme() |
+
boolean |
+getJobSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getJobSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getJobSslHostnameVerifier() |
+
java.lang.String[] |
+getLoadBalancerHosts() |
+
com.marklogic.mgmt.ManageClient |
+getManageClient() |
+
com.marklogic.mgmt.ManageConfig |
+getManageConfig() |
+
java.lang.String |
+getModulePermissions() |
+
java.lang.String |
+getModulesDbName() |
+
java.lang.Integer |
+getModulesForestsPerHost() |
+
java.lang.String |
+getProjectDir() |
+
java.lang.String |
+getSchemasDbName() |
+
java.lang.Integer |
+getSchemasForestsPerHost() |
+
java.lang.String |
+getStagingAuthMethod() |
+
java.lang.String |
+getStagingCertFile() |
+
java.lang.String |
+getStagingCertPassword() |
+
java.lang.String |
+getStagingDbName() |
+
java.lang.String |
+getStagingExternalName() |
+
java.lang.Integer |
+getStagingForestsPerHost() |
+
java.lang.String |
+getStagingHttpName() |
+
java.lang.Integer |
+getStagingPort() |
+
java.lang.String |
+getStagingScheme() |
+
boolean |
+getStagingSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getStagingSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getStagingSslHostnameVerifier() |
+
java.lang.String |
+getTraceAuthMethod() |
+
java.lang.String |
+getTraceCertFile() |
+
java.lang.String |
+getTraceCertPassword() |
+
java.lang.String |
+getTraceDbName() |
+
java.lang.String |
+getTraceExternalName() |
+
java.lang.Integer |
+getTraceForestsPerHost() |
+
java.lang.String |
+getTraceHttpName() |
+
java.lang.Integer |
+getTracePort() |
+
java.lang.String |
+getTraceScheme() |
+
boolean |
+getTraceSimpleSsl() |
+
javax.net.ssl.SSLContext |
+getTraceSslContext() |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getTraceSslHostnameVerifier() |
+
java.lang.String |
+getTriggersDbName() |
+
java.lang.Integer |
+getTriggersForestsPerHost() |
+
java.nio.file.Path |
+getUserConfigDir() |
+
java.io.File |
+getUserContentDeployTimestampFile() |
+
java.nio.file.Path |
+getUserDatabaseDir() |
+
java.lang.String |
+getUserModulesDeployTimestampFile() |
+
java.nio.file.Path |
+getUserSecurityDir() |
+
java.nio.file.Path |
+getUserServersDir() |
+
void |
+initHubProject() |
+
void |
+loadConfigurationFromProperties(java.util.Properties environmentProperties) |
+
com.marklogic.client.DatabaseClient |
+newAppServicesClient() |
+
com.marklogic.client.DatabaseClient |
+newFinalClient()
+Creates a new DatabaseClient for accessing the Final database
+ |
+
com.marklogic.client.DatabaseClient |
+newJobDbClient()
+Creates a new DatabaseClient for accessing the Job database
+ |
+
com.marklogic.client.DatabaseClient |
+newModulesDbClient()
+Creates a new DatabaseClient for accessing the Hub Modules database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient()
+Creates a new DatabaseClient for accessing the Staging database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient(java.lang.String databaseName) |
+
com.marklogic.client.DatabaseClient |
+newTraceDbClient()
+Creates a new DatabaseClient for accessing the Trace database
+ |
+
void |
+setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig) |
+
void |
+setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager) |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config) |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config,
+ boolean skipUpdate) |
+
void |
+setCustomForestPath(java.lang.String customForestPath) |
+
void |
+setFinalAuthMethod(java.lang.String finalAuthMethod) |
+
void |
+setFinalCertFile(java.lang.String finalCertFile) |
+
void |
+setFinalCertPassword(java.lang.String finalCertPassword) |
+
void |
+setFinalDbName(java.lang.String finalDbName) |
+
void |
+setFinalExternalName(java.lang.String finalExternalName) |
+
void |
+setFinalForestsPerHost(java.lang.Integer finalForestsPerHost) |
+
void |
+setFinalHttpName(java.lang.String finalHttpName) |
+
void |
+setFinalPort(java.lang.Integer finalPort) |
+
void |
+setFinalScheme(java.lang.String finalScheme) |
+
void |
+setFinalSimpleSsl(boolean finalSimpleSsl) |
+
void |
+setFinalSslContext(javax.net.ssl.SSLContext finalSslContext) |
+
void |
+setFinalSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier finalSslHostnameVerifier) |
+
void |
+setHubRoleName(java.lang.String hubRoleName) |
+
void |
+setHubUserName(java.lang.String hubUserName) |
+
void |
+setJobAuthMethod(java.lang.String jobAuthMethod) |
+
void |
+setJobCertFile(java.lang.String jobCertFile) |
+
void |
+setJobCertPassword(java.lang.String jobCertPassword) |
+
void |
+setJobDbName(java.lang.String jobDbName) |
+
void |
+setJobExternalName(java.lang.String jobExternalName) |
+
void |
+setJobForestsPerHost(java.lang.Integer jobForestsPerHost) |
+
void |
+setJobHttpName(java.lang.String jobHttpName) |
+
void |
+setJobPort(java.lang.Integer jobPort) |
+
void |
+setJobScheme(java.lang.String jobScheme) |
+
void |
+setJobSimpleSsl(boolean jobSimpleSsl) |
+
void |
+setJobSslContext(javax.net.ssl.SSLContext jobSslContext) |
+
void |
+setJobSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier jobSslHostnameVerifier) |
+
void |
+setLoadBalancerHosts(java.lang.String[] loadBalancerHosts) |
+
void |
+setManageClient(com.marklogic.mgmt.ManageClient manageClient) |
+
void |
+setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig) |
+
void |
+setModulePermissions(java.lang.String modulePermissions) |
+
void |
+setModulesDbName(java.lang.String modulesDbName) |
+
void |
+setModulesForestsPerHost(java.lang.Integer modulesForestsPerHost) |
+
void |
+setProjectDir(java.lang.String projectDir) |
+
void |
+setSchemasDbName(java.lang.String schemasDbName) |
+
void |
+setSchemasForestsPerHost(java.lang.Integer schemasForestsPerHost) |
+
void |
+setStagingAuthMethod(java.lang.String stagingAuthMethod) |
+
void |
+setStagingCertFile(java.lang.String stagingCertFile) |
+
void |
+setStagingCertPassword(java.lang.String stagingCertPassword) |
+
void |
+setStagingDbName(java.lang.String stagingDbName) |
+
void |
+setStagingExternalName(java.lang.String stagingExternalName) |
+
void |
+setStagingForestsPerHost(java.lang.Integer stagingForestsPerHost) |
+
void |
+setStagingHttpName(java.lang.String stagingHttpName) |
+
void |
+setStagingPort(java.lang.Integer stagingPort) |
+
void |
+setStagingScheme(java.lang.String stagingScheme) |
+
void |
+setStagingSimpleSsl(boolean stagingSimpleSsl) |
+
void |
+setStagingSslContext(javax.net.ssl.SSLContext stagingSslContext) |
+
void |
+setStagingSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier) |
+
void |
+setTraceAuthMethod(java.lang.String traceAuthMethod) |
+
void |
+setTraceCertFile(java.lang.String traceCertFile) |
+
void |
+setTraceCertPassword(java.lang.String traceCertPassword) |
+
void |
+setTraceDbName(java.lang.String traceDbName) |
+
void |
+setTraceExternalName(java.lang.String traceExternalName) |
+
void |
+setTraceForestsPerHost(java.lang.Integer traceForestsPerHost) |
+
void |
+setTraceHttpName(java.lang.String traceHttpName) |
+
void |
+setTracePort(java.lang.Integer tracePort) |
+
void |
+setTraceScheme(java.lang.String traceScheme) |
+
void |
+setTraceSimpleSsl(boolean traceSimpleSsl) |
+
void |
+setTraceSslContext(javax.net.ssl.SSLContext traceSslContext) |
+
void |
+setTraceSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier traceSslHostnameVerifier) |
+
void |
+setTriggersDbName(java.lang.String triggersDbName) |
+
void |
+setTriggersForestsPerHost(java.lang.Integer triggersForestsPerHost) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public HubConfigImpl(java.lang.String projectDir)+
public HubConfigImpl()+
public java.lang.String getHost()+ +
public java.lang.String getStagingDbName()+
getStagingDbName
in interface HubConfig
public void setStagingDbName(java.lang.String stagingDbName)+
setStagingDbName
in interface HubConfig
public java.lang.String getStagingHttpName()+
getStagingHttpName
in interface HubConfig
public void setStagingHttpName(java.lang.String stagingHttpName)+
setStagingHttpName
in interface HubConfig
public java.lang.Integer getStagingForestsPerHost()+
getStagingForestsPerHost
in interface HubConfig
public void setStagingForestsPerHost(java.lang.Integer stagingForestsPerHost)+
setStagingForestsPerHost
in interface HubConfig
public java.lang.Integer getStagingPort()+
getStagingPort
in interface HubConfig
public void setStagingPort(java.lang.Integer stagingPort)+
setStagingPort
in interface HubConfig
public java.lang.String getStagingAuthMethod()+
getStagingAuthMethod
in interface HubConfig
public void setStagingAuthMethod(java.lang.String stagingAuthMethod)+
setStagingAuthMethod
in interface HubConfig
public java.lang.String getStagingScheme()+
getStagingScheme
in interface HubConfig
public void setStagingScheme(java.lang.String stagingScheme)+
setStagingScheme
in interface HubConfig
public boolean getStagingSimpleSsl()+
getStagingSimpleSsl
in interface HubConfig
public void setStagingSimpleSsl(boolean stagingSimpleSsl)+
setStagingSimpleSsl
in interface HubConfig
public javax.net.ssl.SSLContext getStagingSslContext()+
getStagingSslContext
in interface HubConfig
public void setStagingSslContext(javax.net.ssl.SSLContext stagingSslContext)+
setStagingSslContext
in interface HubConfig
public com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getStagingSslHostnameVerifier()+
getStagingSslHostnameVerifier
in interface HubConfig
public void setStagingSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier)+
setStagingSslHostnameVerifier
in interface HubConfig
public java.lang.String getStagingCertFile()+
getStagingCertFile
in interface HubConfig
public void setStagingCertFile(java.lang.String stagingCertFile)+
setStagingCertFile
in interface HubConfig
public java.lang.String getStagingCertPassword()+
getStagingCertPassword
in interface HubConfig
public void setStagingCertPassword(java.lang.String stagingCertPassword)+
setStagingCertPassword
in interface HubConfig
public java.lang.String getStagingExternalName()+
getStagingExternalName
in interface HubConfig
public void setStagingExternalName(java.lang.String stagingExternalName)+
setStagingExternalName
in interface HubConfig
public java.lang.String getFinalDbName()+
getFinalDbName
in interface HubConfig
public void setFinalDbName(java.lang.String finalDbName)+
setFinalDbName
in interface HubConfig
public java.lang.String getFinalHttpName()+
getFinalHttpName
in interface HubConfig
public void setFinalHttpName(java.lang.String finalHttpName)+
setFinalHttpName
in interface HubConfig
public java.lang.Integer getFinalForestsPerHost()+
getFinalForestsPerHost
in interface HubConfig
public void setFinalForestsPerHost(java.lang.Integer finalForestsPerHost)+
setFinalForestsPerHost
in interface HubConfig
public java.lang.Integer getFinalPort()+
getFinalPort
in interface HubConfig
public void setFinalPort(java.lang.Integer finalPort)+
setFinalPort
in interface HubConfig
public java.lang.String getFinalAuthMethod()+
getFinalAuthMethod
in interface HubConfig
public void setFinalAuthMethod(java.lang.String finalAuthMethod)+
setFinalAuthMethod
in interface HubConfig
public java.lang.String getFinalScheme()+
getFinalScheme
in interface HubConfig
public void setFinalScheme(java.lang.String finalScheme)+
setFinalScheme
in interface HubConfig
public boolean getFinalSimpleSsl()+
getFinalSimpleSsl
in interface HubConfig
public void setFinalSimpleSsl(boolean finalSimpleSsl)+
setFinalSimpleSsl
in interface HubConfig
public javax.net.ssl.SSLContext getFinalSslContext()+
getFinalSslContext
in interface HubConfig
public void setFinalSslContext(javax.net.ssl.SSLContext finalSslContext)+
setFinalSslContext
in interface HubConfig
public com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getFinalSslHostnameVerifier()+
getFinalSslHostnameVerifier
in interface HubConfig
public void setFinalSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier finalSslHostnameVerifier)+
setFinalSslHostnameVerifier
in interface HubConfig
public java.lang.String getFinalCertFile()+
getFinalCertFile
in interface HubConfig
public void setFinalCertFile(java.lang.String finalCertFile)+
setFinalCertFile
in interface HubConfig
public java.lang.String getFinalCertPassword()+
getFinalCertPassword
in interface HubConfig
public void setFinalCertPassword(java.lang.String finalCertPassword)+
setFinalCertPassword
in interface HubConfig
public java.lang.String getFinalExternalName()+
getFinalExternalName
in interface HubConfig
public void setFinalExternalName(java.lang.String finalExternalName)+
setFinalExternalName
in interface HubConfig
public java.lang.String getTraceDbName()+
getTraceDbName
in interface HubConfig
public void setTraceDbName(java.lang.String traceDbName)+
setTraceDbName
in interface HubConfig
public java.lang.String getTraceHttpName()+
getTraceHttpName
in interface HubConfig
public void setTraceHttpName(java.lang.String traceHttpName)+
setTraceHttpName
in interface HubConfig
public java.lang.Integer getTraceForestsPerHost()+
getTraceForestsPerHost
in interface HubConfig
public void setTraceForestsPerHost(java.lang.Integer traceForestsPerHost)+
setTraceForestsPerHost
in interface HubConfig
public java.lang.Integer getTracePort()+
getTracePort
in interface HubConfig
public void setTracePort(java.lang.Integer tracePort)+
setTracePort
in interface HubConfig
public java.lang.String getTraceAuthMethod()+
getTraceAuthMethod
in interface HubConfig
public void setTraceAuthMethod(java.lang.String traceAuthMethod)+
setTraceAuthMethod
in interface HubConfig
public java.lang.String getTraceScheme()+
getTraceScheme
in interface HubConfig
public void setTraceScheme(java.lang.String traceScheme)+
setTraceScheme
in interface HubConfig
public boolean getTraceSimpleSsl()+
getTraceSimpleSsl
in interface HubConfig
public void setTraceSimpleSsl(boolean traceSimpleSsl)+
setTraceSimpleSsl
in interface HubConfig
public javax.net.ssl.SSLContext getTraceSslContext()+
getTraceSslContext
in interface HubConfig
public void setTraceSslContext(javax.net.ssl.SSLContext traceSslContext)+
setTraceSslContext
in interface HubConfig
public com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getTraceSslHostnameVerifier()+
getTraceSslHostnameVerifier
in interface HubConfig
public void setTraceSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier traceSslHostnameVerifier)+
setTraceSslHostnameVerifier
in interface HubConfig
public java.lang.String getTraceCertFile()+
getTraceCertFile
in interface HubConfig
public void setTraceCertFile(java.lang.String traceCertFile)+
setTraceCertFile
in interface HubConfig
public java.lang.String getTraceCertPassword()+
getTraceCertPassword
in interface HubConfig
public void setTraceCertPassword(java.lang.String traceCertPassword)+
setTraceCertPassword
in interface HubConfig
public java.lang.String getTraceExternalName()+
getTraceExternalName
in interface HubConfig
public void setTraceExternalName(java.lang.String traceExternalName)+
setTraceExternalName
in interface HubConfig
public java.lang.String getJobDbName()+
getJobDbName
in interface HubConfig
public void setJobDbName(java.lang.String jobDbName)+
setJobDbName
in interface HubConfig
public java.lang.String getJobHttpName()+
getJobHttpName
in interface HubConfig
public void setJobHttpName(java.lang.String jobHttpName)+
setJobHttpName
in interface HubConfig
public java.lang.Integer getJobForestsPerHost()+
getJobForestsPerHost
in interface HubConfig
public void setJobForestsPerHost(java.lang.Integer jobForestsPerHost)+
setJobForestsPerHost
in interface HubConfig
public java.lang.Integer getJobPort()+
getJobPort
in interface HubConfig
public void setJobPort(java.lang.Integer jobPort)+
setJobPort
in interface HubConfig
public java.lang.String getJobAuthMethod()+
getJobAuthMethod
in interface HubConfig
public void setJobAuthMethod(java.lang.String jobAuthMethod)+
setJobAuthMethod
in interface HubConfig
public java.lang.String getJobScheme()+
getJobScheme
in interface HubConfig
public void setJobScheme(java.lang.String jobScheme)+
setJobScheme
in interface HubConfig
public boolean getJobSimpleSsl()+
getJobSimpleSsl
in interface HubConfig
public void setJobSimpleSsl(boolean jobSimpleSsl)+
setJobSimpleSsl
in interface HubConfig
public javax.net.ssl.SSLContext getJobSslContext()+
getJobSslContext
in interface HubConfig
public void setJobSslContext(javax.net.ssl.SSLContext jobSslContext)+
setJobSslContext
in interface HubConfig
public com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getJobSslHostnameVerifier()+
getJobSslHostnameVerifier
in interface HubConfig
public void setJobSslHostnameVerifier(com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier jobSslHostnameVerifier)+
setJobSslHostnameVerifier
in interface HubConfig
public java.lang.String getJobCertFile()+
getJobCertFile
in interface HubConfig
public void setJobCertFile(java.lang.String jobCertFile)+
setJobCertFile
in interface HubConfig
public java.lang.String getJobCertPassword()+
getJobCertPassword
in interface HubConfig
public void setJobCertPassword(java.lang.String jobCertPassword)+
setJobCertPassword
in interface HubConfig
public java.lang.String getJobExternalName()+
getJobExternalName
in interface HubConfig
public void setJobExternalName(java.lang.String jobExternalName)+
setJobExternalName
in interface HubConfig
public java.lang.String getModulesDbName()+
getModulesDbName
in interface HubConfig
public void setModulesDbName(java.lang.String modulesDbName)+
setModulesDbName
in interface HubConfig
public java.lang.Integer getModulesForestsPerHost()+
getModulesForestsPerHost
in interface HubConfig
public void setModulesForestsPerHost(java.lang.Integer modulesForestsPerHost)+
setModulesForestsPerHost
in interface HubConfig
public java.lang.String getTriggersDbName()+
getTriggersDbName
in interface HubConfig
public void setTriggersDbName(java.lang.String triggersDbName)+
setTriggersDbName
in interface HubConfig
public java.lang.Integer getTriggersForestsPerHost()+
getTriggersForestsPerHost
in interface HubConfig
public void setTriggersForestsPerHost(java.lang.Integer triggersForestsPerHost)+
setTriggersForestsPerHost
in interface HubConfig
public java.lang.String getSchemasDbName()+
getSchemasDbName
in interface HubConfig
public void setSchemasDbName(java.lang.String schemasDbName)+
setSchemasDbName
in interface HubConfig
public java.lang.Integer getSchemasForestsPerHost()+
getSchemasForestsPerHost
in interface HubConfig
public void setSchemasForestsPerHost(java.lang.Integer schemasForestsPerHost)+
setSchemasForestsPerHost
in interface HubConfig
public java.lang.String getHubRoleName()+
getHubRoleName
in interface HubConfig
public void setHubRoleName(java.lang.String hubRoleName)+
setHubRoleName
in interface HubConfig
public java.lang.String getHubUserName()+
getHubUserName
in interface HubConfig
public void setHubUserName(java.lang.String hubUserName)+
setHubUserName
in interface HubConfig
public java.lang.String[] getLoadBalancerHosts()+
getLoadBalancerHosts
in interface HubConfig
public void setLoadBalancerHosts(java.lang.String[] loadBalancerHosts)+
setLoadBalancerHosts
in interface HubConfig
public java.lang.String getCustomForestPath()+
getCustomForestPath
in interface HubConfig
public void setCustomForestPath(java.lang.String customForestPath)+
setCustomForestPath
in interface HubConfig
public java.lang.String getModulePermissions()+
getModulePermissions
in interface HubConfig
public void setModulePermissions(java.lang.String modulePermissions)+
setModulePermissions
in interface HubConfig
public java.lang.String getProjectDir()+
getProjectDir
in interface HubConfig
public void setProjectDir(java.lang.String projectDir)+
setProjectDir
in interface HubConfig
public HubProject getHubProject()+
getHubProject
in interface HubConfig
public void initHubProject()+
initHubProject
in interface HubConfig
public java.lang.String getHubModulesDeployTimestampFile()+
getHubModulesDeployTimestampFile
in interface HubConfig
public java.lang.String getUserModulesDeployTimestampFile()+
getUserModulesDeployTimestampFile
in interface HubConfig
public java.io.File getUserContentDeployTimestampFile()+
getUserContentDeployTimestampFile
in interface HubConfig
public void loadConfigurationFromProperties(java.util.Properties environmentProperties)+
public com.marklogic.mgmt.ManageConfig getManageConfig()+
getManageConfig
in interface HubConfig
public void setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
setManageConfig
in interface HubConfig
public com.marklogic.mgmt.ManageClient getManageClient()+
getManageClient
in interface HubConfig
public void setManageClient(com.marklogic.mgmt.ManageClient manageClient)+
setManageClient
in interface HubConfig
public com.marklogic.mgmt.admin.AdminConfig getAdminConfig()+
getAdminConfig
in interface HubConfig
public void setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
setAdminConfig
in interface HubConfig
public com.marklogic.mgmt.admin.AdminManager getAdminManager()+
getAdminManager
in interface HubConfig
public void setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
setAdminManager
in interface HubConfig
public com.marklogic.client.DatabaseClient newAppServicesClient()+
newAppServicesClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newStagingClient()+
newStagingClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newStagingClient(java.lang.String databaseName)+
newStagingClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newFinalClient()+
newFinalClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newJobDbClient()+
newJobDbClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newTraceDbClient()+
newTraceDbClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newModulesDbClient()+
newModulesDbClient
in interface HubConfig
public java.nio.file.Path getHubPluginsDir()+
getHubPluginsDir
in interface HubConfig
public java.nio.file.Path getHubEntitiesDir()+
getHubEntitiesDir
in interface HubConfig
public java.nio.file.Path getHubConfigDir()+
getHubConfigDir
in interface HubConfig
public java.nio.file.Path getHubDatabaseDir()+
getHubDatabaseDir
in interface HubConfig
public java.nio.file.Path getHubServersDir()+
getHubServersDir
in interface HubConfig
public java.nio.file.Path getHubSecurityDir()+
getHubSecurityDir
in interface HubConfig
public java.nio.file.Path getUserSecurityDir()+
getUserSecurityDir
in interface HubConfig
public java.nio.file.Path getUserConfigDir()+
getUserConfigDir
in interface HubConfig
public java.nio.file.Path getUserDatabaseDir()+
getUserDatabaseDir
in interface HubConfig
public java.nio.file.Path getEntityDatabaseDir()+
getEntityDatabaseDir
in interface HubConfig
public java.nio.file.Path getUserServersDir()+
getUserServersDir
in interface HubConfig
public java.nio.file.Path getHubMimetypesDir()+
getHubMimetypesDir
in interface HubConfig
public com.marklogic.appdeployer.AppConfig getAppConfig()+
getAppConfig
in interface HubConfig
public void setAppConfig(com.marklogic.appdeployer.AppConfig config)+
setAppConfig
in interface HubConfig
public void setAppConfig(com.marklogic.appdeployer.AppConfig config, + boolean skipUpdate)+
setAppConfig
in interface HubConfig
public java.lang.String getJarVersion() + throws java.io.IOException+
getJarVersion
in interface HubConfig
java.io.IOException
public class HubProjectImpl +extends java.lang.Object +implements HubProject+
Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+ENTITY_CONFIG_DIR |
+
protected org.slf4j.Logger |
+logger |
+
HUB_CONFIG_DIR, USER_CONFIG_DIR
Constructor and Description | +
---|
HubProjectImpl(java.lang.String projectDirStr) |
+
Modifier and Type | +Method and Description | +
---|---|
java.nio.file.Path |
+getEntityConfigDir()
+Gets the path for the user server's directory
+ |
+
java.nio.file.Path |
+getEntityDatabaseDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getHubConfigDir()
+Gets the path for the hub's entities directory
+ |
+
java.nio.file.Path |
+getHubDatabaseDir()
+Gets the path for the hub's config directory
+ |
+
java.nio.file.Path |
+getHubEntitiesDir()
+Gets the path for the hub plugins directory
+ |
+
java.nio.file.Path |
+getHubPluginsDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getHubSecurityDir()
+Gets the path for the hub servers directory
+ |
+
java.nio.file.Path |
+getHubServersDir()
+Gets the path for the hub's database directory
+ |
+
java.nio.file.Path |
+getUserConfigDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getUserDatabaseDir()
+Gets the path for the user security directory
+ |
+
java.nio.file.Path |
+getUserSchemasDir()
+Gets the path for the user schemas directory
+ |
+
java.nio.file.Path |
+getUserSecurityDir()
+Gets the path for the user config directory
+ |
+
java.nio.file.Path |
+getUserServersDir()
+Gets the path for the entity database directory
+ |
+
void |
+init(java.util.Map<java.lang.String,java.lang.String> customTokens)
+Initializes a directory as a hub project directory.
+ |
+
boolean |
+isInitialized()
+Checks if the project has been initialized or not
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public static final java.lang.String ENTITY_CONFIG_DIR+
protected final org.slf4j.Logger logger+
public HubProjectImpl(java.lang.String projectDirStr)+
public java.nio.file.Path getHubPluginsDir()+
HubProject
getHubPluginsDir
in interface HubProject
public java.nio.file.Path getHubEntitiesDir()+
HubProject
getHubEntitiesDir
in interface HubProject
public java.nio.file.Path getHubConfigDir()+
HubProject
getHubConfigDir
in interface HubProject
public java.nio.file.Path getHubDatabaseDir()+
HubProject
getHubDatabaseDir
in interface HubProject
public java.nio.file.Path getHubServersDir()+
HubProject
getHubServersDir
in interface HubProject
public java.nio.file.Path getHubSecurityDir()+
HubProject
getHubSecurityDir
in interface HubProject
public java.nio.file.Path getUserConfigDir()+
HubProject
getUserConfigDir
in interface HubProject
public java.nio.file.Path getUserSecurityDir()+
HubProject
getUserSecurityDir
in interface HubProject
public java.nio.file.Path getUserDatabaseDir()+
HubProject
getUserDatabaseDir
in interface HubProject
public java.nio.file.Path getUserSchemasDir()+
HubProject
getUserSchemasDir
in interface HubProject
public java.nio.file.Path getUserServersDir()+
HubProject
getUserServersDir
in interface HubProject
public java.nio.file.Path getEntityConfigDir()+
HubProject
getEntityConfigDir
in interface HubProject
public java.nio.file.Path getEntityDatabaseDir()+
HubProject
getEntityDatabaseDir
in interface HubProject
public boolean isInitialized()+
HubProject
isInitialized
in interface HubProject
public void init(java.util.Map<java.lang.String,java.lang.String> customTokens)+
HubProject
init
in interface HubProject
customTokens
- - some custom tokens to start withpublic class InstallInfoImpl +extends java.lang.Object +implements InstallInfo+
Constructor and Description | +
---|
InstallInfoImpl() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+areForestsExistent(DatabaseKind kind)
+Checks to see if the forests are present and accessible
+ |
+
boolean |
+isAppServerExistent(DatabaseKind kind)
+Checks to see if the App Server is present and accessible
+ |
+
boolean |
+isCollectionLexiconOn(DatabaseKind kind)
+Checks to see if the lexicon collection is set and on
+ |
+
boolean |
+isDbExistent(DatabaseKind kind)
+Checks to see if the Database is present and accessible
+ |
+
boolean |
+isInstalled()
+Checks if DHF has been installed
+ |
+
boolean |
+isPartiallyInstalled()
+Returns if an install has been performed, but not complete
+ |
+
boolean |
+isTripleIndexOn(DatabaseKind kind)
+Checks to see if the triple index is set and on
+ |
+
void |
+setAppServerExistent(DatabaseKind kind,
+ boolean exists)
+Sets the boolean property if the app server exists for the databasekind
+ |
+
void |
+setCollectionLexiconOn(DatabaseKind kind,
+ boolean collectionLexiconOn)
+Sets if the collection lexicon is on or not
+ |
+
void |
+setDbExistent(DatabaseKind kind,
+ boolean exists)
+Sets the boolean property if the database exists for the databasekind
+ |
+
void |
+setForestsExistent(DatabaseKind kind,
+ boolean forestsExistent)
+Sets the boolean property if the forests exist for the databasekind
+ |
+
void |
+setTripleIndexOn(DatabaseKind kind,
+ boolean tripleIndexOn)
+Sets if the triple index is on or off by boolean
+ |
+
java.lang.String |
+toString()
+Returns the entire object as a string
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
create
public boolean isPartiallyInstalled()+
InstallInfo
isPartiallyInstalled
in interface InstallInfo
public boolean isInstalled()+
InstallInfo
isInstalled
in interface InstallInfo
public java.lang.String toString()+
InstallInfo
toString
in interface InstallInfo
toString
in class java.lang.Object
public boolean isAppServerExistent(DatabaseKind kind)+
InstallInfo
isAppServerExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setAppServerExistent(DatabaseKind kind, + boolean exists)+
InstallInfo
setAppServerExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBexists
- - true if it exists, false if it doesn'tpublic boolean isDbExistent(DatabaseKind kind)+
InstallInfo
isDbExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setDbExistent(DatabaseKind kind, + boolean exists)+
InstallInfo
setDbExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBexists
- - true if it exists, false if it doesn'tpublic boolean isTripleIndexOn(DatabaseKind kind)+
InstallInfo
isTripleIndexOn
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setTripleIndexOn(DatabaseKind kind, + boolean tripleIndexOn)+
InstallInfo
setTripleIndexOn
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBtripleIndexOn
- - true if the triple index is on, false if it is notpublic boolean isCollectionLexiconOn(DatabaseKind kind)+
InstallInfo
isCollectionLexiconOn
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setCollectionLexiconOn(DatabaseKind kind, + boolean collectionLexiconOn)+
InstallInfo
setCollectionLexiconOn
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBcollectionLexiconOn
- - true if it's on, false if it's notpublic boolean areForestsExistent(DatabaseKind kind)+
InstallInfo
areForestsExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setForestsExistent(DatabaseKind kind, + boolean forestsExistent)+
InstallInfo
setForestsExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBforestsExistent
- - true if it exists, false if it doesn'tConstructor and Description | +
---|
TracingImpl(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+disable()
+Disables tracing
+ |
+
void |
+enable()
+Enables tracing
+ |
+
boolean |
+isEnabled()
+Determines if the hub has tracing enabled or not
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public TracingImpl(com.marklogic.client.DatabaseClient client)+
Class | +Description | +
---|---|
HubConfigImpl | ++ |
public class Job
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
java.util.Date |
+getEndTime() |
+
java.lang.String |
+getEntityName() |
+
long |
+getFailedBatches() |
+
long |
+getFailedEvents() |
+
java.lang.String |
+getFlowName() |
+
java.lang.String |
+getFlowType() |
+
java.lang.String |
+getJobId() |
+
java.lang.String |
+getJobName() |
+
java.util.List<java.lang.String> |
+getJobOutput() |
+
java.util.Date |
+getStartTime() |
+
JobStatus |
+getStatus() |
+
long |
+getSuccessfulBatches() |
+
long |
+getSuccessfulEvents() |
+
Job |
+setCounts(long successfulEvents,
+ long failedEvents,
+ long successfulBatches,
+ long failedBatches) |
+
Job |
+withEndTime(java.util.Date endTime) |
+
static Job |
+withFlow(Flow flow) |
+
Job |
+withJobId(java.lang.String jobId) |
+
Job |
+withJobName(java.lang.String jobName) |
+
Job |
+withJobOutput(java.util.List<java.lang.String> jobOutput) |
+
Job |
+withJobOutput(java.lang.String jobOutput) |
+
Job |
+withStartTime(java.util.Date startTime) |
+
Job |
+withStatus(JobStatus status) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public Job withJobId(java.lang.String jobId)+
public Job withJobName(java.lang.String jobName)+
public Job withJobOutput(java.util.List<java.lang.String> jobOutput)+
public Job withJobOutput(java.lang.String jobOutput)+
public Job withStartTime(java.util.Date startTime)+
public Job withEndTime(java.util.Date endTime)+
public Job setCounts(long successfulEvents, + long failedEvents, + long successfulBatches, + long failedBatches)+
public java.lang.String getJobId()+
public java.lang.String getFlowType()+
public java.lang.String getFlowName()+
public java.lang.String getEntityName()+
public java.lang.String getJobName()+
public java.util.Date getStartTime()+
public java.util.Date getEndTime()+
public JobStatus getStatus()+
public java.util.List<java.lang.String> getJobOutput()+
public long getSuccessfulEvents()+
public long getFailedEvents()+
public long getSuccessfulBatches()+
public long getFailedBatches()+
public class JobDeleteResponse
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
java.util.List<java.lang.String> |
+deletedJobs |
+
java.util.List<java.lang.String> |
+deletedTraces |
+
long |
+errorCount |
+
java.util.List<com.fasterxml.jackson.databind.JsonNode> |
+errors |
+
java.util.List<java.lang.String> |
+failedJobs |
+
java.util.List<java.lang.String> |
+failedTraces |
+
long |
+totalCount |
+
Constructor and Description | +
---|
JobDeleteResponse() |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+toString() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public long totalCount+
public long errorCount+
public java.util.List<java.lang.String> deletedJobs+
public java.util.List<java.lang.String> deletedTraces+
public java.util.List<java.lang.String> failedJobs+
public java.util.List<java.lang.String> failedTraces+
public java.util.List<com.fasterxml.jackson.databind.JsonNode> errors+
public class JobExportResponse
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
java.lang.String |
+fullPath |
+
long |
+totalJobs |
+
long |
+totalTraces |
+
Constructor and Description | +
---|
JobExportResponse() |
+
public class JobManager.JobDeleteResource
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
JobDeleteResource(com.marklogic.client.DatabaseClient srcClient) |
+
Modifier and Type | +Method and Description | +
---|---|
JobDeleteResponse |
+deleteJobs(java.lang.String jobIds) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public JobDeleteResource(com.marklogic.client.DatabaseClient srcClient)+
public JobDeleteResponse deleteJobs(java.lang.String jobIds)+
jobIds
- comma-separated list of jobIds to delete.public class JobManager
+extends java.lang.Object
+Modifier and Type | +Class and Description | +
---|---|
class |
+JobManager.JobDeleteResource |
+
Constructor and Description | +
---|
JobManager(com.marklogic.client.DatabaseClient jobClient) |
+
Modifier and Type | +Method and Description | +
---|---|
JobDeleteResponse |
+deleteJobs(java.lang.String jobIds) |
+
void |
+saveJob(Job job) |
+
void |
+saveJob(Job job,
+ com.marklogic.client.Transaction transaction) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Enum Constant and Description | +
---|
CANCELED |
+
FAILED |
+
FINISHED |
+
FINISHED_WITH_ERRORS |
+
RUNNING_COLLECTOR |
+
RUNNING_HARMONIZE |
+
STARTED |
+
STOP_ON_ERROR |
+
Modifier and Type | +Method and Description | +
---|---|
static JobStatus |
+getJobStatus(java.lang.String status) |
+
java.lang.String |
+toString() |
+
static JobStatus |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static JobStatus[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final JobStatus STARTED+
public static final JobStatus RUNNING_COLLECTOR+
public static final JobStatus RUNNING_HARMONIZE+
public static final JobStatus FINISHED+
public static final JobStatus FINISHED_WITH_ERRORS+
public static final JobStatus FAILED+
public static final JobStatus STOP_ON_ERROR+
public static final JobStatus CANCELED+
public static JobStatus[] values()+
+for (JobStatus c : JobStatus.values()) + System.out.println(c); +
public static JobStatus valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static JobStatus getJobStatus(java.lang.String status)+
public java.lang.String toString()+
toString
in class java.lang.Enum<JobStatus>
public class JobManagerImpl.JobDeleteResource
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
JobDeleteResource(com.marklogic.client.DatabaseClient srcClient) |
+
Modifier and Type | +Method and Description | +
---|---|
JobDeleteResponse |
+deleteJobs(java.lang.String jobIds) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public JobDeleteResource(com.marklogic.client.DatabaseClient srcClient)+
public JobDeleteResponse deleteJobs(java.lang.String jobIds)+
public class JobManagerImpl +extends java.lang.Object +implements JobManager+
Modifier and Type | +Class and Description | +
---|---|
class |
+JobManagerImpl.JobDeleteResource |
+
Constructor and Description | +
---|
JobManagerImpl(com.marklogic.client.DatabaseClient jobClient,
+ com.marklogic.client.DatabaseClient traceClient) |
+
Modifier and Type | +Method and Description | +
---|---|
JobDeleteResponse |
+deleteJobs(java.lang.String jobIds) |
+
JobExportResponse |
+exportJobs(java.nio.file.Path exportFilePath,
+ java.lang.String[] jobIds)
+Export Job documents and their associated Trace documents to a zip file.
+ |
+
void |
+importJobs(java.nio.file.Path importFilePath)
+Import Job documents and their associated Trace documents from a zip file.
+ |
+
void |
+saveJob(Job job)
+Saves the job to the database
+ |
+
void |
+saveJob(Job job,
+ com.marklogic.client.Transaction transaction)
+Saves the job to the database
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public JobManagerImpl(com.marklogic.client.DatabaseClient jobClient, + com.marklogic.client.DatabaseClient traceClient)+
public void saveJob(Job job)+
JobManager
saveJob
in interface JobManager
job
- - the job you want to savepublic void saveJob(Job job, + com.marklogic.client.Transaction transaction)+
JobManager
saveJob
in interface JobManager
job
- - the job you want to savetransaction
- - the transaction that is to be used to write the jobpublic JobDeleteResponse deleteJobs(java.lang.String jobIds)+
deleteJobs
in interface JobManager
jobIds
- comma-separated list of jobIds to delete.public JobExportResponse exportJobs(java.nio.file.Path exportFilePath, + java.lang.String[] jobIds)+
JobManager
exportJobs
in interface JobManager
exportFilePath
- specifies where the zip file will be writtenjobIds
- a comma-separated list of jobIds; if null, all will be exportedpublic void importJobs(java.nio.file.Path importFilePath) + throws java.io.IOException+
JobManager
importJobs
in interface JobManager
importFilePath
- specifies where the zip file existsjava.io.IOException
- if unable to open or read the target input fileClass | +Description | +
---|---|
JobManagerImpl | ++ |
Class | +Description | +
---|---|
Job | ++ |
JobDeleteResponse | ++ |
JobManager | ++ |
Enum | +Description | +
---|---|
JobStatus | ++ |
public interface MainPlugin
+Modifier and Type | +Method and Description | +
---|---|
CodeFormat |
+getCodeFormat() |
+
java.lang.String |
+getModule() |
+
java.lang.String getModule()+
CodeFormat getCodeFormat()+
public class MainPluginImpl +extends java.lang.Object +implements MainPlugin+
Constructor and Description | +
---|
MainPluginImpl() |
+
MainPluginImpl(java.lang.String module,
+ CodeFormat codeFormat) |
+
Modifier and Type | +Method and Description | +
---|---|
CodeFormat |
+getCodeFormat() |
+
java.lang.String |
+getModule() |
+
void |
+setCodeFormat(CodeFormat codeFormat) |
+
void |
+setModule(java.lang.String module) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public MainPluginImpl()+
public MainPluginImpl(java.lang.String module, + CodeFormat codeFormat)+
public void setModule(java.lang.String module)+
public java.lang.String getModule()+
getModule
in interface MainPlugin
public void setCodeFormat(CodeFormat codeFormat)+
public CodeFormat getCodeFormat()+
getCodeFormat
in interface MainPlugin
Class | +Description | +
---|---|
MainPluginImpl | ++ |
Interface | +Description | +
---|---|
MainPlugin | ++ |
Interface | +Description | +
---|---|
HubConfig | +
+ A class for passing around the Data Hub's Configuration
+ |
+
Class | +Description | +
---|---|
DataHub | ++ |
DataHubUpgrader | ++ |
Debugging | ++ |
EntityManager | ++ |
FlowManager | ++ |
HubConfigBuilder | +
+ A class for building a HubConfig class.
+ |
+
HubProject | +
+ Class for creating a hub Project
+ |
+
InstallInfo | ++ |
PreInstallCheck | ++ |
Tracing | ++ |
Enum | +Description | +
---|---|
HubDatabase | ++ |
public class Scaffolding.ContentPlugin
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
ContentPlugin(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+getContents(java.lang.String entityName,
+ CodeFormat codeFormat,
+ FlowType flowType) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public ContentPlugin(com.marklogic.client.DatabaseClient client)+
public java.lang.String getContents(java.lang.String entityName, + CodeFormat codeFormat, + FlowType flowType)+
public class Scaffolding
+extends java.lang.Object
+Modifier and Type | +Class and Description | +
---|---|
class |
+Scaffolding.ContentPlugin |
+
Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
Constructor and Description | +
---|
Scaffolding(java.lang.String projectDir,
+ com.marklogic.client.DatabaseClient databaseClient) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+createEntity(java.lang.String entityName) |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat) |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat,
+ boolean useEsModel) |
+
void |
+createRestExtension(java.lang.String entityName,
+ java.lang.String extensionName,
+ FlowType flowType,
+ CodeFormat codeFormat) |
+
void |
+createRestTransform(java.lang.String entityName,
+ java.lang.String transformName,
+ FlowType flowType,
+ CodeFormat codeFormat) |
+
static java.lang.String |
+getAbsolutePath(java.lang.String first,
+ java.lang.String... more) |
+
java.nio.file.Path |
+getEntityDir(java.lang.String entityName) |
+
java.nio.file.Path |
+getFlowDir(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType) |
+
void |
+updateLegacyEntity(java.lang.String entityName) |
+
boolean |
+updateLegacyFlow(java.lang.String fromVersion,
+ java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType) |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion,
+ java.lang.String entityName) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public Scaffolding(java.lang.String projectDir, + com.marklogic.client.DatabaseClient databaseClient)+
public java.nio.file.Path getFlowDir(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
public void createEntity(java.lang.String entityName)+
public void createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat)+
public void createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat, + boolean useEsModel)+
public java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion, + java.lang.String entityName)+
public void updateLegacyEntity(java.lang.String entityName)+
public boolean updateLegacyFlow(java.lang.String fromVersion, + java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
public void createRestExtension(java.lang.String entityName, + java.lang.String extensionName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
ScaffoldingValidationException
public void createRestTransform(java.lang.String entityName, + java.lang.String transformName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
ScaffoldingValidationException
public java.nio.file.Path getEntityDir(java.lang.String entityName)+
public static java.lang.String getAbsolutePath(java.lang.String first, + java.lang.String... more)+
public class ScaffoldingValidator
+extends java.nio.file.SimpleFileVisitor<java.nio.file.Path>
+Constructor and Description | +
---|
ScaffoldingValidator(java.lang.String projectDir) |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+isUniqueRestServiceExtension(java.lang.String name) |
+
boolean |
+isUniqueRestTransform(java.lang.String name) |
+
postVisitDirectory, preVisitDirectory, visitFile, visitFileFailed
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class ScaffoldingImpl.ContentPlugin
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
ContentPlugin(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+getContents(java.lang.String entityName,
+ CodeFormat codeFormat,
+ FlowType flowType) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public ContentPlugin(com.marklogic.client.DatabaseClient client)+
public java.lang.String getContents(java.lang.String entityName, + CodeFormat codeFormat, + FlowType flowType)+
public class ScaffoldingImpl +extends java.lang.Object +implements Scaffolding+
Modifier and Type | +Class and Description | +
---|---|
class |
+ScaffoldingImpl.ContentPlugin |
+
Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
Constructor and Description | +
---|
ScaffoldingImpl(java.lang.String projectDir,
+ com.marklogic.client.DatabaseClient databaseClient) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+createEntity(java.lang.String entityName)
+Creates an entity given a string name
+ |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat)
+Creates a flow for an entity with Entity Services model as default
+ |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat,
+ boolean useEsModel)
+Creates a flow for an entity with an additional option for using Entity Services
+ |
+
void |
+createRestExtension(java.lang.String entityName,
+ java.lang.String extensionName,
+ FlowType flowType,
+ CodeFormat codeFormat)
+Creates a rest extension on disk to be deployed to server
+ |
+
void |
+createRestTransform(java.lang.String entityName,
+ java.lang.String transformName,
+ FlowType flowType,
+ CodeFormat codeFormat)
+Creates a rest transform on disk to be deployed to server
+ |
+
static java.lang.String |
+getAbsolutePath(java.lang.String first,
+ java.lang.String... more) |
+
java.nio.file.Path |
+getEntityDir(java.lang.String entityName) |
+
java.nio.file.Path |
+getFlowDir(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType)
+Returns the directory of the flow
+ |
+
boolean |
+update2xFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType) |
+
void |
+updateLegacyEntity(java.lang.String entityName)
+Update a specific entity that's legacy
+ |
+
boolean |
+updateLegacyFlow(java.lang.String fromVersion,
+ java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType)
+Update a legacy flow
+ |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion,
+ java.lang.String entityName)
+Updates a legacy flow on disk
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public ScaffoldingImpl(java.lang.String projectDir, + com.marklogic.client.DatabaseClient databaseClient)+
public static java.lang.String getAbsolutePath(java.lang.String first, + java.lang.String... more)+
public java.nio.file.Path getFlowDir(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
Scaffolding
getFlowDir
in interface Scaffolding
entityName
- - the entity nameflowName
- - the name of the flowflowType
- - FlowType (sjs or xqy)public void createEntity(java.lang.String entityName)+
Scaffolding
createEntity
in interface Scaffolding
entityName
- - the name of the entity as stringpublic void createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat)+
Scaffolding
createFlow
in interface Scaffolding
entityName
- - name of the entity to associate the flow withflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumdataFormat
- - the format of the data (json or xml)public void createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat, + boolean useEsModel)+
Scaffolding
createFlow
in interface Scaffolding
entityName
- - name of the entity to associate the flow withflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumdataFormat
- - the format of the data (json or xml)useEsModel
- - true to use Entity Services, false not topublic java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion, + java.lang.String entityName)+
Scaffolding
updateLegacyFlows
in interface Scaffolding
fromVersion
- - string version number of DHFentityName
- - the entity which the flow is attachedpublic void updateLegacyEntity(java.lang.String entityName)+
Scaffolding
updateLegacyEntity
in interface Scaffolding
entityName
- - name of the entitypublic boolean updateLegacyFlow(java.lang.String fromVersion, + java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
Scaffolding
updateLegacyFlow
in interface Scaffolding
fromVersion
- - string version number of DHFentityName
- - the entity which the flow is attachedflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestpublic boolean update2xFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
public void createRestExtension(java.lang.String entityName, + java.lang.String extensionName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
Scaffolding
createRestExtension
in interface Scaffolding
entityName
- - the entity which the flow is attachedextensionName
- - the name of the extension as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumScaffoldingValidationException
public void createRestTransform(java.lang.String entityName, + java.lang.String transformName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
Scaffolding
createRestTransform
in interface Scaffolding
entityName
- - the entity which the flow is attachedtransformName
- - the name of the transform as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumScaffoldingValidationException
public java.nio.file.Path getEntityDir(java.lang.String entityName)+
Class | +Description | +
---|---|
ScaffoldingImpl | ++ |
Class | +Description | +
---|---|
Scaffolding | ++ |
ScaffoldingValidator | ++ |
public class FileUtil
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
static void |
+copy(java.io.InputStream source,
+ java.io.File destination) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class HubModuleManager
+extends com.marklogic.client.ext.helper.LoggingObject
+implements com.marklogic.client.ext.modulesloader.ModulesManager
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DEFAULT_FILE_PATH |
+
logger
Constructor and Description | +
---|
HubModuleManager(java.lang.String propertiesFilePath) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.lang.String |
+buildKey(java.io.File file)
+Lower-casing avoids some annoying issues on Windows where sometimes you get "C:" at the start, and other times
+ you get "c:".
+ |
+
void |
+deletePropertiesFile() |
+
boolean |
+hasFileBeenModifiedSinceLastLoaded(java.io.File file) |
+
boolean |
+hasKeyBeenModified(java.lang.String key,
+ long lastModified) |
+
void |
+initialize() |
+
void |
+saveLastLoadedTimestamp(java.io.File file,
+ java.util.Date date) |
+
void |
+saveLastLoadedTimestamp(java.lang.String key,
+ java.util.Date date) |
+
void |
+setMinimumFileTimestampToLoad(long minimumFileTimestampToLoad) |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final java.lang.String DEFAULT_FILE_PATH+
public HubModuleManager(java.lang.String propertiesFilePath)+
public void initialize()+
initialize
in interface com.marklogic.client.ext.modulesloader.ModulesManager
public void deletePropertiesFile()+
public boolean hasFileBeenModifiedSinceLastLoaded(java.io.File file)+
hasFileBeenModifiedSinceLastLoaded
in interface com.marklogic.client.ext.modulesloader.ModulesManager
public boolean hasKeyBeenModified(java.lang.String key, + long lastModified)+
public void saveLastLoadedTimestamp(java.io.File file, + java.util.Date date)+
saveLastLoadedTimestamp
in interface com.marklogic.client.ext.modulesloader.ModulesManager
public void saveLastLoadedTimestamp(java.lang.String key, + java.util.Date date)+
protected java.lang.String buildKey(java.io.File file)+
file
- - the file to build a key forpublic void setMinimumFileTimestampToLoad(long minimumFileTimestampToLoad)+
public class JsonXor
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
static com.fasterxml.jackson.databind.JsonNode |
+xor(java.io.File original,
+ java.io.File changed) |
+
static com.fasterxml.jackson.databind.JsonNode |
+xor(java.io.InputStream original,
+ java.io.InputStream changed) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static com.fasterxml.jackson.databind.JsonNode xor(java.io.File original, + java.io.File changed) + throws java.io.IOException+
java.io.IOException
public static com.fasterxml.jackson.databind.JsonNode xor(java.io.InputStream original, + java.io.InputStream changed) + throws java.io.IOException+
java.io.IOException
public class MlcpConsumer
+extends java.lang.Object
+implements java.util.function.Consumer<java.lang.String>
+Constructor and Description | +
---|
MlcpConsumer(java.util.concurrent.atomic.AtomicLong successfulEvents,
+ java.util.concurrent.atomic.AtomicLong failedEvents,
+ FlowStatusListener statusListener,
+ java.lang.String jobId) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+accept(java.lang.String status) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
andThen
public MlcpConsumer(java.util.concurrent.atomic.AtomicLong successfulEvents, + java.util.concurrent.atomic.AtomicLong failedEvents, + FlowStatusListener statusListener, + java.lang.String jobId)+
public class MlcpRunner +extends ProcessRunner+
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
Constructor and Description | +
---|
MlcpRunner(java.lang.String mlcpPath,
+ java.lang.String mainClass,
+ HubConfig hubConfig,
+ Flow flow,
+ com.marklogic.client.DatabaseClient databaseClient,
+ com.fasterxml.jackson.databind.JsonNode mlcpOptions,
+ FlowStatusListener statusListener) |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+getJobId() |
+
void |
+run() |
+
getHubConfig, getProcessOutput, newRunner, withArgs, withHubconfig, withStreamConsumer
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public MlcpRunner(java.lang.String mlcpPath, + java.lang.String mainClass, + HubConfig hubConfig, + Flow flow, + com.marklogic.client.DatabaseClient databaseClient, + com.fasterxml.jackson.databind.JsonNode mlcpOptions, + FlowStatusListener statusListener)+
public java.lang.String getJobId()+
public void run()+
run
in interface java.lang.Runnable
run
in class ProcessRunner
public class PerformanceLogger
+extends java.lang.Object
+Constructor and Description | +
---|
PerformanceLogger() |
+
Modifier and Type | +Method and Description | +
---|---|
static void |
+logTimeInsideMethod(long startTime,
+ java.lang.String location) |
+
static long |
+monitorTimeInsideMethod() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class ProcessRunner
+extends java.lang.Thread
+java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
Constructor and Description | +
---|
ProcessRunner() |
+
Modifier and Type | +Method and Description | +
---|---|
HubConfig |
+getHubConfig() |
+
java.lang.String |
+getProcessOutput() |
+
static ProcessRunner |
+newRunner() |
+
void |
+run() |
+
ProcessRunner |
+withArgs(java.util.List<java.lang.String> args) |
+
ProcessRunner |
+withHubconfig(HubConfig hubConfig) |
+
ProcessRunner |
+withStreamConsumer(java.util.function.Consumer<java.lang.String> consumer) |
+
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public HubConfig getHubConfig()+
public java.lang.String getProcessOutput()+
public static ProcessRunner newRunner()+
public ProcessRunner withArgs(java.util.List<java.lang.String> args)+
public ProcessRunner withHubconfig(HubConfig hubConfig)+
public ProcessRunner withStreamConsumer(java.util.function.Consumer<java.lang.String> consumer)+
public void run()+
run
in interface java.lang.Runnable
run
in class java.lang.Thread
public class StreamGobbler
+extends java.lang.Thread
+java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
Constructor and Description | +
---|
StreamGobbler(java.io.InputStream inputStream,
+ java.util.function.Consumer<java.lang.String> consumeInputLine) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+run() |
+
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class Versions
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
Versions(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
static int |
+compare(java.lang.String v1,
+ java.lang.String v2) |
+
java.lang.String |
+getHubVersion() |
+
java.lang.String |
+getMarkLogicVersion() |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
FileUtil | ++ |
HubModuleManager | ++ |
JsonXor | ++ |
MlcpConsumer | ++ |
MlcpRunner | ++ |
PerformanceLogger | ++ |
ProcessRunner | ++ |
StreamGobbler | ++ |
Versions | ++ |
public class EntitiesValidator
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
EntitiesValidator(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.databind.JsonNode |
+validate(java.lang.String entity,
+ java.lang.String flow,
+ java.lang.String plugin,
+ java.lang.String type,
+ java.lang.String content) |
+
com.fasterxml.jackson.databind.JsonNode |
+validateAll() |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public EntitiesValidator(com.marklogic.client.DatabaseClient client)+
public com.fasterxml.jackson.databind.JsonNode validateAll()+
public com.fasterxml.jackson.databind.JsonNode validate(java.lang.String entity, + java.lang.String flow, + java.lang.String plugin, + java.lang.String type, + java.lang.String content)+
public class EntitiesValidatorImpl +extends com.marklogic.client.extensions.ResourceManager +implements EntitiesValidator+
Constructor and Description | +
---|
EntitiesValidatorImpl(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.databind.JsonNode |
+validate(java.lang.String entity,
+ java.lang.String flow,
+ java.lang.String plugin,
+ java.lang.String type,
+ java.lang.String content)
+Creates and returns a an EntityValidator object
+ |
+
com.fasterxml.jackson.databind.JsonNode |
+validateAll()
+Validates all entities
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public EntitiesValidatorImpl(com.marklogic.client.DatabaseClient client)+
public com.fasterxml.jackson.databind.JsonNode validateAll()+
EntitiesValidator
validateAll
in interface EntitiesValidator
public com.fasterxml.jackson.databind.JsonNode validate(java.lang.String entity, + java.lang.String flow, + java.lang.String plugin, + java.lang.String type, + java.lang.String content)+
EntitiesValidator
validate
in interface EntitiesValidator
entity
- - name of the entity you are attempting to validateflow
- - name of the flow you want to useplugin
- - which plugin (triples/headers/etc) without extensiontype
- - xquery or javascriptcontent
- - the content to validate againstClass | +Description | +
---|---|
EntitiesValidatorImpl | ++ |
Class | +Description | +
---|---|
EntitiesValidator | ++ |
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DEFAULT_AUTH_METHOD |
+"digest" |
+
+
+public static final java.lang.String |
+DEFAULT_CUSTOM_FOREST_PATH |
+"forests" |
+
+
+public static final java.lang.String |
+DEFAULT_FINAL_NAME |
+"data-hub-FINAL" |
+
+
+public static final java.lang.String |
+DEFAULT_JOB_NAME |
+"data-hub-JOBS" |
+
+
+public static final java.lang.String |
+DEFAULT_MODULES_DB_NAME |
+"data-hub-MODULES" |
+
+
+public static final java.lang.String |
+DEFAULT_ROLE_NAME |
+"data-hub-role" |
+
+
+public static final java.lang.String |
+DEFAULT_SCHEMAS_DB_NAME |
+"data-hub-SCHEMAS" |
+
+
+public static final java.lang.String |
+DEFAULT_SCHEME |
+"http" |
+
+
+public static final java.lang.String |
+DEFAULT_STAGING_NAME |
+"data-hub-STAGING" |
+
+
+public static final java.lang.String |
+DEFAULT_TRACE_NAME |
+"data-hub-TRACING" |
+
+
+public static final java.lang.String |
+DEFAULT_TRIGGERS_DB_NAME |
+"data-hub-TRIGGERS" |
+
+
+public static final java.lang.String |
+DEFAULT_USER_NAME |
+"data-hub-user" |
+
+
+public static final java.lang.String |
+ENTITY_CONFIG_DIR |
+"entity-config" |
+
+
+public static final java.lang.String |
+FINAL_ENTITY_SEARCH_OPTIONS_FILE |
+"final-entity-options.xml" |
+
+
+public static final java.lang.String |
+HUB_CONFIG_DIR |
+"hub-internal-config" |
+
+
+public static final java.lang.String |
+HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+"hub-modules-deploy-timestamps.properties" |
+
+
+public static final java.lang.String |
+STAGING_ENTITY_SEARCH_OPTIONS_FILE |
+"staging-entity-options.xml" |
+
+
+public static final java.lang.String |
+USER_CONFIG_DIR |
+"user-config" |
+
+
+public static final java.lang.String |
+USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES |
+"user-content-deploy-timestamps.properties" |
+
+
+public static final java.lang.String |
+USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+"user-modules-deploy-timestamps.properties" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+ENTITY_CONFIG_DIR |
+"entity-config" |
+
+
+public static final java.lang.String |
+HUB_CONFIG_DIR |
+"hub-internal-config" |
+
+
+public static final java.lang.String |
+USER_CONFIG_DIR |
+"user-config" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DATABASE_FILENAME |
+"schemas-database.json" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DATABASE_FILENAME |
+"triggers-database.json" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DEFAULT_FILE_PATH |
+"build/ml-javaclient-util/module-timestamps.properties" |
+
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object
. The interfaces do not inherit from java.lang.Object
.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+HubConfig
instancemaxInMemorySize
elements in memory.maxInMemorySize
elements in memory.HubConfigBuilder
instanceAdminConfig
for the HubConfig
AdminManager
for the HubConfig
AppConfig
for the HubConfig
ManageClient
for the HubConfig
ManageConfig
for the HubConfig
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to Non-frame version.
++ + diff --git a/javadocs/2.0.4/overview-summary.html b/javadocs/2.0.4/overview-summary.html new file mode 100644 index 0000000000..5ed4108cac --- /dev/null +++ b/javadocs/2.0.4/overview-summary.html @@ -0,0 +1,223 @@ + + + + + +
See: Description
+Package | +Description | +
---|---|
com.marklogic.com.marklogic.client.ext.file | ++ |
com.marklogic.com.marklogic.client.ext.modulesloader.impl | ++ |
com.marklogic.hub | ++ |
com.marklogic.hub.collector | ++ |
com.marklogic.hub.collector.impl | ++ |
com.marklogic.hub.deploy | ++ |
com.marklogic.hub.deploy.commands | ++ |
com.marklogic.hub.deploy.util | ++ |
com.marklogic.hub.entity | ++ |
com.marklogic.hub.error | ++ |
com.marklogic.hub.flow | ++ |
com.marklogic.hub.flow.impl | ++ |
com.marklogic.hub.impl | ++ |
com.marklogic.hub.job | ++ |
com.marklogic.hub.main | ++ |
com.marklogic.hub.main.impl | ++ |
com.marklogic.hub.scaffold | ++ |
com.marklogic.hub.util | ++ |
com.marklogic.hub.validate | ++ |
public class CacheBusterDocumentFileProcessor
+extends com.marklogic.client.ext.helper.LoggingObject
+implements com.marklogic.client.ext.file.DocumentFileProcessor
+logger
Constructor and Description | +
---|
CacheBusterDocumentFileProcessor() |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.client.ext.file.DocumentFile |
+processDocumentFile(com.marklogic.client.ext.file.DocumentFile documentFile) |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
CacheBusterDocumentFileProcessor | ++ |
public class EntityDefModulesFinder
+extends com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
+logger
Constructor and Description | +
---|
EntityDefModulesFinder() |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.marklogic.client.ext.modulesloader.Modules |
+findModulesWithResolvedBaseDir(java.lang.String baseDir) |
+
addAssetDirectories, addNamespaces, addOptions, addPropertiesFile, addServices, addTransforms, decodeAssetDirectoryResource, findModules, findResources, getNamespaceFilenameFilter, getRecognizedPaths, getTransformFilenameFilter, isIncludeUnrecognizedPathsAsAssetPaths, setIncludeUnrecognizedPathsAsAssetPaths, setNamespaceFilenameFilter, setNamespacesPath, setOptionsPath, setServicesPath, setTransformFilenameFilter, setTransformsPath
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public EntityDefModulesFinder()+
protected com.marklogic.client.ext.modulesloader.Modules findModulesWithResolvedBaseDir(java.lang.String baseDir)+
findModulesWithResolvedBaseDir
in class com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
public class SearchOptionsFinder
+extends com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
+logger
Constructor and Description | +
---|
SearchOptionsFinder() |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.marklogic.client.ext.modulesloader.Modules |
+findModulesWithResolvedBaseDir(java.lang.String baseDir) |
+
addAssetDirectories, addNamespaces, addOptions, addPropertiesFile, addServices, addTransforms, decodeAssetDirectoryResource, findModules, findResources, getNamespaceFilenameFilter, getRecognizedPaths, getTransformFilenameFilter, isIncludeUnrecognizedPathsAsAssetPaths, setIncludeUnrecognizedPathsAsAssetPaths, setNamespaceFilenameFilter, setNamespacesPath, setOptionsPath, setServicesPath, setTransformFilenameFilter, setTransformsPath
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
protected com.marklogic.client.ext.modulesloader.Modules findModulesWithResolvedBaseDir(java.lang.String baseDir)+
findModulesWithResolvedBaseDir
in class com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
public class UserModulesFinder
+extends com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
+implements com.marklogic.client.ext.modulesloader.ModulesFinder
+logger
Constructor and Description | +
---|
UserModulesFinder() |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.marklogic.client.ext.modulesloader.Modules |
+findModulesWithResolvedBaseDir(java.lang.String baseDir) |
+
addAssetDirectories, addNamespaces, addOptions, addPropertiesFile, addServices, addTransforms, decodeAssetDirectoryResource, findModules, findResources, getNamespaceFilenameFilter, getRecognizedPaths, getTransformFilenameFilter, isIncludeUnrecognizedPathsAsAssetPaths, setIncludeUnrecognizedPathsAsAssetPaths, setNamespaceFilenameFilter, setNamespacesPath, setOptionsPath, setServicesPath, setTransformFilenameFilter, setTransformsPath
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
findModules
protected com.marklogic.client.ext.modulesloader.Modules findModulesWithResolvedBaseDir(java.lang.String baseDir)+
findModulesWithResolvedBaseDir
in class com.marklogic.client.ext.modulesloader.impl.BaseModulesFinder
Class | +Description | +
---|---|
EntityDefModulesFinder | ++ |
SearchOptionsFinder | ++ |
UserModulesFinder | ++ |
public interface DataHub
+Modifier and Type | +Method and Description | +
---|---|
void |
+clearDatabase(java.lang.String database)
+Clears the database of all documents
+ |
+
void |
+clearUserModules()
+Removes user's modules from the modules db
+ |
+
static DataHub |
+create(HubConfig hubConfig) |
+
java.lang.String |
+getPortInUseBy(DatabaseKind kind)
+Returns name of what is using the port
+ |
+
java.lang.String |
+getServerVersion()
+Returns the string presentation of the server version, eg: "9.03-1"
+ |
+
void |
+initProject()
+Initializes the project on disk, creates scaffold project code
+ |
+
void |
+install()
+Installs the data hub configuration and server-side config files into MarkLogic
+ |
+
void |
+install(HubDeployStatusListener listener)
+Installs the data hub configuration and server-side config files into MarkLogic
+ |
+
InstallInfo |
+isInstalled()
+Determines if the data hub is installed in MarkLogic
+ |
+
boolean |
+isPortInUse(DatabaseKind kind)
+Checks to see if the port is in use
+ |
+
boolean |
+isSafeToInstall()
+Checks to make sure all the versions and database in a valid configuration with version check
+ |
+
boolean |
+isServerVersionOk()
+Checks to see if the datahub and server versions are compatible
+ |
+
boolean |
+isServerVersionValid(java.lang.String versionString)
+Validates the MarkLogic server to ensure compatibility with the hub
+ |
+
java.util.HashMap |
+runPreInstallCheck()
+Runs the pre-install check for the datahub populating the object
+ with variables necessary to perform the install.
+ |
+
java.util.HashMap |
+runPreInstallCheck(Versions versions)
+Runs the pre-install check for the datahub populating the object
+ with variables necessary to perform the install.
+ |
+
void |
+setPortInUseBy(DatabaseKind kind,
+ java.lang.String usedBy)
+Sets what appserver name is using the port
+ |
+
void |
+setServerVersion(java.lang.String serverVersion)
+Sets the server version holder on the datahub object - currently unused
+ |
+
void |
+setServerVersionOk(boolean serverVersionOk)
+Sets true or false if the server version is okay with this version of DHF
+ |
+
void |
+uninstall()
+Uninstalls the data hub configuration and server-side config files from MarkLogic
+ |
+
void |
+uninstall(HubDeployStatusListener listener)
+Uninstalls the data hub configuration and server-side config files from MarkLogic
+ |
+
void |
+updateIndexes()
+Updates the indexes in the database based on the project
+ |
+
boolean |
+upgradeHub()
+Upgrades the installed datahub on the server to this version of the DataHub
+ |
+
boolean |
+upgradeHub(java.util.List<java.lang.String> updatedFlows)
+Upgrades the hub based on list of provided updated flows.
+ |
+
void clearDatabase(java.lang.String database)+
database
- - the name of the database in string formInstallInfo isInstalled()+
boolean isServerVersionValid(java.lang.String versionString)+
versionString
- - the version of the server to validateServerValidationException
- if the server is not compatiblevoid initProject()+
void clearUserModules()+
java.util.HashMap runPreInstallCheck()+
java.util.HashMap runPreInstallCheck(Versions versions)+
versions
- - the versions that the check is to be run againstvoid install()+
void install(HubDeployStatusListener listener)+
listener
- - the callback method to receive status updatesvoid updateIndexes()+
void uninstall()+
void uninstall(HubDeployStatusListener listener)+
listener
- - the callback method to receive status updatesboolean isSafeToInstall()+
boolean isPortInUse(DatabaseKind kind)+
kind
- - the DatabaseKind enum value (ex STAGING or JOB)void setPortInUseBy(DatabaseKind kind, + java.lang.String usedBy)+
kind
- - the DatabaseKind enum value (ex STAGING or JOB)usedBy
- - string name of what is using the portjava.lang.String getPortInUseBy(DatabaseKind kind)+
kind
- - the DatabaseKind enum value (ex STAGING or JOB)boolean isServerVersionOk()+
void setServerVersionOk(boolean serverVersionOk)+
serverVersionOk
- - true if it compatible or false if it is notjava.lang.String getServerVersion()+
void setServerVersion(java.lang.String serverVersion)+
serverVersion
- - server version as a string, eg: "9.03-1"boolean upgradeHub() + throws CantUpgradeException+
CantUpgradeException
- - exception thrown when an upgrade can't happenboolean upgradeHub(java.util.List<java.lang.String> updatedFlows) + throws CantUpgradeException+
CantUpgradeException
- - should the hub fail to upgrade for incompatibility reasonspublic enum DatabaseKind +extends java.lang.Enum<DatabaseKind>+
Enum Constant and Description | +
---|
FINAL |
+
JOB |
+
MODULES |
+
SCHEMAS |
+
STAGING |
+
TRACE |
+
TRIGGERS |
+
Modifier and Type | +Method and Description | +
---|---|
static java.lang.String |
+getName(DatabaseKind databaseKind)
+Validates the MarkLogic server to ensure compatibility with the hub
+ |
+
static DatabaseKind |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static DatabaseKind[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final DatabaseKind STAGING+
public static final DatabaseKind FINAL+
public static final DatabaseKind JOB+
public static final DatabaseKind TRACE+
public static final DatabaseKind SCHEMAS+
public static final DatabaseKind TRIGGERS+
public static final DatabaseKind MODULES+
public static DatabaseKind[] values()+
+for (DatabaseKind c : DatabaseKind.values()) + System.out.println(c); +
public static DatabaseKind valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static java.lang.String getName(DatabaseKind databaseKind)+
databaseKind
- - the enum for the type of databaseInvalidDBOperationError
- if the database kind is not found in enumerationpublic interface Debugging
+Modifier and Type | +Method and Description | +
---|---|
static Debugging |
+create(com.marklogic.client.DatabaseClient client)
+Creates and returns a debugging object
+ |
+
void |
+disable()
+Disables debugging
+ |
+
void |
+enable()
+Enables debugging
+ |
+
boolean |
+isEnabled()
+Determines if the hub has debugging enabled or not
+ |
+
static Debugging create(com.marklogic.client.DatabaseClient client)+
client
- - the databaseclient that will be usedvoid enable()+
void disable()+
boolean isEnabled()+
public interface EntityManager
+Modifier and Type | +Method and Description | +
---|---|
static EntityManager |
+create(HubConfig hubConfig)
+Creates and returns the EntityManager object
+ |
+
java.util.HashMap<java.lang.Enum,java.lang.Boolean> |
+deployQueryOptions()
+Deploys the query option
+ |
+
boolean |
+saveDbIndexes()
+Updates the indexes for the entity on the filesystem
+ |
+
boolean |
+saveQueryOptions()
+Updates the query options to the file system
+ |
+
static EntityManager create(HubConfig hubConfig)+
hubConfig
- - the hubConfig for the EntityManager to useboolean saveQueryOptions()+
java.util.HashMap<java.lang.Enum,java.lang.Boolean> deployQueryOptions()+
boolean saveDbIndexes()+
public interface FlowManager
+Modifier and Type | +Method and Description | +
---|---|
static FlowManager |
+create(HubConfig hubConfig)
+Creates and returns the FlowManager object
+ |
+
static Flow |
+flowFromXml(org.w3c.dom.Element doc)
+Turns an XML document into a flow
+ |
+
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName)
+Retrieves a named flow from a given entity
+ |
+
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType)
+Retrieves a named flow from a given entity
+ |
+
Flow |
+getFlowFromProperties(java.nio.file.Path propertiesFile)
+Obtains a flow from a property file
+ |
+
java.util.List<Flow> |
+getFlows(java.lang.String entityName)
+Retrieves a list of flows installed on the MarkLogic server
+ |
+
java.util.List<java.lang.String> |
+getLegacyFlows()
+Updates the indexes in the database based on the project
+ |
+
java.util.List<Flow> |
+getLocalFlows()
+retrieves a list of all the flows on the local files systems
+ |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName)
+retrieves a list of all the flows on the local files systems
+ |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName,
+ FlowType flowType)
+retrieves a list of all the flows on the local files systems
+ |
+
FlowRunner |
+newFlowRunner()
+Creates and returns a new FlowRunner object using the FlowManager's hubconfig
+ |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion)
+Sets the version that the legacy flow is to be updated from
+ |
+
static FlowManager create(HubConfig hubConfig)+
hubConfig
- - the hubConfig for the FlowManager to usestatic Flow flowFromXml(org.w3c.dom.Element doc)+
doc
- - the xml document representing a flowjava.util.List<Flow> getLocalFlows()+
java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName)+
entityName
- - string name of the entity for the flowjava.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName, + FlowType flowType)+
entityName
- - string name of the entity for the flowflowType
- - the FlowType enum, eg: ingest or harmonizeFlow getFlowFromProperties(java.nio.file.Path propertiesFile)+
propertiesFile
- - the Path to the property filejava.util.List<Flow> getFlows(java.lang.String entityName)+
entityName
- - the entity from which to fetch the flowsFlow getFlow(java.lang.String entityName, + java.lang.String flowName)+
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getFlow getFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getflowType
- - the type of flow (ingest/harmonize)java.util.List<java.lang.String> getLegacyFlows()+
java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion)+
fromVersion
- - string representation of DHF versionFlowRunner newFlowRunner()+
public interface HubConfig
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DEFAULT_AUTH_METHOD |
+
static java.lang.String |
+DEFAULT_CUSTOM_FOREST_PATH |
+
static java.lang.String |
+DEFAULT_FINAL_NAME |
+
static java.lang.Integer |
+DEFAULT_FINAL_PORT |
+
static java.lang.Integer |
+DEFAULT_FORESTS_PER_HOST |
+
static java.lang.String |
+DEFAULT_JOB_NAME |
+
static java.lang.Integer |
+DEFAULT_JOB_PORT |
+
static java.lang.String |
+DEFAULT_MODULES_DB_NAME |
+
static java.lang.String |
+DEFAULT_ROLE_NAME |
+
static java.lang.String |
+DEFAULT_SCHEMAS_DB_NAME |
+
static java.lang.String |
+DEFAULT_SCHEME |
+
static java.lang.String |
+DEFAULT_STAGING_NAME |
+
static java.lang.Integer |
+DEFAULT_STAGING_PORT |
+
static java.lang.String |
+DEFAULT_TRACE_NAME |
+
static java.lang.Integer |
+DEFAULT_TRACE_PORT |
+
static java.lang.String |
+DEFAULT_TRIGGERS_DB_NAME |
+
static java.lang.String |
+DEFAULT_USER_NAME |
+
static java.lang.String |
+ENTITY_CONFIG_DIR |
+
static java.lang.String |
+FINAL_ENTITY_QUERY_OPTIONS_FILE |
+
static java.lang.String |
+HUB_CONFIG_DIR |
+
static java.lang.String |
+HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+
static java.lang.String |
+STAGING_ENTITY_QUERY_OPTIONS_FILE |
+
static java.lang.String |
+USER_CONFIG_DIR |
+
static java.lang.String |
+USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES |
+
static java.lang.String |
+USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+
Modifier and Type | +Method and Description | +
---|---|
static HubConfig |
+create(java.lang.String projectDir)
+Creates and returns a hubconfig object for a project directory
+ |
+
com.marklogic.appdeployer.AppConfig |
+getAppConfig()
+Returns the current appconfig object attached to the HubConfig
+ |
+
java.lang.String |
+getAuthMethod(DatabaseKind kind)
+Returns the AuthMethod object for the DatabaseKind in the hub config
+ |
+
java.lang.String |
+getCertFile(DatabaseKind kind)
+Returns the SSL Cert file as a string for the DatabaseKind in the hub config
+ |
+
java.lang.String |
+getCertPassword(DatabaseKind kind)
+Returns the SSL Cert Password as a string for the DatabaseKind in the hub config
+ |
+
java.lang.String |
+getCustomForestPath()
+Returns the path for the custom forests definition
+ |
+
java.lang.String |
+getDbName(DatabaseKind kind)
+Returns the database name for the DatabaseKind set in the config
+ |
+
java.nio.file.Path |
+getEntityDatabaseDir()
+Gets the path for the entity database directory
+ |
+
java.lang.String |
+getExternalName(DatabaseKind kind)
+Returns the external name for the host for the DatabaseKind in the hub config
+ |
+
java.lang.Integer |
+getForestsPerHost(DatabaseKind kind)
+Returns the number of forests per host for the DatabaseKind set in the config
+ |
+
java.lang.String |
+getHost()
+Gets the hostname of the AppConfig
+ |
+
java.lang.String |
+getHttpName(DatabaseKind kind)
+Returns the appserver name for the DatabaseKind set in the config
+ |
+
java.nio.file.Path |
+getHubConfigDir()
+Gets the path for the hub's entities directory
+ |
+
java.nio.file.Path |
+getHubDatabaseDir()
+Gets the path for the hub's config directory
+ |
+
java.nio.file.Path |
+getHubEntitiesDir()
+Gets the path for the hub plugins directory
+ |
+
java.lang.String |
+getHubModulesDeployTimestampFile()
+Returns the last deployed timestamp file for the hub config and modules
+ |
+
java.nio.file.Path |
+getHubPluginsDir()
+Gets the path for the entity database directory
+ |
+
HubProject |
+getHubProject()
+Returns the HubProject associated with the HubConfig
+ |
+
java.lang.String |
+getHubRoleName()
+Get the roleName the hub uses
+ |
+
java.nio.file.Path |
+getHubSecurityDir()
+Gets the path for the hub servers directory
+ |
+
java.nio.file.Path |
+getHubServersDir()
+Gets the path for the hub's database directory
+ |
+
java.lang.String |
+getHubUserName()
+Get the current marklogic user name the hub uses
+ |
+
java.lang.String |
+getJarVersion()
+Gets the current version of the DHF Jar
+ |
+
java.lang.String[] |
+getLoadBalancerHosts()
+Gets a string array of hosts
+ |
+
java.lang.String |
+getModulePermissions()
+Gets the permissions used to execute a module in string form
+ |
+
java.lang.Integer |
+getPort(DatabaseKind kind)
+Returns the port number for the DatabaseKind set in the config
+ |
+
java.lang.String |
+getProjectDir()
+Obtains the project directory as a string
+ |
+
java.lang.String |
+getScheme(DatabaseKind kind)
+Returns the SSL Scheme as string for the DatabaseKind in the hub config
+ |
+
boolean |
+getSimpleSsl(DatabaseKind kind)
+Returns if Simple SSL is set for the DatabaseKind in the hub config
+ |
+
javax.net.ssl.SSLContext |
+getSslContext(DatabaseKind kind)
+Returns the SSL Context for the DatabaseKind set in the config
+ |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getSslHostnameVerifier(DatabaseKind kind)
+Returns the SSL hostname verifier object for the DatabaseKind in the hub config
+ |
+
java.nio.file.Path |
+getUserConfigDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getUserDatabaseDir()
+Gets the path for the user security directory
+ |
+
java.lang.String |
+getUserModulesDeployTimestampFile()
+Returns the last deployed timestamp file for the user modules
+ |
+
java.nio.file.Path |
+getUserSecurityDir()
+Gets the path for the user config directory
+ |
+
java.nio.file.Path |
+getUserServersDir()
+Gets the path for the entity database directory
+ |
+
void |
+initHubProject()
+Initializes the hub project on disk
+ |
+
com.marklogic.client.DatabaseClient |
+newAppServicesClient()
+Creates a new DatabaseClient for accessing the AppServices app
+ |
+
com.marklogic.client.DatabaseClient |
+newFinalClient()
+Creates a new DatabaseClient for accessing the Final database
+ |
+
com.marklogic.client.DatabaseClient |
+newJobDbClient()
+Creates a new DatabaseClient for accessing the Job database
+ |
+
com.marklogic.client.DatabaseClient |
+newModulesDbClient()
+Creates a new DatabaseClient for accessing the Hub Modules database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient()
+Creates a new DatabaseClient for accessing the Staging database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient(java.lang.String databaseName)
+Creates a new DatabaseClient for accessing the Staging database
+ |
+
com.marklogic.client.DatabaseClient |
+newTraceDbClient()
+Creates a new DatabaseClient for accessing the Trace database
+ |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config)
+Sets the App Config for the current HubConfig
+ |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config,
+ boolean skipUpdate)
+Sets the App Config for the current HubConfig, with skipUpdate option
+ |
+
void |
+setAuthMethod(DatabaseKind kind,
+ java.lang.String authMethod)
+Sets the SSL Auth Method for the DatabaseKind in the config
+ |
+
void |
+setCertFile(DatabaseKind kind,
+ java.lang.String certFile)
+Sets the SSL Certfile to use for the DatabaseKind in the config
+ |
+
void |
+setCertPass(DatabaseKind kind,
+ java.lang.String certPassword)
+Sets the SSL Cert password for the DatabaseKind in the config
+ |
+
void |
+setDbName(DatabaseKind kind,
+ java.lang.String dbName)
+Sets the database name for the databaseKind on the hubconfig
+ |
+
void |
+setExternalName(DatabaseKind kind,
+ java.lang.String externalName)
+Sets the external hostname for the DatabaseKind in the config
+ |
+
void |
+setForestsPerHost(DatabaseKind kind,
+ java.lang.Integer forestsPerHost)
+Sets the number of forests per host for the databaseKind on the hubconfig
+ |
+
void |
+setHttpName(DatabaseKind kind,
+ java.lang.String httpName)
+Sets the appserver name for the databaseKind on the hubconfig
+ |
+
void |
+setHubRoleName(java.lang.String hubRoleName)
+Set the role name that the hub uses
+ |
+
void |
+setHubUserName(java.lang.String hubUserName)
+Sets the username for the hub to use in MarkLogic
+ |
+
void |
+setPort(DatabaseKind kind,
+ java.lang.Integer port)
+Sets the port number for the databaseKind on the hubconfig
+ |
+
void |
+setProjectDir(java.lang.String projectDir) |
+
void |
+setScheme(DatabaseKind kind,
+ java.lang.String scheme)
+Sets the SSL Scheme for the DatabaseKind in the config
+ |
+
void |
+setSimpleSsl(DatabaseKind kind,
+ java.lang.Boolean simpleSsl)
+Sets if Simple SSL is to be used for the DatabaseKind in the config
+ |
+
void |
+setSslContext(DatabaseKind kind,
+ javax.net.ssl.SSLContext sslContext)
+Sets the SSL Context for the DatabaseKind in the config
+ |
+
void |
+setSslHostnameVerifier(DatabaseKind kind,
+ com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier)
+Sets the SSL Hostname Verifier object for the DatabaseKind in the config
+ |
+
static final java.lang.String HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES+
static final java.lang.String USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES+
static final java.lang.String USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES+
static final java.lang.String HUB_CONFIG_DIR+
static final java.lang.String USER_CONFIG_DIR+
static final java.lang.String ENTITY_CONFIG_DIR+
static final java.lang.String STAGING_ENTITY_QUERY_OPTIONS_FILE+
static final java.lang.String FINAL_ENTITY_QUERY_OPTIONS_FILE+
static final java.lang.String DEFAULT_STAGING_NAME+
static final java.lang.String DEFAULT_FINAL_NAME+
static final java.lang.String DEFAULT_TRACE_NAME+
static final java.lang.String DEFAULT_JOB_NAME+
static final java.lang.String DEFAULT_MODULES_DB_NAME+
static final java.lang.String DEFAULT_TRIGGERS_DB_NAME+
static final java.lang.String DEFAULT_SCHEMAS_DB_NAME+
static final java.lang.String DEFAULT_ROLE_NAME+
static final java.lang.String DEFAULT_USER_NAME+
static final java.lang.Integer DEFAULT_STAGING_PORT+
static final java.lang.Integer DEFAULT_FINAL_PORT+
static final java.lang.Integer DEFAULT_TRACE_PORT+
static final java.lang.Integer DEFAULT_JOB_PORT+
static final java.lang.String DEFAULT_AUTH_METHOD+
static final java.lang.String DEFAULT_SCHEME+
static final java.lang.Integer DEFAULT_FORESTS_PER_HOST+
static final java.lang.String DEFAULT_CUSTOM_FOREST_PATH+
java.lang.String getHost()+
static HubConfig create(java.lang.String projectDir)+
projectDir
- - string path to the project directoryjava.lang.String getDbName(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setDbName(DatabaseKind kind, + java.lang.String dbName)+
kind-
- DatabaseKind enum, eg: STAGING or JOBdbName
- The name desired for the databasejava.lang.String getHttpName(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setHttpName(DatabaseKind kind, + java.lang.String httpName)+
kind-
- DatabaseKind enum, eg: STAGING or JOBhttpName
- The name to set for the appserverjava.lang.Integer getForestsPerHost(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setForestsPerHost(DatabaseKind kind, + java.lang.Integer forestsPerHost)+
kind-
- DatabaseKind enum, eg: STAGING or JOBforestsPerHost
- The number of forests per hostjava.lang.Integer getPort(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setPort(DatabaseKind kind, + java.lang.Integer port)+
kind-
- DatabaseKind enum, eg: STAGING or JOBport
- The port number for the database appserverjavax.net.ssl.SSLContext getSslContext(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setSslContext(DatabaseKind kind, + javax.net.ssl.SSLContext sslContext)+
kind
- - DatabaseKind enum, eg: STAGING or JOBsslContext
- - The SSLContext set for the database connectionvoid setSslHostnameVerifier(DatabaseKind kind, + com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier stagingSslHostnameVerifier)+
kind
- - DatabaseKind enum, eg: STAGING or JOBstagingSslHostnameVerifier
- - The SSL Hostname Verifier object for the database connectioncom.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getSslHostnameVerifier(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBjava.lang.String getAuthMethod(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setAuthMethod(DatabaseKind kind, + java.lang.String authMethod)+
kind
- - DatabaseKind enum, eg: STAGING or JOBauthMethod
- - The SSL Auth Method for the database connectionjava.lang.String getScheme(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setScheme(DatabaseKind kind, + java.lang.String scheme)+
kind
- - DatabaseKind enum, eg: STAGING or JOBscheme
- - The SSL Scheme for the database connectionboolean getSimpleSsl(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setSimpleSsl(DatabaseKind kind, + java.lang.Boolean simpleSsl)+
kind
- - DatabaseKind enum, eg: STAGING or JOBsimpleSsl-
- true if you want to use Simple SSL, false if you don'tjava.lang.String getCertFile(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setCertFile(DatabaseKind kind, + java.lang.String certFile)+
kind
- - DatabaseKind enum, eg: STAGING or JOBcertFile
- - The SSL Cert File as a string to be used for the database connectionjava.lang.String getCertPassword(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setCertPass(DatabaseKind kind, + java.lang.String certPassword)+
kind
- - DatabaseKind enum, eg: STAGING or JOBcertPassword
- - The SSL certificate password for the database connectionjava.lang.String getExternalName(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setExternalName(DatabaseKind kind, + java.lang.String externalName)+
kind
- - DatabaseKind enum, eg: STAGING or JOBexternalName-
- The external host name for the database connectionjava.lang.String getHubRoleName()+
void setHubRoleName(java.lang.String hubRoleName)+
hubRoleName
- the name to usejava.lang.String getHubUserName()+
void setHubUserName(java.lang.String hubUserName)+
hubUserName
- - username to usejava.lang.String[] getLoadBalancerHosts()+
java.lang.String getCustomForestPath()+
java.lang.String getModulePermissions()+
java.lang.String getProjectDir()+
void setProjectDir(java.lang.String projectDir)+
projectDir
- HubProject getHubProject()+
void initHubProject()+
java.lang.String getHubModulesDeployTimestampFile()+
java.lang.String getUserModulesDeployTimestampFile()+
com.marklogic.client.DatabaseClient newAppServicesClient()+
com.marklogic.client.DatabaseClient newStagingClient()+
com.marklogic.client.DatabaseClient newStagingClient(java.lang.String databaseName)+
databaseName
- - the name of the database for the staging Client to usecom.marklogic.client.DatabaseClient newFinalClient()+
com.marklogic.client.DatabaseClient newJobDbClient()+
com.marklogic.client.DatabaseClient newTraceDbClient()+
com.marklogic.client.DatabaseClient newModulesDbClient()+
java.nio.file.Path getHubPluginsDir()+
java.nio.file.Path getHubEntitiesDir()+
java.nio.file.Path getHubConfigDir()+
java.nio.file.Path getHubDatabaseDir()+
java.nio.file.Path getHubServersDir()+
java.nio.file.Path getHubSecurityDir()+
java.nio.file.Path getUserConfigDir()+
java.nio.file.Path getUserSecurityDir()+
java.nio.file.Path getUserDatabaseDir()+
java.nio.file.Path getUserServersDir()+
java.nio.file.Path getEntityDatabaseDir()+
com.marklogic.appdeployer.AppConfig getAppConfig()+
void setAppConfig(com.marklogic.appdeployer.AppConfig config)+
config
- AppConfig to associate with the HubConfigvoid setAppConfig(com.marklogic.appdeployer.AppConfig config, + boolean skipUpdate)+
config
- - AppConfig to associate with the HubConfigskipUpdate
- false to force update of AppConfig, true to skip itjava.lang.String getJarVersion()+
public interface HubConfigBuilder
+HubConfig
Modifier and Type | +Method and Description | +
---|---|
HubConfig |
+build()
+Builds the
+HubConfig instance |
+
static HubConfigBuilder |
+newHubConfigBuilder(java.lang.String projectDir)
+Returns a new
+HubConfigBuilder instance |
+
HubConfigBuilder |
+withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)
+Sets the
+AdminConfig for the HubConfig |
+
HubConfigBuilder |
+withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)
+Sets the
+AdminManager for the HubConfig |
+
HubConfigBuilder |
+withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)
+Sets the
+AppConfig for the HubConfig |
+
HubConfigBuilder |
+withManageClient(com.marklogic.mgmt.ManageClient manageClient)
+Sets the
+ManageClient for the HubConfig |
+
HubConfigBuilder |
+withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)
+Sets the
+ManageConfig for the HubConfig |
+
HubConfigBuilder |
+withProperties(java.util.Properties properties)
+Tells the builder to use the given properties.
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment()
+Tells the builder to load properties from the gradle files in the project dir
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment(java.lang.String environment)
+Tells the builder to load properties from the gradle files in the project dir
+ but to look for an environment properties file with overrides
+ |
+
static HubConfigBuilder newHubConfigBuilder(java.lang.String projectDir)+
HubConfigBuilder
instanceprojectDir
- - the hub's project directoryHubConfigBuilder
HubConfigBuilder withPropertiesFromEnvironment()+
HubConfigBuilder
instanceHubConfigBuilder withPropertiesFromEnvironment(java.lang.String environment)+
environment
- - the name of the environment to use (local,dev,qa,prod,...)HubConfigBuilder
instanceHubConfigBuilder withProperties(java.util.Properties properties)+
properties
- - A Properties
object with properties setHubConfigBuilder
instanceHubConfigBuilder withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)+
AppConfig
for the HubConfig
appConfig
- - an AppConfig
objectHubConfigBuilder
instanceHubConfigBuilder withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
AdminConfig
for the HubConfig
adminConfig
- - an AdminConfig
objectHubConfigBuilder
instanceHubConfigBuilder withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
AdminManager
for the HubConfig
adminManager
- - an AdminManager
objectHubConfigBuilder
instanceHubConfigBuilder withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
ManageConfig
for the HubConfig
manageConfig
- - a ManageConfig
objectHubConfigBuilder
instanceHubConfigBuilder withManageClient(com.marklogic.mgmt.ManageClient manageClient)+
ManageClient
for the HubConfig
manageClient
- - a ManageClient
HubConfigBuilder
instancepublic interface HubProject
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+HUB_CONFIG_DIR |
+
static java.lang.String |
+USER_CONFIG_DIR |
+
Modifier and Type | +Method and Description | +
---|---|
static HubProject |
+create(java.lang.String projectDirStr)
+Creates a HubProject object and returns it in the base project directory
+ |
+
java.nio.file.Path |
+getEntityConfigDir()
+Gets the path for the user server's directory
+ |
+
java.nio.file.Path |
+getEntityDatabaseDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getHubConfigDir()
+Gets the path for the hub's entities directory
+ |
+
java.nio.file.Path |
+getHubDatabaseDir()
+Gets the path for the hub's config directory
+ |
+
java.nio.file.Path |
+getHubEntitiesDir()
+Gets the path for the hub plugins directory
+ |
+
java.nio.file.Path |
+getHubPluginsDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getHubSecurityDir()
+Gets the path for the hub servers directory
+ |
+
java.nio.file.Path |
+getHubServersDir()
+Gets the path for the hub's database directory
+ |
+
java.nio.file.Path |
+getUserConfigDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getUserDatabaseDir()
+Gets the path for the user security directory
+ |
+
java.nio.file.Path |
+getUserSchemasDir()
+Gets the path for the user schemas directory
+ |
+
java.nio.file.Path |
+getUserSecurityDir()
+Gets the path for the user config directory
+ |
+
java.nio.file.Path |
+getUserServersDir()
+Gets the path for the entity database directory
+ |
+
void |
+init(java.util.Map<java.lang.String,java.lang.String> customTokens)
+Initializes a directory as a hub project directory.
+ |
+
boolean |
+isInitialized()
+Checks if the project has been initialized or not
+ |
+
static final java.lang.String HUB_CONFIG_DIR+
static final java.lang.String USER_CONFIG_DIR+
static HubProject create(java.lang.String projectDirStr)+
projectDirStr
- - the base project directoryjava.nio.file.Path getHubPluginsDir()+
java.nio.file.Path getHubEntitiesDir()+
java.nio.file.Path getHubConfigDir()+
java.nio.file.Path getHubDatabaseDir()+
java.nio.file.Path getHubServersDir()+
java.nio.file.Path getHubSecurityDir()+
java.nio.file.Path getUserConfigDir()+
java.nio.file.Path getUserSecurityDir()+
java.nio.file.Path getUserDatabaseDir()+
java.nio.file.Path getUserSchemasDir()+
java.nio.file.Path getUserServersDir()+
java.nio.file.Path getEntityConfigDir()+
java.nio.file.Path getEntityDatabaseDir()+
boolean isInitialized()+
void init(java.util.Map<java.lang.String,java.lang.String> customTokens)+
customTokens
- - some custom tokens to start withpublic interface InstallInfo
+Modifier and Type | +Method and Description | +
---|---|
boolean |
+areForestsExistent(DatabaseKind kind)
+Checks to see if the forests are present and accessible
+ |
+
static InstallInfo |
+create()
+Creates and returns an installinfo object
+ |
+
boolean |
+isAppServerExistent(DatabaseKind kind)
+Checks to see if the App Server is present and accessible
+ |
+
boolean |
+isCollectionLexiconOn(DatabaseKind kind)
+Checks to see if the lexicon collection is set and on
+ |
+
boolean |
+isDbExistent(DatabaseKind kind)
+Checks to see if the Database is present and accessible
+ |
+
boolean |
+isInstalled()
+Checks if DHF has been installed
+ |
+
boolean |
+isPartiallyInstalled()
+Returns if an install has been performed, but not complete
+ |
+
boolean |
+isTripleIndexOn(DatabaseKind kind)
+Checks to see if the triple index is set and on
+ |
+
void |
+setAppServerExistent(DatabaseKind kind,
+ boolean stagingAppServerExists)
+Sets the boolean property if the app server exists for the databasekind
+ |
+
void |
+setCollectionLexiconOn(DatabaseKind kind,
+ boolean stagingCollectionLexiconOn)
+Sets if the collection lexicon is on or not
+ |
+
void |
+setDbExistent(DatabaseKind kind,
+ boolean stagingDbExists)
+Sets the boolean property if the database exists for the databasekind
+ |
+
void |
+setForestsExistent(DatabaseKind kind,
+ boolean stagingForestsExist)
+Sets the boolean property if the forests exist for the databasekind
+ |
+
void |
+setTripleIndexOn(DatabaseKind kind,
+ boolean stagingTripleIndexOn)
+Sets if the triple index is on or off by boolean
+ |
+
java.lang.String |
+toString()
+Returns the entire object as a string
+ |
+
static InstallInfo create()+
boolean isPartiallyInstalled()+
boolean isInstalled()+
java.lang.String toString()+
toString
in class java.lang.Object
boolean isAppServerExistent(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setAppServerExistent(DatabaseKind kind, + boolean stagingAppServerExists)+
kind
- - DatabaseKind enum, eg: STAGING or JOBstagingAppServerExists
- - true if it exists, false if it doesn'tboolean isDbExistent(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setDbExistent(DatabaseKind kind, + boolean stagingDbExists)+
kind
- - DatabaseKind enum, eg: STAGING or JOBstagingDbExists
- - true if it exists, false if it doesn'tboolean isTripleIndexOn(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setTripleIndexOn(DatabaseKind kind, + boolean stagingTripleIndexOn)+
kind
- - DatabaseKind enum, eg: STAGING or JOBstagingTripleIndexOn
- - true if the triple index is on, false if it is notboolean isCollectionLexiconOn(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setCollectionLexiconOn(DatabaseKind kind, + boolean stagingCollectionLexiconOn)+
kind
- - DatabaseKind enum, eg: STAGING or JOBstagingCollectionLexiconOn
- - true if it's on, false if it's notboolean areForestsExistent(DatabaseKind kind)+
kind
- - DatabaseKind enum, eg: STAGING or JOBvoid setForestsExistent(DatabaseKind kind, + boolean stagingForestsExist)+
kind
- - DatabaseKind enum, eg: STAGING or JOBstagingForestsExist
- - true if it exists, false if it doesn'tpublic interface Tracing
+Modifier and Type | +Method and Description | +
---|---|
static Tracing |
+create(com.marklogic.client.DatabaseClient client)
+Creates and returns a tracing object
+ |
+
void |
+disable()
+Disables tracing
+ |
+
void |
+enable()
+Enables tracing
+ |
+
boolean |
+isEnabled()
+Determines if the hub has tracing enabled or not
+ |
+
static Tracing create(com.marklogic.client.DatabaseClient client)+
client
- - the databaseclient that will be usedvoid enable()+
void disable()+
boolean isEnabled()+
public interface Collector
+Modifier and Type | +Method and Description | +
---|---|
com.marklogic.client.DatabaseClient |
+getClient()
+Gets the client in use currently by the collector object
+ |
+
CodeFormat |
+getCodeFormat()
+Obtains the code format for the collector in use
+ |
+
HubConfig |
+getHubConfig()
+Returns the current hubConfig ont he collector object
+ |
+
java.lang.String |
+getModule()
+Returns the module for the collect
+ |
+
DiskQueue<java.lang.String> |
+run(java.lang.String jobId,
+ java.lang.String entity,
+ java.lang.String flow,
+ int threadCount,
+ java.util.Map<java.lang.String,java.lang.Object> options)
+Obtains and grabs a list of uris that match the collector code
+ |
+
void |
+setClient(com.marklogic.client.DatabaseClient client)
+Sets the client to be used to communicate with the database
+ |
+
void |
+setHubConfig(HubConfig config)
+Set's the hub config for the collector
+ |
+
CodeFormat getCodeFormat()+
java.lang.String getModule()+
void setHubConfig(HubConfig config)+
config
- takes in a HubConfig objectHubConfig getHubConfig()+
void setClient(com.marklogic.client.DatabaseClient client)+
client
- - a databaseclient to usecom.marklogic.client.DatabaseClient getClient()+
DiskQueue<java.lang.String> run(java.lang.String jobId, + java.lang.String entity, + java.lang.String flow, + int threadCount, + java.util.Map<java.lang.String,java.lang.Object> options)+
jobId
- - id of the job this is to haveentity
- - name of which entity is this being run againstflow
- - name of which flowthreadCount
- - how many threads to use for the operationoptions
- - string/object map of options you want to pass to the collectorE
- - A Serializable Classpublic class DiskQueue<E extends java.io.Serializable>
+extends java.util.AbstractQueue<java.lang.String>
+Constructor and Description | +
---|
DiskQueue(int maxInMemorySize)
+Construct a disk-backed queue that keeps at most
+
+maxInMemorySize elements in memory. |
+
DiskQueue(int maxInMemorySize,
+ java.io.File tempDir)
+Construct a disk-backed queue that keeps at most
+
+maxInMemorySize elements in memory. |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+clear() |
+
protected void |
+finalize() |
+
java.util.Iterator<java.lang.String> |
+iterator() |
+
boolean |
+offer(java.lang.String element) |
+
java.lang.String |
+peek() |
+
java.lang.String |
+poll() |
+
java.lang.String |
+remove() |
+
int |
+size() |
+
add, addAll, element
contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray
forEach
public DiskQueue(int maxInMemorySize)+
maxInMemorySize
elements in memory.maxInMemorySize
- Maximum number of elements to keep in memory.public DiskQueue(int maxInMemorySize, + java.io.File tempDir)+
maxInMemorySize
elements in memory.maxInMemorySize
- Maximum number of elements to keep in memory.tempDir
- Directory where queue temporary files will be written to.protected void finalize() + throws java.lang.Throwable+
finalize
in class java.lang.Object
java.lang.Throwable
public java.util.Iterator<java.lang.String> iterator()+
iterator
in interface java.lang.Iterable<java.lang.String>
iterator
in interface java.util.Collection<java.lang.String>
iterator
in class java.util.AbstractCollection<java.lang.String>
public int size()+
size
in interface java.util.Collection<java.lang.String>
size
in class java.util.AbstractCollection<java.lang.String>
public boolean offer(java.lang.String element)+
public java.lang.String peek()+
public java.lang.String remove()+
remove
in interface java.util.Queue<java.lang.String>
remove
in class java.util.AbstractQueue<java.lang.String>
public java.lang.String poll()+
public void clear()+
clear
in interface java.util.Collection<java.lang.String>
clear
in class java.util.AbstractQueue<java.lang.String>
Constructor and Description | +
---|
CollectorImpl() |
+
CollectorImpl(java.lang.String module,
+ CodeFormat codeFormat) |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.client.DatabaseClient |
+getClient()
+Gets the client in use currently by the collector object
+ |
+
CodeFormat |
+getCodeFormat()
+Obtains the code format for the collector in use
+ |
+
HubConfig |
+getHubConfig()
+Returns the current hubConfig ont he collector object
+ |
+
java.lang.String |
+getModule()
+Returns the module for the collect
+ |
+
DiskQueue<java.lang.String> |
+run(java.lang.String jobId,
+ java.lang.String entity,
+ java.lang.String flow,
+ int threadCount,
+ java.util.Map<java.lang.String,java.lang.Object> options)
+Obtains and grabs a list of uris that match the collector code
+ |
+
void |
+setClient(com.marklogic.client.DatabaseClient client)
+Sets the client to be used to communicate with the database
+ |
+
void |
+setHubConfig(HubConfig config)
+Set's the hub config for the collector
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public CollectorImpl()+
public CollectorImpl(java.lang.String module, + CodeFormat codeFormat)+
public void setHubConfig(HubConfig config)+
Collector
setHubConfig
in interface Collector
config
- takes in a HubConfig objectpublic HubConfig getHubConfig()+
Collector
getHubConfig
in interface Collector
public void setClient(com.marklogic.client.DatabaseClient client)+
Collector
public com.marklogic.client.DatabaseClient getClient()+
Collector
public CodeFormat getCodeFormat()+
Collector
getCodeFormat
in interface Collector
public java.lang.String getModule()+
Collector
public DiskQueue<java.lang.String> run(java.lang.String jobId, + java.lang.String entity, + java.lang.String flow, + int threadCount, + java.util.Map<java.lang.String,java.lang.Object> options)+
Collector
run
in interface Collector
jobId
- - id of the job this is to haveentity
- - name of which entity is this being run againstflow
- - name of which flowthreadCount
- - how many threads to use for the operationoptions
- - string/object map of options you want to pass to the collectorClass | +Description | +
---|---|
CollectorImpl | ++ |
Interface | +Description | +
---|---|
Collector | +
+ Manages config and client for the collector, as well as runs the collector for the associated entity and flow
+ |
+
Class | +Description | +
---|---|
DiskQueue<E extends java.io.Serializable> | +
+ A queue that writes extra elements to disk, and reads them in as needed.
+ |
+
public class HubAppDeployer
+extends com.marklogic.appdeployer.impl.SimpleAppDeployer
+logger
Constructor and Description | +
---|
HubAppDeployer(com.marklogic.mgmt.ManageClient manageClient,
+ com.marklogic.mgmt.admin.AdminManager adminManager,
+ HubDeployStatusListener listener) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+deploy(com.marklogic.appdeployer.AppConfig appConfig) |
+
void |
+undeploy(com.marklogic.appdeployer.AppConfig appConfig) |
+
buildModifiableCommandList, getCommand, getCommandOfType, getCommands, removeCommand, setCommands
executeCommand, prepareCommand, undoCommand
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public HubAppDeployer(com.marklogic.mgmt.ManageClient manageClient, + com.marklogic.mgmt.admin.AdminManager adminManager, + HubDeployStatusListener listener)+
public void deploy(com.marklogic.appdeployer.AppConfig appConfig)+
deploy
in interface com.marklogic.appdeployer.AppDeployer
deploy
in class com.marklogic.appdeployer.impl.AbstractAppDeployer
public void undeploy(com.marklogic.appdeployer.AppConfig appConfig)+
undeploy
in interface com.marklogic.appdeployer.AppDeployer
undeploy
in class com.marklogic.appdeployer.impl.AbstractAppDeployer
public class DeployHubDatabaseCommand
+extends com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubDatabaseCommand(HubConfig config,
+ java.lang.String databaseFilename) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.lang.String |
+buildDefaultDatabasePayload(com.marklogic.appdeployer.command.CommandContext context) |
+
protected com.marklogic.appdeployer.command.forests.DeployForestsCommand |
+buildDeployForestsCommand(java.lang.String dbPayload,
+ com.marklogic.mgmt.SaveReceipt receipt,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.String |
+buildPayload(com.marklogic.appdeployer.command.CommandContext context) |
+
protected int |
+determineForestCountPerHost(java.lang.String dbPayload,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.String |
+getDatabaseFilename() |
+
java.lang.String |
+getDatabaseName() |
+
java.lang.String |
+getForestDelete() |
+
java.lang.String |
+getForestFilename() |
+
int |
+getForestsPerHost() |
+
protected java.lang.String |
+getPayload(com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.Integer |
+getUndoSortOrder() |
+
boolean |
+isCreateDatabaseWithoutFile() |
+
boolean |
+isCreateForestsOnEachHost() |
+
protected com.fasterxml.jackson.databind.JsonNode |
+mergeDatabaseFiles(com.marklogic.appdeployer.AppConfig appConfig) |
+
void |
+setCreateDatabaseWithoutFile(boolean createDatabaseWithoutFile) |
+
void |
+setCreateForestsOnEachHost(boolean createForestsOnEachHost) |
+
void |
+setDatabaseFilename(java.lang.String databaseFilename) |
+
void |
+setDatabaseName(java.lang.String databaseName) |
+
void |
+setForestDelete(java.lang.String forestDelete) |
+
void |
+setForestFilename(java.lang.String forestFilename) |
+
void |
+setForestsPerHost(int forestsPerHost) |
+
void |
+setUndoSortOrder(int undoSortOrder) |
+
java.lang.String |
+toString() |
+
void |
+undo(com.marklogic.appdeployer.command.CommandContext context) |
+
addSubDatabases, buildForest, customForestsExist, getForestDeleteLevel, getSuperDatabaseName, isCheckForCustomForests, isSubDatabase, newDatabaseManageForDeleting, removeSubDatabases, setCheckForCustomForests, setDatabaseFile, setSubDatabase, setSuperDatabaseName, shouldCreateForests
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecuteSortOrder
public DeployHubDatabaseCommand(HubConfig config, + java.lang.String databaseFilename)+
public java.lang.String toString()+
toString
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.Integer getUndoSortOrder()+
getUndoSortOrder
in interface com.marklogic.appdeployer.command.UndoableCommand
getUndoSortOrder
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
execute
in interface com.marklogic.appdeployer.command.Command
execute
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void undo(com.marklogic.appdeployer.command.CommandContext context)+
undo
in interface com.marklogic.appdeployer.command.UndoableCommand
undo
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String buildPayload(com.marklogic.appdeployer.command.CommandContext context)+
buildPayload
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected java.lang.String getPayload(com.marklogic.appdeployer.command.CommandContext context)+
getPayload
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected com.fasterxml.jackson.databind.JsonNode mergeDatabaseFiles(com.marklogic.appdeployer.AppConfig appConfig)+
protected com.marklogic.appdeployer.command.forests.DeployForestsCommand buildDeployForestsCommand(java.lang.String dbPayload, + com.marklogic.mgmt.SaveReceipt receipt, + com.marklogic.appdeployer.command.CommandContext context)+
buildDeployForestsCommand
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected int determineForestCountPerHost(java.lang.String dbPayload, + com.marklogic.appdeployer.command.CommandContext context)+
determineForestCountPerHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
protected java.lang.String buildDefaultDatabasePayload(com.marklogic.appdeployer.command.CommandContext context)+
buildDefaultDatabasePayload
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getForestDelete()+
public void setForestDelete(java.lang.String forestDelete)+
public int getForestsPerHost()+
getForestsPerHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setForestsPerHost(int forestsPerHost)+
setForestsPerHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getForestFilename()+
getForestFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setForestFilename(java.lang.String forestFilename)+
setForestFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setUndoSortOrder(int undoSortOrder)+
setUndoSortOrder
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getDatabaseFilename()+
getDatabaseFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setDatabaseFilename(java.lang.String databaseFilename)+
setDatabaseFilename
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public boolean isCreateDatabaseWithoutFile()+
isCreateDatabaseWithoutFile
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setCreateDatabaseWithoutFile(boolean createDatabaseWithoutFile)+
setCreateDatabaseWithoutFile
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public java.lang.String getDatabaseName()+
getDatabaseName
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setDatabaseName(java.lang.String databaseName)+
setDatabaseName
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public boolean isCreateForestsOnEachHost()+
isCreateForestsOnEachHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public void setCreateForestsOnEachHost(boolean createForestsOnEachHost)+
setCreateForestsOnEachHost
in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand
public class DeployHubDatabasesCommand
+extends com.marklogic.appdeployer.command.AbstractUndoableCommand
++ A key aspect of this class is its attempt to deploy/undeploy databases in the correct order. For each database file + that it finds that's not one of the default ones, a DeployDatabaseCommand will be created. All of those commands will + then be sorted based on the presence of "triggers-database" or "schema-database" within the payload for the command. +
+ If the above strategy doesn't work for you, you can always resort to naming your database files to control the order + that they're processed in. +
payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubDatabasesCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> |
+buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+undo(com.marklogic.appdeployer.command.CommandContext context) |
+
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public DeployHubDatabasesCommand(HubConfig config)+
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
public void undo(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context)+
public class DeployHubOtherDatabasesCommand
+extends com.marklogic.appdeployer.command.AbstractUndoableCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubOtherDatabasesCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> |
+buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
protected void |
+sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+undo(com.marklogic.appdeployer.command.CommandContext context) |
+
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public DeployHubOtherDatabasesCommand(HubConfig config)+
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeExecute(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
public void undo(com.marklogic.appdeployer.command.CommandContext context)+
protected void sortCommandsBeforeUndo(java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> list, + com.marklogic.appdeployer.command.CommandContext context)+
protected java.util.List<com.marklogic.appdeployer.command.databases.DeployDatabaseCommand> buildDatabaseCommands(com.marklogic.appdeployer.command.CommandContext context)+
public class DeployHubRolesCommand
+extends com.marklogic.appdeployer.command.security.DeployRolesCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubRolesCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
adjustPayloadBeforeSavingResource, execute, getResourceManager
afterResourceSaved, deleteResource, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
getUndoSortOrder, setUndoSortOrder
adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public class DeployHubSchemasDatabaseCommand +extends DeployHubDatabaseCommand+
Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DATABASE_FILENAME |
+
payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubSchemasDatabaseCommand(HubConfig hubConfig) |
+
buildDefaultDatabasePayload, buildDeployForestsCommand, buildPayload, determineForestCountPerHost, execute, getDatabaseFilename, getDatabaseName, getForestDelete, getForestFilename, getForestsPerHost, getPayload, getUndoSortOrder, isCreateDatabaseWithoutFile, isCreateForestsOnEachHost, mergeDatabaseFiles, setCreateDatabaseWithoutFile, setCreateForestsOnEachHost, setDatabaseFilename, setDatabaseName, setForestDelete, setForestFilename, setForestsPerHost, setUndoSortOrder, toString, undo
addSubDatabases, buildForest, customForestsExist, getForestDeleteLevel, getSuperDatabaseName, isCheckForCustomForests, isSubDatabase, newDatabaseManageForDeleting, removeSubDatabases, setCheckForCustomForests, setDatabaseFile, setSubDatabase, setSuperDatabaseName, shouldCreateForests
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecuteSortOrder
public static final java.lang.String DATABASE_FILENAME+
public class DeployHubServersCommand
+extends com.marklogic.appdeployer.command.AbstractResourceCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubServersCommand(HubConfig config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected void |
+deleteResource(com.marklogic.mgmt.resource.ResourceManager mgr,
+ com.marklogic.appdeployer.command.CommandContext context,
+ java.io.File f) |
+
protected java.lang.String |
+getPayload(java.io.File f,
+ com.marklogic.appdeployer.command.CommandContext context) |
+
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
protected com.marklogic.mgmt.resource.ResourceManager |
+getResourceManager(com.marklogic.appdeployer.command.CommandContext context) |
+
java.lang.Integer |
+getUndoSortOrder() |
+
protected com.fasterxml.jackson.databind.JsonNode |
+mergeServerFiles(java.io.File f) |
+
protected com.marklogic.mgmt.SaveReceipt |
+saveResource(com.marklogic.mgmt.resource.ResourceManager mgr,
+ com.marklogic.appdeployer.command.CommandContext context,
+ java.io.File f) |
+
afterResourceSaved, execute, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public DeployHubServersCommand(HubConfig config)+
protected java.io.File[] getResourceDirs(com.marklogic.appdeployer.command.CommandContext context)+
getResourceDirs
in class com.marklogic.appdeployer.command.AbstractResourceCommand
protected com.marklogic.mgmt.resource.ResourceManager getResourceManager(com.marklogic.appdeployer.command.CommandContext context)+
getResourceManager
in class com.marklogic.appdeployer.command.AbstractResourceCommand
public java.lang.Integer getUndoSortOrder()+
getUndoSortOrder
in interface com.marklogic.appdeployer.command.UndoableCommand
getUndoSortOrder
in class com.marklogic.appdeployer.command.AbstractUndoableCommand
protected com.marklogic.mgmt.SaveReceipt saveResource(com.marklogic.mgmt.resource.ResourceManager mgr, + com.marklogic.appdeployer.command.CommandContext context, + java.io.File f)+
saveResource
in class com.marklogic.appdeployer.command.AbstractCommand
protected void deleteResource(com.marklogic.mgmt.resource.ResourceManager mgr, + com.marklogic.appdeployer.command.CommandContext context, + java.io.File f)+
deleteResource
in class com.marklogic.appdeployer.command.AbstractResourceCommand
protected java.lang.String getPayload(java.io.File f, + com.marklogic.appdeployer.command.CommandContext context)+
protected com.fasterxml.jackson.databind.JsonNode mergeServerFiles(java.io.File f)+
public class DeployHubTriggersDatabaseCommand +extends DeployHubDatabaseCommand+
Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DATABASE_FILENAME |
+
payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubTriggersDatabaseCommand(HubConfig hubConfig) |
+
buildDefaultDatabasePayload, buildDeployForestsCommand, buildPayload, determineForestCountPerHost, execute, getDatabaseFilename, getDatabaseName, getForestDelete, getForestFilename, getForestsPerHost, getPayload, getUndoSortOrder, isCreateDatabaseWithoutFile, isCreateForestsOnEachHost, mergeDatabaseFiles, setCreateDatabaseWithoutFile, setCreateForestsOnEachHost, setDatabaseFilename, setDatabaseName, setForestDelete, setForestFilename, setForestsPerHost, setUndoSortOrder, toString, undo
addSubDatabases, buildForest, customForestsExist, getForestDeleteLevel, getSuperDatabaseName, isCheckForCustomForests, isSubDatabase, newDatabaseManageForDeleting, removeSubDatabases, setCheckForCustomForests, setDatabaseFile, setSubDatabase, setSuperDatabaseName, shouldCreateForests
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecuteSortOrder
public static final java.lang.String DATABASE_FILENAME+
public class DeployHubUsersCommand
+extends com.marklogic.appdeployer.command.security.DeployUsersCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
DeployHubUsersCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.io.File[] |
+getResourceDirs(com.marklogic.appdeployer.command.CommandContext context) |
+
getResourceManager
afterResourceSaved, deleteResource, execute, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, undo
getUndoSortOrder, setUndoSortOrder
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExecuteSortOrder
public class GenerateHubTDETemplateCommand
+extends com.marklogic.appdeployer.command.es.GenerateModelArtifactsCommand
+Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
payloadTokenReplacer
Constructor and Description | +
---|
GenerateHubTDETemplateCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected static java.util.Map<java.lang.String,java.io.File> |
+createEntityNameFileMap(java.util.List<java.io.File> entityFiles) |
+
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
protected static java.util.Optional<java.lang.String> |
+extactEntityNameFromFilename(java.lang.String filename) |
+
protected void |
+filterEntities(java.util.Map<java.lang.String,java.io.File> entityNameFileMap) |
+
protected java.util.List<java.io.File> |
+findEntityFiles() |
+
java.lang.String |
+getEntityNames() |
+
void |
+setEntityNames(java.lang.String entityNames) |
+
buildCodeGenerationRequest, buildDatabaseClient, fileHasDifferentContent, generateDatabaseProperties, generateExtractionTemplate, generateInstanceConverter, generateSchema, generateSearchOptions, loadModelDefinition, loadModelDefinition, removeGeneratedAtTimestamp, selectModulesDir, setOptionsPath
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public GenerateHubTDETemplateCommand(HubConfig hubConfig)+
public void execute(com.marklogic.appdeployer.command.CommandContext context)+
execute
in interface com.marklogic.appdeployer.command.Command
execute
in class com.marklogic.appdeployer.command.es.GenerateModelArtifactsCommand
public java.lang.String getEntityNames()+
public void setEntityNames(java.lang.String entityNames)+
protected void filterEntities(java.util.Map<java.lang.String,java.io.File> entityNameFileMap)+
protected static java.util.Map<java.lang.String,java.io.File> createEntityNameFileMap(java.util.List<java.io.File> entityFiles)+
protected java.util.List<java.io.File> findEntityFiles()+
protected static java.util.Optional<java.lang.String> extactEntityNameFromFilename(java.lang.String filename)+
public class LoadHubModulesCommand
+extends com.marklogic.appdeployer.command.AbstractCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
LoadHubModulesCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class LoadUserModulesCommand
+extends com.marklogic.appdeployer.command.AbstractCommand
+payloadTokenReplacer
logger
Constructor and Description | +
---|
LoadUserModulesCommand(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+execute(com.marklogic.appdeployer.command.CommandContext context) |
+
void |
+setForceLoad(boolean forceLoad) |
+
adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, copyFileToString, copyFileToString, getExecuteSortOrder, listFilesInDirectory, logResourceDirectoryNotFound, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setPayloadTokenReplacer, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setStoreResourceIdsAsCustomTokens, storeTokenForResourceId
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
DeployHubDatabaseCommand | +
+ Can be used for creating any kind of database with any sorts of forests.
+ |
+
DeployHubDatabasesCommand | +
+ This commands handles deploying/undeploying every database file except the "default" ones of content-database.json,
+ triggers-database.json, and schemas-database.json.
+ |
+
DeployHubOtherDatabasesCommand | ++ |
DeployHubRolesCommand | ++ |
DeployHubSchemasDatabaseCommand | ++ |
DeployHubServersCommand | ++ |
DeployHubTriggersDatabaseCommand | ++ |
DeployHubUsersCommand | ++ |
GenerateHubTDETemplateCommand | ++ |
LoadHubModulesCommand | ++ |
LoadUserModulesCommand | ++ |
Class | +Description | +
---|---|
HubAppDeployer | ++ |
public interface HubDeployStatusListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+onError()
+Method to execute when the listener throws an error
+ |
+
void |
+onStatusChange(int percentComplete,
+ java.lang.String message)
+Sets the status change with a message
+ |
+
void onStatusChange(int percentComplete, + java.lang.String message)+
percentComplete
- - percentage (out of 100) completed in integermessage
- - the string message to be passed with this thresholdvoid onError()+
public class HubFileFilter
+extends java.lang.Object
+implements java.io.FileFilter
+Constructor and Description | +
---|
HubFileFilter() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+accept(java.io.File f) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Interface | +Description | +
---|---|
HubDeployStatusListener | ++ |
Class | +Description | +
---|---|
HubFileFilter | +
+ Simple implementation that accepts every file and ignores anything starting with ".".
+ |
+
public abstract class AbstractEntity +extends java.lang.Object +implements Entity+
Constructor and Description | +
---|
AbstractEntity(org.w3c.dom.Element xml) |
+
AbstractEntity(java.lang.String name) |
+
Modifier and Type | +Method and Description | +
---|---|
java.util.List<Flow> |
+getFlows()
+Returns all flows registered to the entity
+ |
+
java.lang.String |
+getName()
+Gets the Entity name
+ |
+
java.lang.String |
+serialize()
+Serializes the Entity as an XML string
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public AbstractEntity(org.w3c.dom.Element xml)+
public AbstractEntity(java.lang.String name)+
public java.lang.String getName()+
Entity
public java.lang.String serialize()+
Entity
public interface Entity
+Modifier and Type | +Method and Description | +
---|---|
java.util.List<Flow> |
+getFlows()
+Returns all flows registered to the entity
+ |
+
java.lang.String |
+getName()
+Gets the Entity name
+ |
+
java.lang.String |
+serialize()
+Serializes the Entity as an XML string
+ |
+
java.lang.String getName()+
java.lang.String serialize()+
java.util.List<Flow> getFlows()+
public class EntityImpl +extends AbstractEntity+
Constructor and Description | +
---|
EntityImpl(org.w3c.dom.Element xml) |
+
EntityImpl(java.lang.String name) |
+
Interface | +Description | +
---|---|
Entity | +
+ Entity interface, holds basics about a defined entity object
+ |
+
Class | +Description | +
---|---|
AbstractEntity | +
+ Abstract Base class for entities
+ |
+
EntityImpl | +
+ An implementation of the Entity base class
+ |
+
public class CantUpgradeException
+extends java.lang.Exception
+Constructor and Description | +
---|
CantUpgradeException(java.lang.String version,
+ java.lang.String minVersion) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class DataHubConfigurationException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
DataHubConfigurationException() |
+
DataHubConfigurationException(java.lang.String message) |
+
DataHubConfigurationException(java.lang.String message,
+ java.lang.Throwable t) |
+
DataHubConfigurationException(java.lang.Throwable t) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public DataHubConfigurationException()+
public DataHubConfigurationException(java.lang.String message)+
public DataHubConfigurationException(java.lang.String message, + java.lang.Throwable t)+
public DataHubConfigurationException(java.lang.Throwable t)+
public class DataHubProjectException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
DataHubProjectException() |
+
DataHubProjectException(java.lang.String message) |
+
DataHubProjectException(java.lang.String message,
+ java.lang.Throwable t) |
+
DataHubProjectException(java.lang.Throwable t) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public DataHubProjectException()+
public DataHubProjectException(java.lang.String message)+
public DataHubProjectException(java.lang.String message, + java.lang.Throwable t)+
public DataHubProjectException(java.lang.Throwable t)+
public class EntityServicesGenerationException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
EntityServicesGenerationException() |
+
EntityServicesGenerationException(java.lang.String message) |
+
EntityServicesGenerationException(java.lang.String message,
+ java.lang.Throwable e) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public EntityServicesGenerationException()+
public EntityServicesGenerationException(java.lang.String message)+
public EntityServicesGenerationException(java.lang.String message, + java.lang.Throwable e)+
public class InvalidDBOperationError
+extends java.lang.Error
+Constructor and Description | +
---|
InvalidDBOperationError(DatabaseKind kind,
+ java.lang.String operation) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public InvalidDBOperationError(DatabaseKind kind, + java.lang.String operation)+
public class LegacyFlowsException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
LegacyFlowsException(java.util.List<java.lang.String> legacyFlows) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class ScaffoldingValidationException
+extends java.lang.Exception
+Constructor and Description | +
---|
ScaffoldingValidationException(java.lang.String message) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class ServerValidationException
+extends java.lang.RuntimeException
+Constructor and Description | +
---|
ServerValidationException(java.lang.String message) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Exception | +Description | +
---|---|
CantUpgradeException | ++ |
DataHubConfigurationException | +
+ An exception to wrap issues found while configuring the Data Hub Framework
+ |
+
DataHubProjectException | +
+ An exception for issues when retrieving data from the project directory.
+ |
+
EntityServicesGenerationException | ++ |
LegacyFlowsException | ++ |
ScaffoldingValidationException | ++ |
ServerValidationException | ++ |
Error | +Description | +
---|---|
InvalidDBOperationError | ++ |
public enum CodeFormat +extends java.lang.Enum<CodeFormat>+
Enum Constant and Description | +
---|
JAVASCRIPT |
+
XQUERY |
+
Modifier and Type | +Method and Description | +
---|---|
static CodeFormat |
+getCodeFormat(java.lang.String format) |
+
java.lang.String |
+toString() |
+
static CodeFormat |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static CodeFormat[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final CodeFormat JAVASCRIPT+
public static final CodeFormat XQUERY+
public static CodeFormat[] values()+
+for (CodeFormat c : CodeFormat.values()) + System.out.println(c); +
public static CodeFormat valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static CodeFormat getCodeFormat(java.lang.String format)+
public java.lang.String toString()+
toString
in class java.lang.Enum<CodeFormat>
public enum DataFormat +extends java.lang.Enum<DataFormat>+
Enum Constant and Description | +
---|
JSON |
+
XML |
+
Modifier and Type | +Method and Description | +
---|---|
static DataFormat |
+getDataFormat(java.lang.String type) |
+
java.lang.String |
+toString() |
+
static DataFormat |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static DataFormat[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final DataFormat XML+
public static final DataFormat JSON+
public static DataFormat[] values()+
+for (DataFormat c : DataFormat.values()) + System.out.println(c); +
public static DataFormat valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static DataFormat getDataFormat(java.lang.String type)+
public java.lang.String toString()+
toString
in class java.lang.Enum<DataFormat>
public interface Flow
+Modifier and Type | +Method and Description | +
---|---|
CodeFormat |
+getCodeFormat()
+Returns the CodeFormat enum of the flow
+ |
+
Collector |
+getCollector()
+Gets the collector to be used for the flow
+ |
+
DataFormat |
+getDataFormat()
+Returns the DataForm enum of the flow
+ |
+
java.lang.String |
+getEntityName()
+Returns the name of the entity that's been set for the flow in strong form
+ |
+
java.lang.String |
+getFlowDbPath()
+Gets the DbPath (uri) for the flow in string form
+ |
+
MainPlugin |
+getMain()
+Gets the main plugin module that the flow is set to use
+ |
+
java.lang.String |
+getName()
+Gets the name of the flow
+ |
+
FlowType |
+getType()
+Gets the FlowType enum for the flow
+ |
+
java.lang.String |
+serialize()
+Serializes the flow into an xml string
+ |
+
void |
+setCodeFormat(CodeFormat codeFormat)
+Sets the CodeFormat enum of the flow
+ |
+
void |
+setCollector(Collector collector)
+Sets the collector to be used for the flow
+ |
+
void |
+setDataFormat(DataFormat dataFormat)
+Sets the DataFormat for the flow
+ |
+
void |
+setEntityName(java.lang.String entityName)
+Sets the entity name for the flow
+ |
+
void |
+setMain(MainPlugin main)
+Sets the main plugin module for the flow
+ |
+
void |
+setName(java.lang.String name)
+Sets the name of the flow
+ |
+
void |
+setType(FlowType type)
+Sets the type of the flow
+ |
+
java.util.Properties |
+toProperties()
+Creates a properties object representing the flow
+ |
+
void setEntityName(java.lang.String entityName)+
entityName
- the string name of the entity to use in the flowjava.lang.String getEntityName()+
void setName(java.lang.String name)+
name
- - string representing the name of the flowjava.lang.String getName()+
void setType(FlowType type)+
type
- - FlowType enum for harmonize or inputFlowType getType()+
void setDataFormat(DataFormat dataFormat)+
dataFormat
- - DataFormat enum of json or xmlDataFormat getDataFormat()+
void setCodeFormat(CodeFormat codeFormat)+
codeFormat
- enum of sjs or xqyCodeFormat getCodeFormat()+
java.lang.String serialize()+
java.util.Properties toProperties()+
java.lang.String getFlowDbPath()+
Collector getCollector()+
void setCollector(Collector collector)+
collector
- the collector to be used for the flowMainPlugin getMain()+
void setMain(MainPlugin main)+
main
- - a MainPlugin object that defines the main plugin to be usedpublic class FlowBuilder
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
Flow |
+build() |
+
static FlowBuilder |
+newFlow() |
+
FlowBuilder |
+withCodeFormat(CodeFormat codeFormat) |
+
FlowBuilder |
+withCollector(Collector collector) |
+
FlowBuilder |
+withDataFormat(DataFormat dataFormat) |
+
FlowBuilder |
+withEntityName(java.lang.String entityName) |
+
FlowBuilder |
+withMain(MainPlugin main) |
+
FlowBuilder |
+withName(java.lang.String flowName) |
+
FlowBuilder |
+withType(FlowType type) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static FlowBuilder newFlow()+
public FlowBuilder withName(java.lang.String flowName)+
public FlowBuilder withEntityName(java.lang.String entityName)+
public FlowBuilder withType(FlowType type)+
public FlowBuilder withDataFormat(DataFormat dataFormat)+
public FlowBuilder withCodeFormat(CodeFormat codeFormat)+
public FlowBuilder withCollector(Collector collector)+
public FlowBuilder withMain(MainPlugin main)+
public Flow build()+
public interface FlowFinishedListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+onFlowFinished()
+Listens for when the flow is complete
+ |
+
public interface FlowItemCompleteListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+processCompletion(java.lang.String jobId,
+ java.lang.String itemId)
+Listener interface for each flow item completing successfully
+ |
+
public interface FlowItemFailureListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+processFailure(java.lang.String jobId,
+ java.lang.String itemId)
+Listener interface for each flow item that failed
+ |
+
public interface FlowRunner
+Modifier and Type | +Method and Description | +
---|---|
void |
+awaitCompletion()
+Blocks until the job is complete.
+ |
+
void |
+awaitCompletion(long timeout,
+ java.util.concurrent.TimeUnit unit)
+Blocks until the job is complete.
+ |
+
FlowRunner |
+onFinished(FlowFinishedListener listener)
+Sets the finished listener for when the item has processed (similar to a finally)
+ |
+
FlowRunner |
+onItemComplete(FlowItemCompleteListener listener)
+Sets a listener on each item completing
+ |
+
FlowRunner |
+onItemFailed(FlowItemFailureListener listener)
+Sets the failure listener for each item in the flow
+ |
+
FlowRunner |
+onStatusChanged(FlowStatusListener listener)
+Sets the status change listener on the flowrunner object
+ |
+
com.marklogic.client.datamovement.JobTicket |
+run()
+Runs the flow and creates the job
+ |
+
FlowRunner |
+withBatchSize(int batchSize)
+Sets the batch size for the flow runner
+ |
+
FlowRunner |
+withDestinationDatabase(java.lang.String destinationDatabase)
+Sets the database where flow output data will be presisted to
+ |
+
FlowRunner |
+withFlow(Flow flow)
+Sets the flow to be used with the flow runner
+ |
+
FlowRunner |
+withOptions(java.util.Map<java.lang.String,java.lang.Object> options)
+Sets the options to be passed into the xqy or sjs flow in the $options or options variables of main.
+ |
+
FlowRunner |
+withSourceClient(com.marklogic.client.DatabaseClient sourceClient)
+Sets the source client on the flow runner.
+ |
+
FlowRunner |
+withStopOnFailure(boolean stopOnFailure)
+Sets if this will stop the job on a failure, or if it will continue on
+ |
+
FlowRunner |
+withThreadCount(int threadCount)
+Sets the thread count for the flowrunner
+ |
+
FlowRunner withFlow(Flow flow)+
flow
- the flow object to be usedFlowRunner withBatchSize(int batchSize)+
batchSize
- - the size of the batch in integer formFlowRunner withThreadCount(int threadCount)+
threadCount
- - the number of threads for the flow runner to useFlowRunner withSourceClient(com.marklogic.client.DatabaseClient sourceClient)+
sourceClient
- - the client that will be usedFlowRunner withDestinationDatabase(java.lang.String destinationDatabase)+
destinationDatabase
- - the name of the databaseFlowRunner withOptions(java.util.Map<java.lang.String,java.lang.Object> options)+
options
- - the object map of options as string/object pairFlowRunner withStopOnFailure(boolean stopOnFailure)+
stopOnFailure
- FlowRunner onItemComplete(FlowItemCompleteListener listener)+
listener
- the listen object to setFlowRunner onItemFailed(FlowItemFailureListener listener)+
listener
- the listener for the failures in the flowFlowRunner onStatusChanged(FlowStatusListener listener)+
listener
- - the listener for when the status changesFlowRunner onFinished(FlowFinishedListener listener)+
listener
- - the listener for the flow item when it finishesvoid awaitCompletion()+
void awaitCompletion(long timeout, + java.util.concurrent.TimeUnit unit) + throws java.lang.InterruptedException+
timeout
- the maximum time to waitunit
- the time unit of the timeout argumentjava.lang.InterruptedException
- if interrupted while waitingcom.marklogic.client.datamovement.JobTicket run()+
public interface FlowStatusListener
+Modifier and Type | +Method and Description | +
---|---|
void |
+onStatusChange(java.lang.String jobId,
+ int percentComplete,
+ java.lang.String message) |
+
void onStatusChange(java.lang.String jobId, + int percentComplete, + java.lang.String message)+
jobId
- - the id of the job to changepercentComplete
- - the percentage of completeness expressed as an intmessage
- - the message you'd like to send along with itEnum Constant and Description | +
---|
HARMONIZE |
+
INPUT |
+
Modifier and Type | +Method and Description | +
---|---|
static FlowType |
+getFlowType(java.lang.String type) |
+
java.lang.String |
+toString() |
+
static FlowType |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static FlowType[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final FlowType INPUT+
public static final FlowType HARMONIZE+
public static FlowType[] values()+
+for (FlowType c : FlowType.values()) + System.out.println(c); +
public static FlowType valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static FlowType getFlowType(java.lang.String type)+
public java.lang.String toString()+
toString
in class java.lang.Enum<FlowType>
public class RunFlowResponse
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
java.util.List<java.lang.String> |
+completedItems |
+
long |
+errorCount |
+
java.util.List<com.fasterxml.jackson.databind.JsonNode> |
+errors |
+
java.util.List<java.lang.String> |
+failedItems |
+
long |
+totalCount |
+
Constructor and Description | +
---|
RunFlowResponse() |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+toString() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public long totalCount+
public long errorCount+
public java.util.List<java.lang.String> completedItems+
public java.util.List<java.lang.String> failedItems+
public java.util.List<com.fasterxml.jackson.databind.JsonNode> errors+
Modifier and Type | +Method and Description | +
---|---|
static Flow |
+fromXml(org.w3c.dom.Node xml) |
+
CodeFormat |
+getCodeFormat()
+Returns the CodeFormat enum of the flow
+ |
+
Collector |
+getCollector()
+Gets the collector to be used for the flow
+ |
+
DataFormat |
+getDataFormat()
+Returns the DataForm enum of the flow
+ |
+
java.lang.String |
+getEntityName()
+Returns the name of the entity that's been set for the flow in strong form
+ |
+
java.lang.String |
+getFlowDbPath()
+Gets the DbPath (uri) for the flow in string form
+ |
+
MainPlugin |
+getMain()
+Gets the main plugin module that the flow is set to use
+ |
+
java.lang.String |
+getName()
+Gets the name of the flow
+ |
+
FlowType |
+getType()
+Gets the FlowType enum for the flow
+ |
+
static Flow |
+loadFromFile(java.io.File file) |
+
java.lang.String |
+serialize()
+Serializes the flow into an xml string
+ |
+
void |
+setCodeFormat(CodeFormat codeFormat)
+Sets the CodeFormat enum of the flow
+ |
+
void |
+setCollector(Collector collector)
+Sets the collector to be used for the flow
+ |
+
void |
+setDataFormat(DataFormat dataFormat)
+Sets the DataFormat for the flow
+ |
+
void |
+setEntityName(java.lang.String entityName)
+Sets the entity name for the flow
+ |
+
void |
+setMain(MainPlugin main)
+Sets the main plugin module for the flow
+ |
+
void |
+setName(java.lang.String name)
+Sets the name of the flow
+ |
+
void |
+setType(FlowType type)
+Sets the type of the flow
+ |
+
java.util.Properties |
+toProperties()
+Creates a properties object representing the flow
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public void setEntityName(java.lang.String entityName)+
Flow
setEntityName
in interface Flow
entityName
- the string name of the entity to use in the flowpublic java.lang.String getEntityName()+
Flow
getEntityName
in interface Flow
public void setName(java.lang.String name)+
Flow
public java.lang.String getName()+
Flow
public void setType(FlowType type)+
Flow
public FlowType getType()+
Flow
public void setDataFormat(DataFormat dataFormat)+
Flow
setDataFormat
in interface Flow
dataFormat
- - DataFormat enum of json or xmlpublic DataFormat getDataFormat()+
Flow
getDataFormat
in interface Flow
public void setCodeFormat(CodeFormat codeFormat)+
Flow
setCodeFormat
in interface Flow
codeFormat
- enum of sjs or xqypublic CodeFormat getCodeFormat()+
Flow
getCodeFormat
in interface Flow
public Collector getCollector()+
Flow
getCollector
in interface Flow
public void setCollector(Collector collector)+
Flow
setCollector
in interface Flow
collector
- the collector to be used for the flowpublic MainPlugin getMain()+
Flow
public void setMain(MainPlugin main)+
Flow
public java.lang.String serialize()+
Flow
public java.util.Properties toProperties()+
Flow
toProperties
in interface Flow
public static Flow loadFromFile(java.io.File file)+
public static Flow fromXml(org.w3c.dom.Node xml)+
public java.lang.String getFlowDbPath()+
Flow
getFlowDbPath
in interface Flow
public class FlowRunnerImpl +extends java.lang.Object +implements FlowRunner+
Constructor and Description | +
---|
FlowRunnerImpl(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+awaitCompletion()
+Blocks until the job is complete.
+ |
+
void |
+awaitCompletion(long timeout,
+ java.util.concurrent.TimeUnit unit)
+Blocks until the job is complete.
+ |
+
FlowRunner |
+onFinished(FlowFinishedListener listener)
+Sets the finished listener for when the item has processed (similar to a finally)
+ |
+
FlowRunner |
+onItemComplete(FlowItemCompleteListener listener)
+Sets a listener on each item completing
+ |
+
FlowRunner |
+onItemFailed(FlowItemFailureListener listener)
+Sets the failure listener for each item in the flow
+ |
+
FlowRunner |
+onStatusChanged(FlowStatusListener listener)
+Sets the status change listener on the flowrunner object
+ |
+
com.marklogic.client.datamovement.JobTicket |
+run()
+Runs the flow and creates the job
+ |
+
FlowRunner |
+withBatchSize(int batchSize)
+Sets the batch size for the flow runner
+ |
+
FlowRunner |
+withDestinationDatabase(java.lang.String destinationDatabase)
+Sets the database where flow output data will be presisted to
+ |
+
FlowRunner |
+withFlow(Flow flow)
+Sets the flow to be used with the flow runner
+ |
+
FlowRunner |
+withOptions(java.util.Map<java.lang.String,java.lang.Object> options)
+Sets the options to be passed into the xqy or sjs flow in the $options or options variables of main.
+ |
+
FlowRunner |
+withSourceClient(com.marklogic.client.DatabaseClient sourceClient)
+Sets the source client on the flow runner.
+ |
+
FlowRunner |
+withStopOnFailure(boolean stopOnFailure)
+Sets if this will stop the job on a failure, or if it will continue on
+ |
+
FlowRunner |
+withThreadCount(int threadCount)
+Sets the thread count for the flowrunner
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public FlowRunnerImpl(HubConfig hubConfig)+
public FlowRunner withFlow(Flow flow)+
FlowRunner
withFlow
in interface FlowRunner
flow
- the flow object to be usedpublic FlowRunner withBatchSize(int batchSize)+
FlowRunner
withBatchSize
in interface FlowRunner
batchSize
- - the size of the batch in integer formpublic FlowRunner withThreadCount(int threadCount)+
FlowRunner
withThreadCount
in interface FlowRunner
threadCount
- - the number of threads for the flow runner to usepublic FlowRunner withSourceClient(com.marklogic.client.DatabaseClient sourceClient)+
FlowRunner
withSourceClient
in interface FlowRunner
sourceClient
- - the client that will be usedpublic FlowRunner withDestinationDatabase(java.lang.String destinationDatabase)+
FlowRunner
withDestinationDatabase
in interface FlowRunner
destinationDatabase
- - the name of the databasepublic FlowRunner withStopOnFailure(boolean stopOnFailure)+
FlowRunner
withStopOnFailure
in interface FlowRunner
public FlowRunner withOptions(java.util.Map<java.lang.String,java.lang.Object> options)+
FlowRunner
withOptions
in interface FlowRunner
options
- - the object map of options as string/object pairpublic FlowRunner onItemComplete(FlowItemCompleteListener listener)+
FlowRunner
onItemComplete
in interface FlowRunner
listener
- the listen object to setpublic FlowRunner onItemFailed(FlowItemFailureListener listener)+
FlowRunner
onItemFailed
in interface FlowRunner
listener
- the listener for the failures in the flowpublic FlowRunner onStatusChanged(FlowStatusListener listener)+
FlowRunner
onStatusChanged
in interface FlowRunner
listener
- - the listener for when the status changespublic FlowRunner onFinished(FlowFinishedListener listener)+
FlowRunner
onFinished
in interface FlowRunner
listener
- - the listener for the flow item when it finishespublic void awaitCompletion()+
FlowRunner
awaitCompletion
in interface FlowRunner
public void awaitCompletion(long timeout, + java.util.concurrent.TimeUnit unit) + throws java.lang.InterruptedException+
FlowRunner
awaitCompletion
in interface FlowRunner
timeout
- the maximum time to waitunit
- the time unit of the timeout argumentjava.lang.InterruptedException
- if interrupted while waitingpublic com.marklogic.client.datamovement.JobTicket run()+
FlowRunner
run
in interface FlowRunner
Class | +Description | +
---|---|
FlowImpl | ++ |
FlowRunnerImpl | ++ |
Interface | +Description | +
---|---|
Flow | +
+ Manages the creation and configuration of flow objects
+ |
+
FlowFinishedListener | ++ |
FlowItemCompleteListener | ++ |
FlowItemFailureListener | ++ |
FlowRunner | +
+ Executes a flow with options
+ |
+
FlowStatusListener | ++ |
Class | +Description | +
---|---|
FlowBuilder | ++ |
RunFlowResponse | ++ |
Enum | +Description | +
---|---|
CodeFormat | ++ |
DataFormat | ++ |
FlowType | ++ |
Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
static java.lang.String |
+MIN_UPGRADE_VERSION |
+
Constructor and Description | +
---|
DataHubImpl(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+clearDatabase(java.lang.String database)
+Clears the database of all documents
+ |
+
void |
+clearUserModules()
+Removes user's modules from the modules db
+ |
+
java.util.List<com.marklogic.appdeployer.command.Command> |
+getCommandList() |
+
java.lang.String |
+getPortInUseBy(DatabaseKind kind)
+Returns name of what is using the port
+ |
+
java.lang.String |
+getServerVersion()
+Returns the string presentation of the server version, eg: "9.03-1"
+ |
+
void |
+initProject()
+Initializes the project on disk, creates scaffold project code
+ |
+
void |
+install()
+Installs the data hub configuration and server-side config files into MarkLogic
+ |
+
void |
+install(HubDeployStatusListener listener)
+Installs the data hub configuration and server-side config files into MarkLogic
+ |
+
InstallInfo |
+isInstalled()
+Determines if the data hub is installed in MarkLogic
+ |
+
boolean |
+isPortInUse(DatabaseKind kind)
+Checks to see if the port is in use
+ |
+
boolean |
+isSafeToInstall()
+Checks to make sure all the versions and database in a valid configuration with version check
+ |
+
boolean |
+isServerVersionOk()
+Checks to see if the datahub and server versions are compatible
+ |
+
boolean |
+isServerVersionValid(java.lang.String versionString)
+Validates the MarkLogic server to ensure compatibility with the hub
+ |
+
java.util.HashMap |
+runPreInstallCheck()
+Runs the pre-install check for the datahub populating the object
+ with variables necessary to perform the install.
+ |
+
java.util.HashMap |
+runPreInstallCheck(Versions versions)
+Runs the pre-install check for the datahub populating the object
+ with variables necessary to perform the install.
+ |
+
void |
+setPortInUseBy(DatabaseKind kind,
+ java.lang.String usedBy)
+Sets what appserver name is using the port
+ |
+
void |
+setServerManager(com.marklogic.mgmt.resource.appservers.ServerManager manager) |
+
void |
+setServerVersion(java.lang.String serverVersion)
+Sets the server version holder on the datahub object - currently unused
+ |
+
void |
+setServerVersionOk(boolean serverVersionOk)
+Sets true or false if the server version is okay with this version of DHF
+ |
+
void |
+uninstall()
+Uninstalls the data hub configuration and server-side config files from MarkLogic
+ |
+
void |
+uninstall(HubDeployStatusListener listener)
+Uninstalls the data hub configuration and server-side config files from MarkLogic
+ |
+
void |
+updateIndexes()
+Updates the indexes in the database based on the project
+ |
+
boolean |
+upgradeHub()
+Upgrades the installed datahub on the server to this version of the DataHub
+ |
+
boolean |
+upgradeHub(java.util.List<java.lang.String> updatedFlows)
+Upgrades the hub based on list of provided updated flows.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
protected final org.slf4j.Logger logger+
public static java.lang.String MIN_UPGRADE_VERSION+
public void clearDatabase(java.lang.String database)+
DataHub
clearDatabase
in interface DataHub
database
- - the name of the database in string formpublic void setServerManager(com.marklogic.mgmt.resource.appservers.ServerManager manager)+
public InstallInfo isInstalled()+
DataHub
isInstalled
in interface DataHub
public boolean isServerVersionValid(java.lang.String versionString)+
DataHub
isServerVersionValid
in interface DataHub
versionString
- - the version of the server to validatepublic void initProject()+
DataHub
initProject
in interface DataHub
public void clearUserModules()+
DataHub
clearUserModules
in interface DataHub
public java.util.List<com.marklogic.appdeployer.command.Command> getCommandList()+
public java.util.HashMap runPreInstallCheck()+
DataHub
runPreInstallCheck
in interface DataHub
public java.util.HashMap runPreInstallCheck(Versions versions)+
DataHub
runPreInstallCheck
in interface DataHub
versions
- - the versions that the check is to be run againstpublic void install()+
public void install(HubDeployStatusListener listener)+
public void updateIndexes()+
DataHub
updateIndexes
in interface DataHub
public void uninstall()+
public void uninstall(HubDeployStatusListener listener)+
public boolean isSafeToInstall()+
DataHub
isSafeToInstall
in interface DataHub
public boolean isPortInUse(DatabaseKind kind)+
DataHub
isPortInUse
in interface DataHub
kind
- - the DatabaseKind enum value (ex STAGING or JOB)public void setPortInUseBy(DatabaseKind kind, + java.lang.String usedBy)+
DataHub
setPortInUseBy
in interface DataHub
kind
- - the DatabaseKind enum value (ex STAGING or JOB)usedBy
- - string name of what is using the portpublic java.lang.String getPortInUseBy(DatabaseKind kind)+
DataHub
getPortInUseBy
in interface DataHub
kind
- - the DatabaseKind enum value (ex STAGING or JOB)public boolean isServerVersionOk()+
DataHub
isServerVersionOk
in interface DataHub
public void setServerVersionOk(boolean serverVersionOk)+
DataHub
setServerVersionOk
in interface DataHub
serverVersionOk
- - true if it compatible or false if it is notpublic java.lang.String getServerVersion()+
DataHub
getServerVersion
in interface DataHub
public void setServerVersion(java.lang.String serverVersion)+
DataHub
setServerVersion
in interface DataHub
serverVersion
- - server version as a string, eg: "9.03-1"public boolean upgradeHub() + throws CantUpgradeException+
DataHub
upgradeHub
in interface DataHub
CantUpgradeException
- - exception thrown when an upgrade can't happenpublic boolean upgradeHub(java.util.List<java.lang.String> updatedFlows) + throws CantUpgradeException+
DataHub
upgradeHub
in interface DataHub
CantUpgradeException
- - should the hub fail to upgrade for incompatibility reasonsConstructor and Description | +
---|
DebuggingImpl(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+disable()
+Disables debugging
+ |
+
void |
+enable()
+Enables debugging
+ |
+
boolean |
+isEnabled()
+Determines if the hub has debugging enabled or not
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public DebuggingImpl(com.marklogic.client.DatabaseClient client)+
public class EntityManagerImpl +extends com.marklogic.client.ext.helper.LoggingObject +implements EntityManager+
logger
Constructor and Description | +
---|
EntityManagerImpl(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
java.util.HashMap<java.lang.Enum,java.lang.Boolean> |
+deployQueryOptions()
+Deploys the query option
+ |
+
boolean |
+saveDbIndexes()
+Updates the indexes for the entity on the filesystem
+ |
+
boolean |
+saveQueryOptions()
+Updates the query options to the file system
+ |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public EntityManagerImpl(HubConfig hubConfig)+
public boolean saveQueryOptions()+
EntityManager
saveQueryOptions
in interface EntityManager
public java.util.HashMap<java.lang.Enum,java.lang.Boolean> deployQueryOptions()+
EntityManager
deployQueryOptions
in interface EntityManager
public boolean saveDbIndexes()+
EntityManager
saveDbIndexes
in interface EntityManager
public class FlowManagerImpl +extends com.marklogic.client.extensions.ResourceManager +implements FlowManager+
Constructor and Description | +
---|
FlowManagerImpl(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName)
+Retrieves a named flow from a given entity
+ |
+
Flow |
+getFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType)
+Retrieves a named flow from a given entity
+ |
+
Flow |
+getFlowFromProperties(java.nio.file.Path propertiesFile)
+Obtains a flow from a property file
+ |
+
java.util.List<Flow> |
+getFlows(java.lang.String entityName)
+Retrieves a list of flows installed on the MarkLogic server
+ |
+
java.util.List<java.lang.String> |
+getLegacyFlows()
+Updates the indexes in the database based on the project
+ |
+
java.util.List<Flow> |
+getLocalFlows()
+retrieves a list of all the flows on the local files systems
+ |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName)
+retrieves a list of all the flows on the local files systems
+ |
+
java.util.List<Flow> |
+getLocalFlowsForEntity(java.lang.String entityName,
+ FlowType flowType)
+retrieves a list of all the flows on the local files systems
+ |
+
FlowRunner |
+newFlowRunner()
+Creates and returns a new FlowRunner object using the FlowManager's hubconfig
+ |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion)
+Sets the version that the legacy flow is to be updated from
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create, flowFromXml
public FlowManagerImpl(HubConfig hubConfig)+
public java.util.List<Flow> getLocalFlows()+
FlowManager
getLocalFlows
in interface FlowManager
public java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName)+
FlowManager
getLocalFlowsForEntity
in interface FlowManager
entityName
- - string name of the entity for the flowpublic java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName, + FlowType flowType)+
FlowManager
getLocalFlowsForEntity
in interface FlowManager
entityName
- - string name of the entity for the flowflowType
- - the FlowType enum, eg: ingest or harmonizepublic Flow getFlowFromProperties(java.nio.file.Path propertiesFile)+
FlowManager
getFlowFromProperties
in interface FlowManager
propertiesFile
- - the Path to the property filepublic java.util.List<Flow> getFlows(java.lang.String entityName)+
FlowManager
getFlows
in interface FlowManager
entityName
- - the entity from which to fetch the flowspublic Flow getFlow(java.lang.String entityName, + java.lang.String flowName)+
FlowManager
getFlow
in interface FlowManager
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getpublic Flow getFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
FlowManager
getFlow
in interface FlowManager
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getflowType
- - the type of flow (ingest/harmonize)public java.util.List<java.lang.String> getLegacyFlows()+
FlowManager
getLegacyFlows
in interface FlowManager
public java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion)+
FlowManager
updateLegacyFlows
in interface FlowManager
fromVersion
- - string representation of DHF versionpublic FlowRunner newFlowRunner()+
FlowManager
newFlowRunner
in interface FlowManager
public class HubConfigBuilderImpl +extends java.lang.Object +implements HubConfigBuilder+
+ HubConfig hubConfig = HubConfigBuilder.newHubConfigBuilder("/path/to/your/project")
+ .withPropertiesFromEnvironment("local")
+ .build();
+
Constructor and Description | +
---|
HubConfigBuilderImpl(java.lang.String projectDir) |
+
Modifier and Type | +Method and Description | +
---|---|
HubConfig |
+build()
+Builds the
+HubConfig instance |
+
HubConfigBuilder |
+withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)
+Sets the
+AdminConfig for the HubConfig |
+
HubConfigBuilder |
+withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)
+Sets the
+AdminManager for the HubConfig |
+
HubConfigBuilder |
+withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)
+Sets the
+AppConfig for the HubConfig |
+
HubConfigBuilder |
+withManageClient(com.marklogic.mgmt.ManageClient manageClient)
+Sets the
+ManageClient for the HubConfig |
+
HubConfigBuilder |
+withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)
+Sets the
+ManageConfig for the HubConfig |
+
HubConfigBuilder |
+withProperties(java.util.Properties properties)
+Tells the builder to use the given properties.
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment()
+Tells the builder to load properties from the gradle files in the project dir
+ |
+
HubConfigBuilder |
+withPropertiesFromEnvironment(java.lang.String environment)
+Tells the builder to load properties from the gradle files in the project dir
+ but to look for an environment properties file with overrides
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
newHubConfigBuilder
public HubConfigBuilderImpl(java.lang.String projectDir)+
public HubConfigBuilder withPropertiesFromEnvironment()+
HubConfigBuilder
withPropertiesFromEnvironment
in interface HubConfigBuilder
HubConfigBuilder
instancepublic HubConfigBuilder withPropertiesFromEnvironment(java.lang.String environment)+
HubConfigBuilder
withPropertiesFromEnvironment
in interface HubConfigBuilder
environment
- - the name of the environment to use (local,dev,qa,prod,...)HubConfigBuilder
instancepublic HubConfigBuilder withProperties(java.util.Properties properties)+
HubConfigBuilder
withProperties
in interface HubConfigBuilder
properties
- - A Properties
object with properties setHubConfigBuilder
instancepublic HubConfigBuilder withAppConfig(com.marklogic.appdeployer.AppConfig appConfig)+
HubConfigBuilder
AppConfig
for the HubConfig
withAppConfig
in interface HubConfigBuilder
appConfig
- - an AppConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
HubConfigBuilder
AdminConfig
for the HubConfig
withAdminConfig
in interface HubConfigBuilder
adminConfig
- - an AdminConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
HubConfigBuilder
AdminManager
for the HubConfig
withAdminManager
in interface HubConfigBuilder
adminManager
- - an AdminManager
objectHubConfigBuilder
instancepublic HubConfigBuilder withManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
HubConfigBuilder
ManageConfig
for the HubConfig
withManageConfig
in interface HubConfigBuilder
manageConfig
- - a ManageConfig
objectHubConfigBuilder
instancepublic HubConfigBuilder withManageClient(com.marklogic.mgmt.ManageClient manageClient)+
HubConfigBuilder
ManageClient
for the HubConfig
withManageClient
in interface HubConfigBuilder
manageClient
- - a ManageClient
HubConfigBuilder
instancepublic HubConfig build()+
HubConfigBuilder
HubConfig
instancebuild
in interface HubConfigBuilder
HubConfig
Modifier and Type | +Field and Description | +
---|---|
protected java.lang.String |
+customForestPath |
+
protected java.lang.String |
+finalAuthMethod |
+
protected java.lang.String |
+finalDbName |
+
protected java.lang.Integer |
+finalForestsPerHost |
+
protected java.lang.String |
+finalHttpName |
+
protected java.lang.Integer |
+finalPort |
+
protected java.lang.String |
+jobAuthMethod |
+
protected java.lang.String |
+jobDbName |
+
protected java.lang.Integer |
+jobForestsPerHost |
+
protected java.lang.String |
+jobHttpName |
+
protected java.lang.Integer |
+jobPort |
+
protected java.lang.String |
+modulePermissions |
+
protected java.lang.String |
+modulesDbName |
+
protected java.lang.Integer |
+modulesForestsPerHost |
+
protected java.lang.String |
+schemasDbName |
+
protected java.lang.Integer |
+schemasForestsPerHost |
+
protected java.lang.String |
+stagingAuthMethod |
+
protected java.lang.String |
+stagingDbName |
+
protected java.lang.Integer |
+stagingForestsPerHost |
+
protected java.lang.String |
+stagingHttpName |
+
protected java.lang.Integer |
+stagingPort |
+
protected java.lang.String |
+traceAuthMethod |
+
protected java.lang.String |
+traceDbName |
+
protected java.lang.Integer |
+traceForestsPerHost |
+
protected java.lang.String |
+traceHttpName |
+
protected java.lang.Integer |
+tracePort |
+
protected java.lang.String |
+triggersDbName |
+
protected java.lang.Integer |
+triggersForestsPerHost |
+
DEFAULT_AUTH_METHOD, DEFAULT_CUSTOM_FOREST_PATH, DEFAULT_FINAL_NAME, DEFAULT_FINAL_PORT, DEFAULT_FORESTS_PER_HOST, DEFAULT_JOB_NAME, DEFAULT_JOB_PORT, DEFAULT_MODULES_DB_NAME, DEFAULT_ROLE_NAME, DEFAULT_SCHEMAS_DB_NAME, DEFAULT_SCHEME, DEFAULT_STAGING_NAME, DEFAULT_STAGING_PORT, DEFAULT_TRACE_NAME, DEFAULT_TRACE_PORT, DEFAULT_TRIGGERS_DB_NAME, DEFAULT_USER_NAME, ENTITY_CONFIG_DIR, FINAL_ENTITY_QUERY_OPTIONS_FILE, HUB_CONFIG_DIR, HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES, STAGING_ENTITY_QUERY_OPTIONS_FILE, USER_CONFIG_DIR, USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES, USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES
Constructor and Description | +
---|
HubConfigImpl() |
+
HubConfigImpl(java.lang.String projectDir) |
+
Modifier and Type | +Method and Description | +
---|---|
com.marklogic.mgmt.admin.AdminConfig |
+getAdminConfig() |
+
com.marklogic.mgmt.admin.AdminManager |
+getAdminManager() |
+
com.marklogic.appdeployer.AppConfig |
+getAppConfig()
+Returns the current appconfig object attached to the HubConfig
+ |
+
java.lang.String |
+getAuthMethod(DatabaseKind kind)
+Returns the AuthMethod object for the DatabaseKind in the hub config
+ |
+
java.lang.String |
+getCertFile(DatabaseKind kind)
+Returns the SSL Cert file as a string for the DatabaseKind in the hub config
+ |
+
java.lang.String |
+getCertPassword(DatabaseKind kind)
+Returns the SSL Cert Password as a string for the DatabaseKind in the hub config
+ |
+
java.lang.String |
+getCustomForestPath()
+Returns the path for the custom forests definition
+ |
+
java.lang.String |
+getDbName(DatabaseKind kind)
+Returns the database name for the DatabaseKind set in the config
+ |
+
java.nio.file.Path |
+getEntityDatabaseDir()
+Gets the path for the entity database directory
+ |
+
java.lang.String |
+getExternalName(DatabaseKind kind)
+Returns the external name for the host for the DatabaseKind in the hub config
+ |
+
java.lang.Integer |
+getForestsPerHost(DatabaseKind kind)
+Returns the number of forests per host for the DatabaseKind set in the config
+ |
+
java.lang.String |
+getHost()
+Gets the hostname of the AppConfig
+ |
+
java.lang.String |
+getHttpName(DatabaseKind kind)
+Returns the appserver name for the DatabaseKind set in the config
+ |
+
java.nio.file.Path |
+getHubConfigDir()
+Gets the path for the hub's entities directory
+ |
+
java.nio.file.Path |
+getHubDatabaseDir()
+Gets the path for the hub's config directory
+ |
+
java.nio.file.Path |
+getHubEntitiesDir()
+Gets the path for the hub plugins directory
+ |
+
java.lang.String |
+getHubModulesDeployTimestampFile()
+Returns the last deployed timestamp file for the hub config and modules
+ |
+
java.nio.file.Path |
+getHubPluginsDir()
+Gets the path for the entity database directory
+ |
+
HubProject |
+getHubProject()
+Returns the HubProject associated with the HubConfig
+ |
+
java.lang.String |
+getHubRoleName()
+Get the roleName the hub uses
+ |
+
java.nio.file.Path |
+getHubSecurityDir()
+Gets the path for the hub servers directory
+ |
+
java.nio.file.Path |
+getHubServersDir()
+Gets the path for the hub's database directory
+ |
+
java.lang.String |
+getHubUserName()
+Get the current marklogic user name the hub uses
+ |
+
java.lang.String |
+getJarVersion()
+Gets the current version of the DHF Jar
+ |
+
java.lang.String[] |
+getLoadBalancerHosts()
+Gets a string array of hosts
+ |
+
com.marklogic.mgmt.ManageClient |
+getManageClient() |
+
com.marklogic.mgmt.ManageConfig |
+getManageConfig() |
+
java.lang.String |
+getModulePermissions()
+Gets the permissions used to execute a module in string form
+ |
+
java.lang.Integer |
+getPort(DatabaseKind kind)
+Returns the port number for the DatabaseKind set in the config
+ |
+
java.lang.String |
+getProjectDir()
+Obtains the project directory as a string
+ |
+
java.lang.String |
+getScheme(DatabaseKind kind)
+Returns the SSL Scheme as string for the DatabaseKind in the hub config
+ |
+
boolean |
+getSimpleSsl(DatabaseKind kind)
+Returns if Simple SSL is set for the DatabaseKind in the hub config
+ |
+
javax.net.ssl.SSLContext |
+getSslContext(DatabaseKind kind)
+Returns the SSL Context for the DatabaseKind set in the config
+ |
+
com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier |
+getSslHostnameVerifier(DatabaseKind kind)
+Returns the SSL hostname verifier object for the DatabaseKind in the hub config
+ |
+
java.nio.file.Path |
+getUserConfigDir()
+Gets the path for the entity database directory
+ |
+
java.io.File |
+getUserContentDeployTimestampFile() |
+
java.nio.file.Path |
+getUserDatabaseDir()
+Gets the path for the user security directory
+ |
+
java.lang.String |
+getUserModulesDeployTimestampFile()
+Returns the last deployed timestamp file for the user modules
+ |
+
java.nio.file.Path |
+getUserSecurityDir()
+Gets the path for the user config directory
+ |
+
java.nio.file.Path |
+getUserServersDir()
+Gets the path for the entity database directory
+ |
+
void |
+initHubProject()
+Initializes the hub project on disk
+ |
+
void |
+loadConfigurationFromProperties(java.util.Properties environmentProperties) |
+
com.marklogic.client.DatabaseClient |
+newAppServicesClient()
+Creates a new DatabaseClient for accessing the AppServices app
+ |
+
com.marklogic.client.DatabaseClient |
+newFinalClient()
+Creates a new DatabaseClient for accessing the Final database
+ |
+
com.marklogic.client.DatabaseClient |
+newJobDbClient()
+Creates a new DatabaseClient for accessing the Job database
+ |
+
com.marklogic.client.DatabaseClient |
+newModulesDbClient()
+Creates a new DatabaseClient for accessing the Hub Modules database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient()
+Creates a new DatabaseClient for accessing the Staging database
+ |
+
com.marklogic.client.DatabaseClient |
+newStagingClient(java.lang.String databaseName)
+Creates a new DatabaseClient for accessing the Staging database
+ |
+
com.marklogic.client.DatabaseClient |
+newTraceDbClient()
+Creates a new DatabaseClient for accessing the Trace database
+ |
+
void |
+setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig) |
+
void |
+setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager) |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config)
+Sets the App Config for the current HubConfig
+ |
+
void |
+setAppConfig(com.marklogic.appdeployer.AppConfig config,
+ boolean skipUpdate)
+Sets the App Config for the current HubConfig, with skipUpdate option
+ |
+
void |
+setAuthMethod(DatabaseKind kind,
+ java.lang.String authMethod)
+Sets the SSL Auth Method for the DatabaseKind in the config
+ |
+
void |
+setCertFile(DatabaseKind kind,
+ java.lang.String certFile)
+Sets the SSL Certfile to use for the DatabaseKind in the config
+ |
+
void |
+setCertPass(DatabaseKind kind,
+ java.lang.String certPassword)
+Sets the SSL Cert password for the DatabaseKind in the config
+ |
+
void |
+setCustomForestPath(java.lang.String customForestPath) |
+
void |
+setDbName(DatabaseKind kind,
+ java.lang.String dbName)
+Sets the database name for the databaseKind on the hubconfig
+ |
+
void |
+setExternalName(DatabaseKind kind,
+ java.lang.String externalName)
+Sets the external hostname for the DatabaseKind in the config
+ |
+
void |
+setForestsPerHost(DatabaseKind kind,
+ java.lang.Integer forestsPerHost)
+Sets the number of forests per host for the databaseKind on the hubconfig
+ |
+
void |
+setHttpName(DatabaseKind kind,
+ java.lang.String httpName)
+Sets the appserver name for the databaseKind on the hubconfig
+ |
+
void |
+setHubRoleName(java.lang.String hubRoleName)
+Set the role name that the hub uses
+ |
+
void |
+setHubUserName(java.lang.String hubUserName)
+Sets the username for the hub to use in MarkLogic
+ |
+
void |
+setLoadBalancerHosts(java.lang.String[] loadBalancerHosts) |
+
void |
+setManageClient(com.marklogic.mgmt.ManageClient manageClient) |
+
void |
+setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig) |
+
void |
+setModulePermissions(java.lang.String modulePermissions) |
+
void |
+setPort(DatabaseKind kind,
+ java.lang.Integer port)
+Sets the port number for the databaseKind on the hubconfig
+ |
+
void |
+setProjectDir(java.lang.String projectDir) |
+
void |
+setScheme(DatabaseKind kind,
+ java.lang.String scheme)
+Sets the SSL Scheme for the DatabaseKind in the config
+ |
+
void |
+setSimpleSsl(DatabaseKind kind,
+ java.lang.Boolean simpleSsl)
+Sets if Simple SSL is to be used for the DatabaseKind in the config
+ |
+
void |
+setSslContext(DatabaseKind kind,
+ javax.net.ssl.SSLContext sslContext)
+Sets the SSL Context for the DatabaseKind in the config
+ |
+
void |
+setSslHostnameVerifier(DatabaseKind kind,
+ com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier sslHostnameVerifier)
+Sets the SSL Hostname Verifier object for the DatabaseKind in the config
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
protected java.lang.String stagingDbName+
protected java.lang.String stagingHttpName+
protected java.lang.Integer stagingForestsPerHost+
protected java.lang.Integer stagingPort+
protected java.lang.String stagingAuthMethod+
protected java.lang.String finalDbName+
protected java.lang.String finalHttpName+
protected java.lang.Integer finalForestsPerHost+
protected java.lang.Integer finalPort+
protected java.lang.String finalAuthMethod+
protected java.lang.String traceDbName+
protected java.lang.String traceHttpName+
protected java.lang.Integer traceForestsPerHost+
protected java.lang.Integer tracePort+
protected java.lang.String traceAuthMethod+
protected java.lang.String jobDbName+
protected java.lang.String jobHttpName+
protected java.lang.Integer jobForestsPerHost+
protected java.lang.Integer jobPort+
protected java.lang.String jobAuthMethod+
protected java.lang.String modulesDbName+
protected java.lang.Integer modulesForestsPerHost+
protected java.lang.String triggersDbName+
protected java.lang.Integer triggersForestsPerHost+
protected java.lang.String schemasDbName+
protected java.lang.Integer schemasForestsPerHost+
protected java.lang.String customForestPath+
protected java.lang.String modulePermissions+
public HubConfigImpl()+
public HubConfigImpl(java.lang.String projectDir)+
public java.lang.String getHost()+
HubConfig
public java.lang.String getDbName(DatabaseKind kind)+
HubConfig
public void setDbName(DatabaseKind kind, + java.lang.String dbName)+
HubConfig
public java.lang.String getHttpName(DatabaseKind kind)+
HubConfig
getHttpName
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setHttpName(DatabaseKind kind, + java.lang.String httpName)+
HubConfig
setHttpName
in interface HubConfig
httpName
- The name to set for the appserverpublic java.lang.Integer getForestsPerHost(DatabaseKind kind)+
HubConfig
getForestsPerHost
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setForestsPerHost(DatabaseKind kind, + java.lang.Integer forestsPerHost)+
HubConfig
setForestsPerHost
in interface HubConfig
forestsPerHost
- The number of forests per hostpublic java.lang.Integer getPort(DatabaseKind kind)+
HubConfig
public void setPort(DatabaseKind kind, + java.lang.Integer port)+
HubConfig
public javax.net.ssl.SSLContext getSslContext(DatabaseKind kind)+
HubConfig
getSslContext
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setSslContext(DatabaseKind kind, + javax.net.ssl.SSLContext sslContext)+
HubConfig
setSslContext
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBsslContext
- - The SSLContext set for the database connectionpublic com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier getSslHostnameVerifier(DatabaseKind kind)+
HubConfig
getSslHostnameVerifier
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setSslHostnameVerifier(DatabaseKind kind, + com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier sslHostnameVerifier)+
HubConfig
setSslHostnameVerifier
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBsslHostnameVerifier
- - The SSL Hostname Verifier object for the database connectionpublic java.lang.String getAuthMethod(DatabaseKind kind)+
HubConfig
getAuthMethod
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setAuthMethod(DatabaseKind kind, + java.lang.String authMethod)+
HubConfig
setAuthMethod
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBauthMethod
- - The SSL Auth Method for the database connectionpublic java.lang.String getScheme(DatabaseKind kind)+
HubConfig
public void setScheme(DatabaseKind kind, + java.lang.String scheme)+
HubConfig
public boolean getSimpleSsl(DatabaseKind kind)+
HubConfig
getSimpleSsl
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setSimpleSsl(DatabaseKind kind, + java.lang.Boolean simpleSsl)+
HubConfig
setSimpleSsl
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic java.lang.String getCertFile(DatabaseKind kind)+
HubConfig
getCertFile
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setCertFile(DatabaseKind kind, + java.lang.String certFile)+
HubConfig
setCertFile
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBcertFile
- - The SSL Cert File as a string to be used for the database connectionpublic java.lang.String getCertPassword(DatabaseKind kind)+
HubConfig
getCertPassword
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setCertPass(DatabaseKind kind, + java.lang.String certPassword)+
HubConfig
setCertPass
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBcertPassword
- - The SSL certificate password for the database connectionpublic java.lang.String getExternalName(DatabaseKind kind)+
HubConfig
getExternalName
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setExternalName(DatabaseKind kind, + java.lang.String externalName)+
HubConfig
setExternalName
in interface HubConfig
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic java.lang.String getHubRoleName()+
HubConfig
getHubRoleName
in interface HubConfig
public void setHubRoleName(java.lang.String hubRoleName)+
HubConfig
setHubRoleName
in interface HubConfig
hubRoleName
- the name to usepublic java.lang.String getHubUserName()+
HubConfig
getHubUserName
in interface HubConfig
public void setHubUserName(java.lang.String hubUserName)+
HubConfig
setHubUserName
in interface HubConfig
hubUserName
- - username to usepublic java.lang.String[] getLoadBalancerHosts()+
HubConfig
getLoadBalancerHosts
in interface HubConfig
public void setLoadBalancerHosts(java.lang.String[] loadBalancerHosts)+
public java.lang.String getCustomForestPath()+
HubConfig
getCustomForestPath
in interface HubConfig
public void setCustomForestPath(java.lang.String customForestPath)+
public java.lang.String getModulePermissions()+
HubConfig
getModulePermissions
in interface HubConfig
public void setModulePermissions(java.lang.String modulePermissions)+
public java.lang.String getProjectDir()+
HubConfig
getProjectDir
in interface HubConfig
public void setProjectDir(java.lang.String projectDir)+
setProjectDir
in interface HubConfig
public HubProject getHubProject()+
HubConfig
getHubProject
in interface HubConfig
public void initHubProject()+
HubConfig
initHubProject
in interface HubConfig
public java.lang.String getHubModulesDeployTimestampFile()+
HubConfig
getHubModulesDeployTimestampFile
in interface HubConfig
public java.lang.String getUserModulesDeployTimestampFile()+
HubConfig
getUserModulesDeployTimestampFile
in interface HubConfig
public java.io.File getUserContentDeployTimestampFile()+
public void loadConfigurationFromProperties(java.util.Properties environmentProperties)+
public com.marklogic.mgmt.ManageConfig getManageConfig()+
public void setManageConfig(com.marklogic.mgmt.ManageConfig manageConfig)+
public com.marklogic.mgmt.ManageClient getManageClient()+
public void setManageClient(com.marklogic.mgmt.ManageClient manageClient)+
public com.marklogic.mgmt.admin.AdminConfig getAdminConfig()+
public void setAdminConfig(com.marklogic.mgmt.admin.AdminConfig adminConfig)+
public com.marklogic.mgmt.admin.AdminManager getAdminManager()+
public void setAdminManager(com.marklogic.mgmt.admin.AdminManager adminManager)+
public com.marklogic.client.DatabaseClient newAppServicesClient()+
HubConfig
newAppServicesClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newStagingClient()+
HubConfig
newStagingClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newStagingClient(java.lang.String databaseName)+
HubConfig
newStagingClient
in interface HubConfig
databaseName
- - the name of the database for the staging Client to usepublic com.marklogic.client.DatabaseClient newFinalClient()+
HubConfig
newFinalClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newJobDbClient()+
HubConfig
newJobDbClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newTraceDbClient()+
HubConfig
newTraceDbClient
in interface HubConfig
public com.marklogic.client.DatabaseClient newModulesDbClient()+
HubConfig
newModulesDbClient
in interface HubConfig
public java.nio.file.Path getHubPluginsDir()+
HubConfig
getHubPluginsDir
in interface HubConfig
public java.nio.file.Path getHubEntitiesDir()+
HubConfig
getHubEntitiesDir
in interface HubConfig
public java.nio.file.Path getHubConfigDir()+
HubConfig
getHubConfigDir
in interface HubConfig
public java.nio.file.Path getHubDatabaseDir()+
HubConfig
getHubDatabaseDir
in interface HubConfig
public java.nio.file.Path getHubServersDir()+
HubConfig
getHubServersDir
in interface HubConfig
public java.nio.file.Path getHubSecurityDir()+
HubConfig
getHubSecurityDir
in interface HubConfig
public java.nio.file.Path getUserSecurityDir()+
HubConfig
getUserSecurityDir
in interface HubConfig
public java.nio.file.Path getUserConfigDir()+
HubConfig
getUserConfigDir
in interface HubConfig
public java.nio.file.Path getUserDatabaseDir()+
HubConfig
getUserDatabaseDir
in interface HubConfig
public java.nio.file.Path getEntityDatabaseDir()+
HubConfig
getEntityDatabaseDir
in interface HubConfig
public java.nio.file.Path getUserServersDir()+
HubConfig
getUserServersDir
in interface HubConfig
public com.marklogic.appdeployer.AppConfig getAppConfig()+
HubConfig
getAppConfig
in interface HubConfig
public void setAppConfig(com.marklogic.appdeployer.AppConfig config)+
HubConfig
setAppConfig
in interface HubConfig
config
- AppConfig to associate with the HubConfigpublic void setAppConfig(com.marklogic.appdeployer.AppConfig config, + boolean skipUpdate)+
HubConfig
setAppConfig
in interface HubConfig
config
- - AppConfig to associate with the HubConfigskipUpdate
- false to force update of AppConfig, true to skip itpublic java.lang.String getJarVersion()+
HubConfig
getJarVersion
in interface HubConfig
public class HubProjectImpl +extends java.lang.Object +implements HubProject+
Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+ENTITY_CONFIG_DIR |
+
protected org.slf4j.Logger |
+logger |
+
HUB_CONFIG_DIR, USER_CONFIG_DIR
Constructor and Description | +
---|
HubProjectImpl(java.lang.String projectDirStr) |
+
Modifier and Type | +Method and Description | +
---|---|
java.nio.file.Path |
+getEntityConfigDir()
+Gets the path for the user server's directory
+ |
+
java.nio.file.Path |
+getEntityDatabaseDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getHubConfigDir()
+Gets the path for the hub's entities directory
+ |
+
java.nio.file.Path |
+getHubDatabaseDir()
+Gets the path for the hub's config directory
+ |
+
java.nio.file.Path |
+getHubEntitiesDir()
+Gets the path for the hub plugins directory
+ |
+
java.nio.file.Path |
+getHubPluginsDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getHubSecurityDir()
+Gets the path for the hub servers directory
+ |
+
java.nio.file.Path |
+getHubServersDir()
+Gets the path for the hub's database directory
+ |
+
java.nio.file.Path |
+getUserConfigDir()
+Gets the path for the entity database directory
+ |
+
java.nio.file.Path |
+getUserDatabaseDir()
+Gets the path for the user security directory
+ |
+
java.nio.file.Path |
+getUserSchemasDir()
+Gets the path for the user schemas directory
+ |
+
java.nio.file.Path |
+getUserSecurityDir()
+Gets the path for the user config directory
+ |
+
java.nio.file.Path |
+getUserServersDir()
+Gets the path for the entity database directory
+ |
+
void |
+init(java.util.Map<java.lang.String,java.lang.String> customTokens)
+Initializes a directory as a hub project directory.
+ |
+
boolean |
+isInitialized()
+Checks if the project has been initialized or not
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public static final java.lang.String ENTITY_CONFIG_DIR+
protected final org.slf4j.Logger logger+
public HubProjectImpl(java.lang.String projectDirStr)+
public java.nio.file.Path getHubPluginsDir()+
HubProject
getHubPluginsDir
in interface HubProject
public java.nio.file.Path getHubEntitiesDir()+
HubProject
getHubEntitiesDir
in interface HubProject
public java.nio.file.Path getHubConfigDir()+
HubProject
getHubConfigDir
in interface HubProject
public java.nio.file.Path getHubDatabaseDir()+
HubProject
getHubDatabaseDir
in interface HubProject
public java.nio.file.Path getHubServersDir()+
HubProject
getHubServersDir
in interface HubProject
public java.nio.file.Path getHubSecurityDir()+
HubProject
getHubSecurityDir
in interface HubProject
public java.nio.file.Path getUserConfigDir()+
HubProject
getUserConfigDir
in interface HubProject
public java.nio.file.Path getUserSecurityDir()+
HubProject
getUserSecurityDir
in interface HubProject
public java.nio.file.Path getUserDatabaseDir()+
HubProject
getUserDatabaseDir
in interface HubProject
public java.nio.file.Path getUserSchemasDir()+
HubProject
getUserSchemasDir
in interface HubProject
public java.nio.file.Path getUserServersDir()+
HubProject
getUserServersDir
in interface HubProject
public java.nio.file.Path getEntityConfigDir()+
HubProject
getEntityConfigDir
in interface HubProject
public java.nio.file.Path getEntityDatabaseDir()+
HubProject
getEntityDatabaseDir
in interface HubProject
public boolean isInitialized()+
HubProject
isInitialized
in interface HubProject
public void init(java.util.Map<java.lang.String,java.lang.String> customTokens)+
HubProject
init
in interface HubProject
customTokens
- - some custom tokens to start withpublic class InstallInfoImpl +extends java.lang.Object +implements InstallInfo+
Constructor and Description | +
---|
InstallInfoImpl() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+areForestsExistent(DatabaseKind kind)
+Checks to see if the forests are present and accessible
+ |
+
boolean |
+isAppServerExistent(DatabaseKind kind)
+Checks to see if the App Server is present and accessible
+ |
+
boolean |
+isCollectionLexiconOn(DatabaseKind kind)
+Checks to see if the lexicon collection is set and on
+ |
+
boolean |
+isDbExistent(DatabaseKind kind)
+Checks to see if the Database is present and accessible
+ |
+
boolean |
+isInstalled()
+Checks if DHF has been installed
+ |
+
boolean |
+isPartiallyInstalled()
+Returns if an install has been performed, but not complete
+ |
+
boolean |
+isTripleIndexOn(DatabaseKind kind)
+Checks to see if the triple index is set and on
+ |
+
void |
+setAppServerExistent(DatabaseKind kind,
+ boolean exists)
+Sets the boolean property if the app server exists for the databasekind
+ |
+
void |
+setCollectionLexiconOn(DatabaseKind kind,
+ boolean collectionLexiconOn)
+Sets if the collection lexicon is on or not
+ |
+
void |
+setDbExistent(DatabaseKind kind,
+ boolean exists)
+Sets the boolean property if the database exists for the databasekind
+ |
+
void |
+setForestsExistent(DatabaseKind kind,
+ boolean forestsExistent)
+Sets the boolean property if the forests exist for the databasekind
+ |
+
void |
+setTripleIndexOn(DatabaseKind kind,
+ boolean tripleIndexOn)
+Sets if the triple index is on or off by boolean
+ |
+
java.lang.String |
+toString()
+Returns the entire object as a string
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
create
public boolean isPartiallyInstalled()+
InstallInfo
isPartiallyInstalled
in interface InstallInfo
public boolean isInstalled()+
InstallInfo
isInstalled
in interface InstallInfo
public java.lang.String toString()+
InstallInfo
toString
in interface InstallInfo
toString
in class java.lang.Object
public boolean isAppServerExistent(DatabaseKind kind)+
InstallInfo
isAppServerExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setAppServerExistent(DatabaseKind kind, + boolean exists)+
InstallInfo
setAppServerExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBexists
- - true if it exists, false if it doesn'tpublic boolean isDbExistent(DatabaseKind kind)+
InstallInfo
isDbExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setDbExistent(DatabaseKind kind, + boolean exists)+
InstallInfo
setDbExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBexists
- - true if it exists, false if it doesn'tpublic boolean isTripleIndexOn(DatabaseKind kind)+
InstallInfo
isTripleIndexOn
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setTripleIndexOn(DatabaseKind kind, + boolean tripleIndexOn)+
InstallInfo
setTripleIndexOn
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBtripleIndexOn
- - true if the triple index is on, false if it is notpublic boolean isCollectionLexiconOn(DatabaseKind kind)+
InstallInfo
isCollectionLexiconOn
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setCollectionLexiconOn(DatabaseKind kind, + boolean collectionLexiconOn)+
InstallInfo
setCollectionLexiconOn
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBcollectionLexiconOn
- - true if it's on, false if it's notpublic boolean areForestsExistent(DatabaseKind kind)+
InstallInfo
areForestsExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBpublic void setForestsExistent(DatabaseKind kind, + boolean forestsExistent)+
InstallInfo
setForestsExistent
in interface InstallInfo
kind
- - DatabaseKind enum, eg: STAGING or JOBforestsExistent
- - true if it exists, false if it doesn'tConstructor and Description | +
---|
TracingImpl(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+disable()
+Disables tracing
+ |
+
void |
+enable()
+Enables tracing
+ |
+
boolean |
+isEnabled()
+Determines if the hub has tracing enabled or not
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public TracingImpl(com.marklogic.client.DatabaseClient client)+
Class | +Description | +
---|---|
DataHubImpl | ++ |
DebuggingImpl | ++ |
EntityManagerImpl | ++ |
FlowManagerImpl | ++ |
HubConfigBuilderImpl | +
+ A class for building a HubConfig class.
+ |
+
HubConfigImpl | ++ |
HubProjectImpl | +
+ Class for creating a hub Project
+ |
+
InstallInfoImpl | ++ |
TracingImpl | ++ |
public class Job
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
java.util.Date |
+getEndTime() |
+
java.lang.String |
+getEntityName() |
+
long |
+getFailedBatches() |
+
long |
+getFailedEvents() |
+
java.lang.String |
+getFlowName() |
+
java.lang.String |
+getFlowType() |
+
java.lang.String |
+getJobId() |
+
java.lang.String |
+getJobName() |
+
java.util.List<java.lang.String> |
+getJobOutput() |
+
java.util.Date |
+getStartTime() |
+
JobStatus |
+getStatus() |
+
long |
+getSuccessfulBatches() |
+
long |
+getSuccessfulEvents() |
+
Job |
+setCounts(long successfulEvents,
+ long failedEvents,
+ long successfulBatches,
+ long failedBatches) |
+
Job |
+withEndTime(java.util.Date endTime) |
+
static Job |
+withFlow(Flow flow) |
+
Job |
+withJobId(java.lang.String jobId) |
+
Job |
+withJobName(java.lang.String jobName) |
+
Job |
+withJobOutput(java.util.List<java.lang.String> jobOutput) |
+
Job |
+withJobOutput(java.lang.String jobOutput) |
+
Job |
+withStartTime(java.util.Date startTime) |
+
Job |
+withStatus(JobStatus status) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public Job withJobId(java.lang.String jobId)+
public Job withJobName(java.lang.String jobName)+
public Job withJobOutput(java.util.List<java.lang.String> jobOutput)+
public Job withJobOutput(java.lang.String jobOutput)+
public Job withStartTime(java.util.Date startTime)+
public Job withEndTime(java.util.Date endTime)+
public Job setCounts(long successfulEvents, + long failedEvents, + long successfulBatches, + long failedBatches)+
public java.lang.String getJobId()+
public java.lang.String getFlowType()+
public java.lang.String getFlowName()+
public java.lang.String getEntityName()+
public java.lang.String getJobName()+
public java.util.Date getStartTime()+
public java.util.Date getEndTime()+
public JobStatus getStatus()+
public java.util.List<java.lang.String> getJobOutput()+
public long getSuccessfulEvents()+
public long getFailedEvents()+
public long getSuccessfulBatches()+
public long getFailedBatches()+
public class JobDeleteResponse
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
java.util.List<java.lang.String> |
+deletedJobs |
+
java.util.List<java.lang.String> |
+deletedTraces |
+
long |
+errorCount |
+
java.util.List<com.fasterxml.jackson.databind.JsonNode> |
+errors |
+
java.util.List<java.lang.String> |
+failedJobs |
+
java.util.List<java.lang.String> |
+failedTraces |
+
long |
+totalCount |
+
Constructor and Description | +
---|
JobDeleteResponse() |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+toString() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public long totalCount+
public long errorCount+
public java.util.List<java.lang.String> deletedJobs+
public java.util.List<java.lang.String> deletedTraces+
public java.util.List<java.lang.String> failedJobs+
public java.util.List<java.lang.String> failedTraces+
public java.util.List<com.fasterxml.jackson.databind.JsonNode> errors+
public class JobExportResponse
+extends java.lang.Object
+Modifier and Type | +Field and Description | +
---|---|
java.lang.String |
+fullPath |
+
long |
+totalJobs |
+
long |
+totalTraces |
+
Constructor and Description | +
---|
JobExportResponse() |
+
public interface JobManager
+Modifier and Type | +Method and Description | +
---|---|
static JobManager |
+create(com.marklogic.client.DatabaseClient jobClient,
+ com.marklogic.client.DatabaseClient traceClient)
+Creates and returns a JobManager object
+ |
+
JobDeleteResponse |
+deleteJobs(java.lang.String jobIds) |
+
JobExportResponse |
+exportJobs(java.nio.file.Path exportFilePath,
+ java.lang.String[] jobIds)
+Export Job documents and their associated Trace documents to a zip file.
+ |
+
void |
+importJobs(java.nio.file.Path importFilePath)
+Import Job documents and their associated Trace documents from a zip file.
+ |
+
void |
+saveJob(Job job)
+Saves the job to the database
+ |
+
void |
+saveJob(Job job,
+ com.marklogic.client.Transaction transaction)
+Saves the job to the database
+ |
+
static JobManager create(com.marklogic.client.DatabaseClient jobClient, + com.marklogic.client.DatabaseClient traceClient)+
jobClient
- the database client that is used to connect to the jobs databasetraceClient
- the database client that is used to connect to the trace databasevoid saveJob(Job job)+
job
- - the job you want to savevoid saveJob(Job job, + com.marklogic.client.Transaction transaction)+
job
- - the job you want to savetransaction
- - the transaction that is to be used to write the jobJobDeleteResponse deleteJobs(java.lang.String jobIds)+
jobIds
- comma-separated list of jobIds to delete.JobExportResponse exportJobs(java.nio.file.Path exportFilePath, + java.lang.String[] jobIds)+
exportFilePath
- specifies where the zip file will be writtenjobIds
- a comma-separated list of jobIds; if null, all will be exportedvoid importJobs(java.nio.file.Path importFilePath) + throws java.io.IOException+
importFilePath
- specifies where the zip file existsjava.io.IOException
- if unable to open or read the target input fileEnum Constant and Description | +
---|
CANCELED |
+
FAILED |
+
FINISHED |
+
FINISHED_WITH_ERRORS |
+
RUNNING_COLLECTOR |
+
RUNNING_HARMONIZE |
+
STARTED |
+
STOP_ON_ERROR |
+
Modifier and Type | +Method and Description | +
---|---|
static JobStatus |
+getJobStatus(java.lang.String status) |
+
java.lang.String |
+toString() |
+
static JobStatus |
+valueOf(java.lang.String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static JobStatus[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final JobStatus STARTED+
public static final JobStatus RUNNING_COLLECTOR+
public static final JobStatus RUNNING_HARMONIZE+
public static final JobStatus FINISHED+
public static final JobStatus FINISHED_WITH_ERRORS+
public static final JobStatus FAILED+
public static final JobStatus STOP_ON_ERROR+
public static final JobStatus CANCELED+
public static JobStatus[] values()+
+for (JobStatus c : JobStatus.values()) + System.out.println(c); +
public static JobStatus valueOf(java.lang.String name)+
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static JobStatus getJobStatus(java.lang.String status)+
public java.lang.String toString()+
toString
in class java.lang.Enum<JobStatus>
public class JobManagerImpl.JobDeleteResource
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
JobDeleteResource(com.marklogic.client.DatabaseClient srcClient) |
+
Modifier and Type | +Method and Description | +
---|---|
JobDeleteResponse |
+deleteJobs(java.lang.String jobIds) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public JobDeleteResource(com.marklogic.client.DatabaseClient srcClient)+
public JobDeleteResponse deleteJobs(java.lang.String jobIds)+
public class JobManagerImpl +extends java.lang.Object +implements JobManager+
Modifier and Type | +Class and Description | +
---|---|
class |
+JobManagerImpl.JobDeleteResource |
+
Constructor and Description | +
---|
JobManagerImpl(com.marklogic.client.DatabaseClient jobClient,
+ com.marklogic.client.DatabaseClient traceClient) |
+
Modifier and Type | +Method and Description | +
---|---|
JobDeleteResponse |
+deleteJobs(java.lang.String jobIds) |
+
JobExportResponse |
+exportJobs(java.nio.file.Path exportFilePath,
+ java.lang.String[] jobIds)
+Export Job documents and their associated Trace documents to a zip file.
+ |
+
void |
+importJobs(java.nio.file.Path importFilePath)
+Import Job documents and their associated Trace documents from a zip file.
+ |
+
void |
+saveJob(Job job)
+Saves the job to the database
+ |
+
void |
+saveJob(Job job,
+ com.marklogic.client.Transaction transaction)
+Saves the job to the database
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public JobManagerImpl(com.marklogic.client.DatabaseClient jobClient, + com.marklogic.client.DatabaseClient traceClient)+
public void saveJob(Job job)+
JobManager
saveJob
in interface JobManager
job
- - the job you want to savepublic void saveJob(Job job, + com.marklogic.client.Transaction transaction)+
JobManager
saveJob
in interface JobManager
job
- - the job you want to savetransaction
- - the transaction that is to be used to write the jobpublic JobDeleteResponse deleteJobs(java.lang.String jobIds)+
deleteJobs
in interface JobManager
jobIds
- comma-separated list of jobIds to delete.public JobExportResponse exportJobs(java.nio.file.Path exportFilePath, + java.lang.String[] jobIds)+
JobManager
exportJobs
in interface JobManager
exportFilePath
- specifies where the zip file will be writtenjobIds
- a comma-separated list of jobIds; if null, all will be exportedpublic void importJobs(java.nio.file.Path importFilePath) + throws java.io.IOException+
JobManager
importJobs
in interface JobManager
importFilePath
- specifies where the zip file existsjava.io.IOException
- if unable to open or read the target input fileClass | +Description | +
---|---|
JobManagerImpl | ++ |
Interface | +Description | +
---|---|
JobManager | +
+ Handles jobs and their creation, status, and deletion.
+ |
+
Class | +Description | +
---|---|
Job | ++ |
JobDeleteResponse | ++ |
JobExportResponse | ++ |
Enum | +Description | +
---|---|
JobStatus | ++ |
public interface MainPlugin
+Modifier and Type | +Method and Description | +
---|---|
CodeFormat |
+getCodeFormat() |
+
java.lang.String |
+getModule() |
+
java.lang.String getModule()+
CodeFormat getCodeFormat()+
public class MainPluginImpl +extends java.lang.Object +implements MainPlugin+
Constructor and Description | +
---|
MainPluginImpl() |
+
MainPluginImpl(java.lang.String module,
+ CodeFormat codeFormat) |
+
Modifier and Type | +Method and Description | +
---|---|
CodeFormat |
+getCodeFormat() |
+
java.lang.String |
+getModule() |
+
void |
+setCodeFormat(CodeFormat codeFormat) |
+
void |
+setModule(java.lang.String module) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public MainPluginImpl()+
public MainPluginImpl(java.lang.String module, + CodeFormat codeFormat)+
public void setModule(java.lang.String module)+
public java.lang.String getModule()+
getModule
in interface MainPlugin
public void setCodeFormat(CodeFormat codeFormat)+
public CodeFormat getCodeFormat()+
getCodeFormat
in interface MainPlugin
Class | +Description | +
---|---|
MainPluginImpl | ++ |
Interface | +Description | +
---|---|
MainPlugin | +
+ Interface to the in-memory representation of the main plugin module (main.sjs or main.xqy)
+ |
+
Interface | +Description | +
---|---|
DataHub | +
+ Handles creation and orchastration of DHF with a MarkLogic server.
+ |
+
Debugging | +
+ Enables or disables debugging in the DHF for the specified database using the supplied client.
+ |
+
EntityManager | +
+ Manages existing entities' MarkLogic Server database index settings and query options.
+ |
+
FlowManager | +
+ Manages existing flows and creates flow runners to execute flows.
+ |
+
HubConfig | +
+ An interface to set, manage and recall the Data Hub's Configuration
+ |
+
HubConfigBuilder | +
+ Helper interface that constructs a HubConfig object from a properties file or pre-existing config.
+ |
+
HubProject | +
+ Creates and gathers information about a hub project.
+ |
+
InstallInfo | +
+ Stores and reports information from MarkLogic server about the installed status of the DHF
+
+ This interface abstracts holding state.
+ |
+
Tracing | +
+ Enables or disables tracing in the DHF for the specified database using the supplied client.
+ |
+
Enum | +Description | +
---|---|
DatabaseKind | +
+ Public enumeration for the types of databases in MarkLogic that the
+ DHF uses.
+ |
+
public interface Scaffolding
+for the initialization of the project itself to disk
Modifier and Type | +Method and Description | +
---|---|
static Scaffolding |
+create(java.lang.String projectDir,
+ com.marklogic.client.DatabaseClient databaseClient)
+Creates and returns a Scaffolding object
+ |
+
void |
+createEntity(java.lang.String entityName)
+Creates an entity given a string name
+ |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat)
+Creates a flow for an entity with Entity Services model as default
+ |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat,
+ boolean useEsModel)
+Creates a flow for an entity with an additional option for using Entity Services
+ |
+
void |
+createRestExtension(java.lang.String entityName,
+ java.lang.String extensionName,
+ FlowType flowType,
+ CodeFormat codeFormat)
+Creates a rest extension on disk to be deployed to server
+ |
+
void |
+createRestTransform(java.lang.String entityName,
+ java.lang.String transformName,
+ FlowType flowType,
+ CodeFormat codeFormat)
+Creates a rest transform on disk to be deployed to server
+ |
+
java.nio.file.Path |
+getFlowDir(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType)
+Returns the directory of the flow
+ |
+
void |
+updateLegacyEntity(java.lang.String entityName)
+Update a specific entity that's legacy
+ |
+
boolean |
+updateLegacyFlow(java.lang.String fromVersion,
+ java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType)
+Update a legacy flow
+ |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion,
+ java.lang.String entityName)
+Updates a legacy flow on disk
+ |
+
static Scaffolding create(java.lang.String projectDir, + com.marklogic.client.DatabaseClient databaseClient)+
projectDir
- - the path to the project as a stringdatabaseClient
- - the database client that will be used to connectjava.nio.file.Path getFlowDir(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
entityName
- - the entity nameflowName
- - the name of the flowflowType
- - FlowType (sjs or xqy)void createEntity(java.lang.String entityName)+
entityName
- - the name of the entity as stringvoid createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat)+
entityName
- - name of the entity to associate the flow withflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumdataFormat
- - the format of the data (json or xml)void createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat, + boolean useEsModel)+
entityName
- - name of the entity to associate the flow withflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumdataFormat
- - the format of the data (json or xml)useEsModel
- - true to use Entity Services, false not tojava.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion, + java.lang.String entityName)+
fromVersion
- - string version number of DHFentityName
- - the entity which the flow is attachedvoid updateLegacyEntity(java.lang.String entityName)+
entityName
- - name of the entityboolean updateLegacyFlow(java.lang.String fromVersion, + java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
fromVersion
- - string version number of DHFentityName
- - the entity which the flow is attachedflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestvoid createRestExtension(java.lang.String entityName, + java.lang.String extensionName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
entityName
- - the entity which the flow is attachedextensionName
- - the name of the extension as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumScaffoldingValidationException
void createRestTransform(java.lang.String entityName, + java.lang.String transformName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
entityName
- - the entity which the flow is attachedtransformName
- - the name of the transform as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumScaffoldingValidationException
public class ScaffoldingValidator
+extends java.nio.file.SimpleFileVisitor<java.nio.file.Path>
+Constructor and Description | +
---|
ScaffoldingValidator(java.lang.String projectDir) |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+isUniqueRestServiceExtension(java.lang.String name) |
+
boolean |
+isUniqueRestTransform(java.lang.String name) |
+
postVisitDirectory, preVisitDirectory, visitFile, visitFileFailed
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class ScaffoldingImpl.ContentPlugin
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
ContentPlugin(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+getContents(java.lang.String entityName,
+ CodeFormat codeFormat,
+ FlowType flowType) |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public ContentPlugin(com.marklogic.client.DatabaseClient client)+
public java.lang.String getContents(java.lang.String entityName, + CodeFormat codeFormat, + FlowType flowType)+
public class ScaffoldingImpl +extends java.lang.Object +implements Scaffolding+
Modifier and Type | +Class and Description | +
---|---|
class |
+ScaffoldingImpl.ContentPlugin |
+
Modifier and Type | +Field and Description | +
---|---|
protected org.slf4j.Logger |
+logger |
+
Constructor and Description | +
---|
ScaffoldingImpl(java.lang.String projectDir,
+ com.marklogic.client.DatabaseClient databaseClient) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+createEntity(java.lang.String entityName)
+Creates an entity given a string name
+ |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat)
+Creates a flow for an entity with Entity Services model as default
+ |
+
void |
+createFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType,
+ CodeFormat codeFormat,
+ DataFormat dataFormat,
+ boolean useEsModel)
+Creates a flow for an entity with an additional option for using Entity Services
+ |
+
void |
+createRestExtension(java.lang.String entityName,
+ java.lang.String extensionName,
+ FlowType flowType,
+ CodeFormat codeFormat)
+Creates a rest extension on disk to be deployed to server
+ |
+
void |
+createRestTransform(java.lang.String entityName,
+ java.lang.String transformName,
+ FlowType flowType,
+ CodeFormat codeFormat)
+Creates a rest transform on disk to be deployed to server
+ |
+
static java.lang.String |
+getAbsolutePath(java.lang.String first,
+ java.lang.String... more) |
+
java.nio.file.Path |
+getEntityDir(java.lang.String entityName) |
+
java.nio.file.Path |
+getFlowDir(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType)
+Returns the directory of the flow
+ |
+
boolean |
+update2xFlow(java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType) |
+
void |
+updateLegacyEntity(java.lang.String entityName)
+Update a specific entity that's legacy
+ |
+
boolean |
+updateLegacyFlow(java.lang.String fromVersion,
+ java.lang.String entityName,
+ java.lang.String flowName,
+ FlowType flowType)
+Update a legacy flow
+ |
+
java.util.List<java.lang.String> |
+updateLegacyFlows(java.lang.String fromVersion,
+ java.lang.String entityName)
+Updates a legacy flow on disk
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public ScaffoldingImpl(java.lang.String projectDir, + com.marklogic.client.DatabaseClient databaseClient)+
public static java.lang.String getAbsolutePath(java.lang.String first, + java.lang.String... more)+
public java.nio.file.Path getFlowDir(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
Scaffolding
getFlowDir
in interface Scaffolding
entityName
- - the entity nameflowName
- - the name of the flowflowType
- - FlowType (sjs or xqy)public void createEntity(java.lang.String entityName)+
Scaffolding
createEntity
in interface Scaffolding
entityName
- - the name of the entity as stringpublic void createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat)+
Scaffolding
createFlow
in interface Scaffolding
entityName
- - name of the entity to associate the flow withflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumdataFormat
- - the format of the data (json or xml)public void createFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType, + CodeFormat codeFormat, + DataFormat dataFormat, + boolean useEsModel)+
Scaffolding
createFlow
in interface Scaffolding
entityName
- - name of the entity to associate the flow withflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumdataFormat
- - the format of the data (json or xml)useEsModel
- - true to use Entity Services, false not topublic java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion, + java.lang.String entityName)+
Scaffolding
updateLegacyFlows
in interface Scaffolding
fromVersion
- - string version number of DHFentityName
- - the entity which the flow is attachedpublic void updateLegacyEntity(java.lang.String entityName)+
Scaffolding
updateLegacyEntity
in interface Scaffolding
entityName
- - name of the entitypublic boolean updateLegacyFlow(java.lang.String fromVersion, + java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
Scaffolding
updateLegacyFlow
in interface Scaffolding
fromVersion
- - string version number of DHFentityName
- - the entity which the flow is attachedflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestpublic boolean update2xFlow(java.lang.String entityName, + java.lang.String flowName, + FlowType flowType)+
public void createRestExtension(java.lang.String entityName, + java.lang.String extensionName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
Scaffolding
createRestExtension
in interface Scaffolding
entityName
- - the entity which the flow is attachedextensionName
- - the name of the extension as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumScaffoldingValidationException
public void createRestTransform(java.lang.String entityName, + java.lang.String transformName, + FlowType flowType, + CodeFormat codeFormat) + throws ScaffoldingValidationException+
Scaffolding
createRestTransform
in interface Scaffolding
entityName
- - the entity which the flow is attachedtransformName
- - the name of the transform as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumScaffoldingValidationException
public java.nio.file.Path getEntityDir(java.lang.String entityName)+
Class | +Description | +
---|---|
ScaffoldingImpl | ++ |
Interface | +Description | +
---|---|
Scaffolding | +
+ Interface that handles the management of DHF projects on disk
+
+ Includes creating entities, flows, rest extensions, and transforms for an already initialized project
+ |
+
Class | +Description | +
---|---|
ScaffoldingValidator | ++ |
public class FileUtil
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
static void |
+copy(java.io.InputStream source,
+ java.io.File destination) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class HubModuleManager
+extends com.marklogic.client.ext.helper.LoggingObject
+implements com.marklogic.client.ext.modulesloader.ModulesManager
+Modifier and Type | +Field and Description | +
---|---|
static java.lang.String |
+DEFAULT_FILE_PATH |
+
logger
Constructor and Description | +
---|
HubModuleManager(java.lang.String propertiesFilePath) |
+
Modifier and Type | +Method and Description | +
---|---|
protected java.lang.String |
+buildKey(java.io.File file)
+Lower-casing avoids some annoying issues on Windows where sometimes you get "C:" at the start, and other times
+ you get "c:".
+ |
+
void |
+deletePropertiesFile() |
+
boolean |
+hasFileBeenModifiedSinceLastLoaded(java.io.File file) |
+
boolean |
+hasKeyBeenModified(java.lang.String key,
+ long lastModified) |
+
void |
+initialize() |
+
void |
+saveLastLoadedTimestamp(java.io.File file,
+ java.util.Date date) |
+
void |
+saveLastLoadedTimestamp(java.lang.String key,
+ java.util.Date date) |
+
void |
+setMinimumFileTimestampToLoad(long minimumFileTimestampToLoad) |
+
format
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final java.lang.String DEFAULT_FILE_PATH+
public HubModuleManager(java.lang.String propertiesFilePath)+
public void initialize()+
initialize
in interface com.marklogic.client.ext.modulesloader.ModulesManager
public void deletePropertiesFile()+
public boolean hasFileBeenModifiedSinceLastLoaded(java.io.File file)+
hasFileBeenModifiedSinceLastLoaded
in interface com.marklogic.client.ext.modulesloader.ModulesManager
public boolean hasKeyBeenModified(java.lang.String key, + long lastModified)+
public void saveLastLoadedTimestamp(java.io.File file, + java.util.Date date)+
saveLastLoadedTimestamp
in interface com.marklogic.client.ext.modulesloader.ModulesManager
public void saveLastLoadedTimestamp(java.lang.String key, + java.util.Date date)+
protected java.lang.String buildKey(java.io.File file)+
file
- - the file to build a key forpublic void setMinimumFileTimestampToLoad(long minimumFileTimestampToLoad)+
public class JsonXor
+extends java.lang.Object
+Modifier and Type | +Method and Description | +
---|---|
static com.fasterxml.jackson.databind.JsonNode |
+xor(java.io.File original,
+ java.io.File changed) |
+
static com.fasterxml.jackson.databind.JsonNode |
+xor(java.io.InputStream original,
+ java.io.InputStream changed) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static com.fasterxml.jackson.databind.JsonNode xor(java.io.File original, + java.io.File changed) + throws java.io.IOException+
java.io.IOException
public static com.fasterxml.jackson.databind.JsonNode xor(java.io.InputStream original, + java.io.InputStream changed) + throws java.io.IOException+
java.io.IOException
public class MlcpConsumer
+extends java.lang.Object
+implements java.util.function.Consumer<java.lang.String>
+Constructor and Description | +
---|
MlcpConsumer(java.util.concurrent.atomic.AtomicLong successfulEvents,
+ java.util.concurrent.atomic.AtomicLong failedEvents,
+ FlowStatusListener statusListener,
+ java.lang.String jobId) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+accept(java.lang.String status) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
andThen
public MlcpConsumer(java.util.concurrent.atomic.AtomicLong successfulEvents, + java.util.concurrent.atomic.AtomicLong failedEvents, + FlowStatusListener statusListener, + java.lang.String jobId)+
public class MlcpRunner +extends ProcessRunner+
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
Constructor and Description | +
---|
MlcpRunner(java.lang.String mlcpPath,
+ java.lang.String mainClass,
+ HubConfig hubConfig,
+ Flow flow,
+ com.marklogic.client.DatabaseClient databaseClient,
+ com.fasterxml.jackson.databind.JsonNode mlcpOptions,
+ FlowStatusListener statusListener) |
+
Modifier and Type | +Method and Description | +
---|---|
java.lang.String |
+getJobId() |
+
void |
+run() |
+
getHubConfig, getProcessOutput, newRunner, withArgs, withHubconfig, withStreamConsumer
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public MlcpRunner(java.lang.String mlcpPath, + java.lang.String mainClass, + HubConfig hubConfig, + Flow flow, + com.marklogic.client.DatabaseClient databaseClient, + com.fasterxml.jackson.databind.JsonNode mlcpOptions, + FlowStatusListener statusListener)+
public java.lang.String getJobId()+
public void run()+
run
in interface java.lang.Runnable
run
in class ProcessRunner
public class PerformanceLogger
+extends java.lang.Object
+Constructor and Description | +
---|
PerformanceLogger() |
+
Modifier and Type | +Method and Description | +
---|---|
static void |
+logTimeInsideMethod(long startTime,
+ java.lang.String location) |
+
static long |
+monitorTimeInsideMethod() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public class ProcessRunner
+extends java.lang.Thread
+java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
Constructor and Description | +
---|
ProcessRunner() |
+
Modifier and Type | +Method and Description | +
---|---|
HubConfig |
+getHubConfig() |
+
java.lang.String |
+getProcessOutput() |
+
static ProcessRunner |
+newRunner() |
+
void |
+run() |
+
ProcessRunner |
+withArgs(java.util.List<java.lang.String> args) |
+
ProcessRunner |
+withHubconfig(HubConfig hubConfig) |
+
ProcessRunner |
+withStreamConsumer(java.util.function.Consumer<java.lang.String> consumer) |
+
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public HubConfig getHubConfig()+
public java.lang.String getProcessOutput()+
public static ProcessRunner newRunner()+
public ProcessRunner withArgs(java.util.List<java.lang.String> args)+
public ProcessRunner withHubconfig(HubConfig hubConfig)+
public ProcessRunner withStreamConsumer(java.util.function.Consumer<java.lang.String> consumer)+
public void run()+
run
in interface java.lang.Runnable
run
in class java.lang.Thread
public class StreamGobbler
+extends java.lang.Thread
+java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
Constructor and Description | +
---|
StreamGobbler(java.io.InputStream inputStream,
+ java.util.function.Consumer<java.lang.String> consumeInputLine) |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+run() |
+
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public class Versions
+extends com.marklogic.client.extensions.ResourceManager
+Constructor and Description | +
---|
Versions(HubConfig hubConfig) |
+
Modifier and Type | +Method and Description | +
---|---|
static int |
+compare(java.lang.String v1,
+ java.lang.String v2) |
+
java.lang.String |
+getHubVersion() |
+
java.lang.String |
+getMarkLogicVersion() |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Class | +Description | +
---|---|
FileUtil | ++ |
HubModuleManager | ++ |
JsonXor | ++ |
MlcpConsumer | ++ |
MlcpRunner | ++ |
PerformanceLogger | ++ |
ProcessRunner | ++ |
StreamGobbler | ++ |
Versions | ++ |
public interface EntitiesValidator
+Modifier and Type | +Method and Description | +
---|---|
static EntitiesValidator |
+create(com.marklogic.client.DatabaseClient client)
+Creates and returns a an EntityValidator object
+ |
+
com.fasterxml.jackson.databind.JsonNode |
+validate(java.lang.String entity,
+ java.lang.String flow,
+ java.lang.String plugin,
+ java.lang.String type,
+ java.lang.String content)
+Creates and returns a an EntityValidator object
+ |
+
com.fasterxml.jackson.databind.JsonNode |
+validateAll()
+Validates all entities
+ |
+
static EntitiesValidator create(com.marklogic.client.DatabaseClient client)+
client
- - DatabaseClient to be used to obtain the informationcom.fasterxml.jackson.databind.JsonNode validateAll()+
com.fasterxml.jackson.databind.JsonNode validate(java.lang.String entity, + java.lang.String flow, + java.lang.String plugin, + java.lang.String type, + java.lang.String content)+
entity
- - name of the entity you are attempting to validateflow
- - name of the flow you want to useplugin
- - which plugin (triples/headers/etc) without extensiontype
- - xquery or javascriptcontent
- - the content to validate againstpublic class EntitiesValidatorImpl +extends com.marklogic.client.extensions.ResourceManager +implements EntitiesValidator+
Constructor and Description | +
---|
EntitiesValidatorImpl(com.marklogic.client.DatabaseClient client) |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.databind.JsonNode |
+validate(java.lang.String entity,
+ java.lang.String flow,
+ java.lang.String plugin,
+ java.lang.String type,
+ java.lang.String content)
+Creates and returns a an EntityValidator object
+ |
+
com.fasterxml.jackson.databind.JsonNode |
+validateAll()
+Validates all entities
+ |
+
getName, startLogging, stopLogging
getServices
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public EntitiesValidatorImpl(com.marklogic.client.DatabaseClient client)+
public com.fasterxml.jackson.databind.JsonNode validateAll()+
EntitiesValidator
validateAll
in interface EntitiesValidator
public com.fasterxml.jackson.databind.JsonNode validate(java.lang.String entity, + java.lang.String flow, + java.lang.String plugin, + java.lang.String type, + java.lang.String content)+
EntitiesValidator
validate
in interface EntitiesValidator
entity
- - name of the entity you are attempting to validateflow
- - name of the flow you want to useplugin
- - which plugin (triples/headers/etc) without extensiontype
- - xquery or javascriptcontent
- - the content to validate againstClass | +Description | +
---|---|
EntitiesValidatorImpl | ++ |
Interface | +Description | +
---|---|
EntitiesValidator | +
+ Uses a supplied DatabaseClient to run an entity validation against all entities defined or
+ against a specific entity/flow/plugins (triples etc) combination
+ |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DEFAULT_AUTH_METHOD |
+"digest" |
+
+
+public static final java.lang.String |
+DEFAULT_CUSTOM_FOREST_PATH |
+"forests" |
+
+
+public static final java.lang.String |
+DEFAULT_FINAL_NAME |
+"data-hub-FINAL" |
+
+
+public static final java.lang.String |
+DEFAULT_JOB_NAME |
+"data-hub-JOBS" |
+
+
+public static final java.lang.String |
+DEFAULT_MODULES_DB_NAME |
+"data-hub-MODULES" |
+
+
+public static final java.lang.String |
+DEFAULT_ROLE_NAME |
+"data-hub-role" |
+
+
+public static final java.lang.String |
+DEFAULT_SCHEMAS_DB_NAME |
+"data-hub-SCHEMAS" |
+
+
+public static final java.lang.String |
+DEFAULT_SCHEME |
+"http" |
+
+
+public static final java.lang.String |
+DEFAULT_STAGING_NAME |
+"data-hub-STAGING" |
+
+
+public static final java.lang.String |
+DEFAULT_TRACE_NAME |
+"data-hub-TRACING" |
+
+
+public static final java.lang.String |
+DEFAULT_TRIGGERS_DB_NAME |
+"data-hub-TRIGGERS" |
+
+
+public static final java.lang.String |
+DEFAULT_USER_NAME |
+"data-hub-user" |
+
+
+public static final java.lang.String |
+ENTITY_CONFIG_DIR |
+"entity-config" |
+
+
+public static final java.lang.String |
+FINAL_ENTITY_QUERY_OPTIONS_FILE |
+"final-entity-options.xml" |
+
+
+public static final java.lang.String |
+HUB_CONFIG_DIR |
+"hub-internal-config" |
+
+
+public static final java.lang.String |
+HUB_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+"hub-modules-deploy-timestamps.properties" |
+
+
+public static final java.lang.String |
+STAGING_ENTITY_QUERY_OPTIONS_FILE |
+"staging-entity-options.xml" |
+
+
+public static final java.lang.String |
+USER_CONFIG_DIR |
+"user-config" |
+
+
+public static final java.lang.String |
+USER_CONTENT_DEPLOY_TIMESTAMPS_PROPERTIES |
+"user-content-deploy-timestamps.properties" |
+
+
+public static final java.lang.String |
+USER_MODULES_DEPLOY_TIMESTAMPS_PROPERTIES |
+"user-modules-deploy-timestamps.properties" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+HUB_CONFIG_DIR |
+"hub-internal-config" |
+
+
+public static final java.lang.String |
+USER_CONFIG_DIR |
+"user-config" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DATABASE_FILENAME |
+"schemas-database.json" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DATABASE_FILENAME |
+"triggers-database.json" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+ENTITY_CONFIG_DIR |
+"entity-config" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final java.lang.String |
+DEFAULT_FILE_PATH |
+"build/ml-javaclient-util/module-timestamps.properties" |
+
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object
. The interfaces do not inherit from java.lang.Object
.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+HubConfig
instancemaxInMemorySize
elements in memory.maxInMemorySize
elements in memory.HubConfigBuilder
instanceAdminConfig
for the HubConfig
AdminManager
for the HubConfig
AppConfig
for the HubConfig
ManageClient
for the HubConfig
ManageConfig
for the HubConfig
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to Non-frame version.
++ + diff --git a/javadocs/3.0.0/overview-summary.html b/javadocs/3.0.0/overview-summary.html new file mode 100644 index 0000000000..f4be08dc57 --- /dev/null +++ b/javadocs/3.0.0/overview-summary.html @@ -0,0 +1,235 @@ + + + + + +
See: Description
+Package | +Description | +
---|---|
com.marklogic.com.marklogic.client.ext.file | ++ |
com.marklogic.com.marklogic.client.ext.modulesloader.impl | ++ |
com.marklogic.hub | ++ |
com.marklogic.hub.collector | ++ |
com.marklogic.hub.collector.impl | ++ |
com.marklogic.hub.deploy | ++ |
com.marklogic.hub.deploy.commands | ++ |
com.marklogic.hub.deploy.util | ++ |
com.marklogic.hub.entity | ++ |
com.marklogic.hub.error | ++ |
com.marklogic.hub.flow | ++ |
com.marklogic.hub.flow.impl | ++ |
com.marklogic.hub.impl | ++ |
com.marklogic.hub.job | ++ |
com.marklogic.hub.job.impl | ++ |
com.marklogic.hub.main | ++ |
com.marklogic.hub.main.impl | ++ |
com.marklogic.hub.scaffold | ++ |
com.marklogic.hub.scaffold.impl | ++ |
com.marklogic.hub.util | ++ |
com.marklogic.hub.validate | ++ |
com.marklogic.hub.validate.impl | ++ |