com.marklogic.developer.corb

Class AbstractTask

java.lang.Object

com.marklogic.developer.corb.AbstractTask

All Implemented Interfaces:

Task, java.util.concurrent.Callable<java.lang.String[]>

Direct Known Subclasses:

ExportToFileTask, Transform

public abstract class AbstractTask
extends java.lang.Object
implements Task

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	adhocQuery
protected com.marklogic.xcc.ContentSource	cs
protected static int	DEFAULT_CONNECTION_RETRY_INTERVAL
protected static int	DEFAULT_CONNECTION_RETRY_LIMIT
protected static int	DEFAULT_QUERY_RETRY_INTERVAL
protected static int	DEFAULT_QUERY_RETRY_LIMIT
protected java.lang.String	exportDir
protected boolean	failOnError
protected static java.lang.String	FALSE
protected java.lang.String[]	inputUris
protected java.lang.String	language
protected static java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	MODULE_PROPS
protected java.lang.String	moduleType
protected java.lang.String	moduleUri
protected static byte[]	NEWLINE
protected java.util.Properties	properties
protected int	retryCount
protected static java.lang.String	TRUE

Constructor Summary

Constructors

Constructor and Description
AbstractTask()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	asString(java.lang.String[] uris)
java.lang.String[]	call()
protected void	cleanup()
java.lang.String	getExportDir()
protected int	getIntProperty(java.lang.String key) Retrieves an int value.
java.lang.String	getProperty(java.lang.String key)
protected byte[]	getValueAsBytes(com.marklogic.xcc.types.XdmItem item)
protected java.lang.String[]	handleRequestException(com.marklogic.xcc.exceptions.RequestException requestException)
protected boolean	hasRetryableMessage(com.marklogic.xcc.exceptions.RequestException requestException)
protected java.lang.String[]	invokeModule()
com.marklogic.xcc.Session	newSession()
protected abstract java.lang.String	processResult(com.marklogic.xcc.ResultSequence seq)
void	setAdhocQuery(java.lang.String adhocQuery)
void	setContentSource(com.marklogic.xcc.ContentSource cs)
void	setExportDir(java.lang.String exportFileDir)
void	setFailOnError(boolean failOnError)
void	setInputURI(java.lang.String[] inputUri)
void	setModuleType(java.lang.String moduleType) XQUERY-MODULE,PRE-BATCH-MODULE,POST-BATCH-MODULE,INIT-MODULE
void	setModuleURI(java.lang.String moduleUri)
void	setProperties(java.util.Properties properties) If additional data is sent from CUSTOM URI module, it is available in properties with key URIS_BATCH_REF
void	setQueryLanguage(java.lang.String language)
protected boolean	shouldRetry(com.marklogic.xcc.exceptions.QueryException queryException)
protected boolean	shouldRetry(com.marklogic.xcc.exceptions.RequestException requestException)
protected boolean	shouldRetry(com.marklogic.xcc.exceptions.RequestPermissionException requestPermissionException)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRUE

protected static final java.lang.String TRUE

See Also:

Constant Field Values

FALSE

protected static final java.lang.String FALSE

See Also:

Constant Field Values

NEWLINE

protected static final byte[] NEWLINE

cs

protected com.marklogic.xcc.ContentSource cs

moduleType

protected java.lang.String moduleType

moduleUri

protected java.lang.String moduleUri

properties

protected java.util.Properties properties

inputUris

protected java.lang.String[] inputUris

adhocQuery

protected java.lang.String adhocQuery

language

protected java.lang.String language

exportDir

protected java.lang.String exportDir

MODULE_PROPS

protected static final java.util.Map<java.lang.String,java.util.Set<java.lang.String>> MODULE_PROPS

DEFAULT_CONNECTION_RETRY_LIMIT

protected static final int DEFAULT_CONNECTION_RETRY_LIMIT

See Also:

Constant Field Values

DEFAULT_CONNECTION_RETRY_INTERVAL

protected static final int DEFAULT_CONNECTION_RETRY_INTERVAL

See Also:

Constant Field Values

DEFAULT_QUERY_RETRY_LIMIT

protected static final int DEFAULT_QUERY_RETRY_LIMIT

See Also:

Constant Field Values

DEFAULT_QUERY_RETRY_INTERVAL

protected static final int DEFAULT_QUERY_RETRY_INTERVAL

See Also:

Constant Field Values

retryCount

protected int retryCount

failOnError

protected boolean failOnError

Constructor Detail

AbstractTask

public AbstractTask()

Method Detail

setContentSource

public void setContentSource(com.marklogic.xcc.ContentSource cs)

Specified by:

setContentSource in interface Task

setModuleType

public void setModuleType(java.lang.String moduleType)

Description copied from interface: Task

XQUERY-MODULE,PRE-BATCH-MODULE,POST-BATCH-MODULE,INIT-MODULE

Specified by:

setModuleType in interface Task

setModuleURI

public void setModuleURI(java.lang.String moduleUri)

Specified by:

setModuleURI in interface Task

setAdhocQuery

public void setAdhocQuery(java.lang.String adhocQuery)

Specified by:

setAdhocQuery in interface Task

setQueryLanguage

public void setQueryLanguage(java.lang.String language)

Specified by:

setQueryLanguage in interface Task

setProperties

public void setProperties(java.util.Properties properties)

Description copied from interface: Task

If additional data is sent from CUSTOM URI module, it is available in properties with key URIS_BATCH_REF

Specified by:

setProperties in interface Task

setInputURI

public void setInputURI(java.lang.String[] inputUri)

Specified by:

setInputURI in interface Task

setFailOnError

public void setFailOnError(boolean failOnError)

Specified by:

setFailOnError in interface Task

setExportDir

public void setExportDir(java.lang.String exportFileDir)

Specified by:

setExportDir in interface Task

getExportDir

public java.lang.String getExportDir()

newSession

public com.marklogic.xcc.Session newSession()

call

public java.lang.String[] call()
                        throws java.lang.Exception

Specified by:

call in interface java.util.concurrent.Callable<java.lang.String[]>

Throws:

java.lang.Exception

invokeModule

protected java.lang.String[] invokeModule()
                                   throws CorbException

Throws:

CorbException

shouldRetry

protected boolean shouldRetry(com.marklogic.xcc.exceptions.RequestException requestException)

hasRetryableMessage

protected boolean hasRetryableMessage(com.marklogic.xcc.exceptions.RequestException requestException)

shouldRetry

protected boolean shouldRetry(com.marklogic.xcc.exceptions.QueryException queryException)

shouldRetry

protected boolean shouldRetry(com.marklogic.xcc.exceptions.RequestPermissionException requestPermissionException)

handleRequestException

protected java.lang.String[] handleRequestException(com.marklogic.xcc.exceptions.RequestException requestException)
                                             throws CorbException

Throws:

CorbException

asString

protected java.lang.String asString(java.lang.String[] uris)

processResult

protected abstract java.lang.String processResult(com.marklogic.xcc.ResultSequence seq)
                                           throws CorbException

Throws:

CorbException

cleanup

protected void cleanup()

getProperty

public java.lang.String getProperty(java.lang.String key)

getValueAsBytes

protected byte[] getValueAsBytes(com.marklogic.xcc.types.XdmItem item)

getIntProperty

protected int getIntProperty(java.lang.String key)

Retrieves an int value.

Parameters:

key - The key name.

Returns:

The requested value (-1 if not found or could not parse value as int).