com.marklogic.ps.xqsync

Class Configuration

java.lang.Object

com.marklogic.ps.xqsync.AbstractConfiguration

com.marklogic.ps.xqsync.Configuration

public class Configuration
extends AbstractConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLOW_EMPTY_METADATA_DEFAULT
static java.lang.String	ALLOW_EMPTY_METADATA_KEY
static java.lang.String	CHECKSUM_MODULE_KEY
static java.lang.String	CONFIGURATION_CLASSNAME_DEFAULT
static java.lang.String	CONFIGURATION_CLASSNAME_KEY
static java.lang.String	COPY_COLLECTIONS_DEFAULT
static java.lang.String	COPY_COLLECTIONS_KEY
static java.lang.String	COPY_PERMISSIONS_DEFAULT
static java.lang.String	COPY_PERMISSIONS_KEY
static java.lang.String	COPY_PROPERTIES_DEFAULT
static java.lang.String	COPY_PROPERTIES_KEY
static java.lang.String	COPY_QUALITY_DEFAULT
static java.lang.String	COPY_QUALITY_KEY
protected static java.lang.String	CSV_SCSV_SSV_REGEX
static java.lang.String	DELETE_COLLECTION_KEY
static java.lang.String	ENCODE_OUTPUT_URI_DEFAULT
static java.lang.String	ENCODE_OUTPUT_URI_KEY
static boolean	FATAL_ERRORS_DEFAULT_BOOLEAN
static java.lang.String	FATAL_ERRORS_KEY
protected boolean	firstConfiguration
protected java.util.Map<java.lang.String,java.math.BigInteger>	forestMap
static java.lang.String	INPUT_BATCH_SIZE_DEFAULT
static java.lang.String	INPUT_BATCH_SIZE_KEY
static java.lang.String	INPUT_CACHABLE_DEFAULT
static java.lang.String	INPUT_CACHABLE_KEY
static java.lang.String	INPUT_COLLECTION_URI_KEY
static java.lang.String	INPUT_CONNECTION_STRING_KEY
static java.lang.String	INPUT_DIRECTORY_URI_KEY
static java.lang.String	INPUT_DOCUMENT_URIS_KEY
static java.lang.String	INPUT_INDENTED_KEY
static java.lang.String	INPUT_MODULE_URI_KEY
static java.lang.String	INPUT_PACKAGE_KEY
static java.lang.String	INPUT_PATH_KEY
static java.lang.String	INPUT_QUERY_BUFFER_BYTES_DEFAULT
static java.lang.String	INPUT_QUERY_BUFFER_BYTES_KEY
static java.lang.String	INPUT_QUERY_KEY
static java.lang.String	INPUT_RESULT_BUFFER_SIZE_DEFAULT
static java.lang.String	INPUT_RESULT_BUFFER_SIZE_KEY
static java.lang.String	INPUT_START_POSITION_KEY
static java.lang.String	INPUT_TIMESTAMP_AUTO
static java.lang.String	INPUT_TIMESTAMP_KEY
protected Connection	inputConnection
protected java.lang.String	inputPackagePath
protected java.lang.String	inputPath
static java.lang.String	KEEP_URI_QUEUE_FILE_DEFAULT
static java.lang.String	KEEP_URI_QUEUE_FILE_KEY
static java.lang.String	MAX_RETRIES_DEFAULT
static java.lang.String	MAX_RETRIES_KEY
static java.lang.String	OUTPUT_BATCH_SIZE_DEFAULT
static java.lang.String	OUTPUT_BATCH_SIZE_KEY
static java.lang.String	OUTPUT_COLLECTIONS_KEY
static java.lang.String	OUTPUT_CONNECTION_STRING_KEY
static java.lang.String	OUTPUT_FILTER_FORMATS_KEY
static java.lang.String	OUTPUT_FORESTS_KEY
static java.lang.String	OUTPUT_PACKAGE_KEY
static java.lang.String	OUTPUT_PATH_KEY
protected java.lang.String[]	outputCollections
protected Connection[]	outputConnection
protected java.lang.String[]	outputFormatFilters
protected java.lang.String	outputPackagePath
protected java.lang.String	outputPath
protected java.util.Collection<com.marklogic.xcc.ContentPermission>	permissionRoles
protected java.lang.String[]	placeKeys
static java.lang.String	PRINT_CURRENT_RATE_DEFAULT
static java.lang.String	PRINT_CURRENT_RATE_KEY
static java.lang.String	QUEUE_SIZE_KEY
static java.lang.String	REPAIR_INPUT_XML_DEFAULT
static java.lang.String	REPAIR_INPUT_XML_KEY
static java.lang.String	REPAIR_MULTIPLE_DOCUMENTS_PER_URI_DEFAULT
static java.lang.String	REPAIR_MULTIPLE_DOCUMENTS_PER_URI_KEY
static java.lang.String	ROLES_EXECUTE_KEY
static java.lang.String	ROLES_INSERT_KEY
static java.lang.String	ROLES_READ_KEY
static java.lang.String	ROLES_UPDATE_KEY
static java.lang.String	SKIP_EXISTING_KEY
protected java.lang.Long	startPosition
static java.lang.String	THREADS_DEFAULT
static java.lang.String	THREADS_KEY
static java.lang.String	THROTTLE_BYTES_DEFAULT
static java.lang.String	THROTTLE_BYTES_KEY
static java.lang.String	THROTTLE_EVENTS_DEFAULT
static java.lang.String	THROTTLE_EVENTS_KEY
protected int	throttledBytesPerSecond
protected double	throttledEventsPerSecond
protected java.math.BigInteger	timestamp
static java.lang.String	TMP_DIR_DEFAULT
static java.lang.String	TMP_DIR_KEY
static java.lang.String	URI_PREFIX_KEY
static java.lang.String	URI_PREFIX_STRIP_KEY
static java.lang.String	URI_QUEUE_FILE_DEFAULT
static java.lang.String	URI_QUEUE_FILE_KEY
static java.lang.String	URI_SUFFIX_KEY
static java.lang.String	URI_SUFFIX_STRIP_KEY
protected java.lang.String	uriPrefix
static java.lang.String	USE_IN_FOREST_EVAL_DEFAULT
static java.lang.String	USE_IN_FOREST_EVAL_KEY
static java.lang.String	USE_IN_MEMORY_URI_QUEUE_DEFAULT
static java.lang.String	USE_IN_MEMORY_URI_QUEUE_KEY
static java.lang.String	USE_MULTI_STMT_TXN_DEFAULT
static java.lang.String	USE_MULTI_STMT_TXN_KEY
static java.lang.String	USE_RANDOM_OUTPUT_URI_DEFAULT
static java.lang.String	USE_RANDOM_OUTPUT_URI_KEY
protected static java.lang.String	XCC_PREFIX
protected static java.lang.String	XCC_PREFIX_OLD
protected static java.lang.String	XCCS_PREFIX

Fields inherited from class com.marklogic.ps.xqsync.AbstractConfiguration

DEFAULT_SUFFIX, defaults, KEY_SUFFIX, logger, properties

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure()
protected void	configureOutput()
boolean	doPrintCurrRate()
boolean	encodeOutputUri()
java.lang.String	getChecksumModule()
java.lang.String	getConfigurationClassName()
int	getInputBatchSize()
java.lang.String[]	getInputCollectionUris()
java.lang.String[]	getInputDirectoryUris()
java.lang.String[]	getInputDocumentUris()
boolean	getInputIndented()
java.lang.String	getInputModule()
java.lang.String	getInputPackagePath()
java.lang.String	getInputPath()
java.lang.String[]	getInputQuery()
int	getMaxRetries()
int	getOutputBatchSize()
java.lang.String[]	getOutputCollections()
java.util.Map<java.lang.String,java.math.BigInteger>	getOutputForestMap()
java.lang.String[]	getOutputForestNames()
java.lang.String[]	getOutputFormatFilters()
java.lang.String	getOutputPackagePath()
java.lang.String	getOutputPath()
static java.lang.String	getPackageFileExtension()
java.util.Collection<com.marklogic.xcc.ContentPermission>	getPermissionRoles()
java.lang.String[]	getPlaceKeys()
int	getQueueSize()
java.lang.Long	getStartPosition()
int	getThreadCount()
int	getThrottledBytesPerSecond()
double	getThrottledEventsPerSecond()
java.math.BigInteger	getTimestamp()
java.lang.String	getTmpDir()
java.lang.String	getUriPrefix()
java.lang.String	getUriPrefixStrip()
java.lang.String	getUriQueueFile()
java.lang.String	getUriSuffix()
java.lang.String	getUriSuffixStrip()
boolean	hasOutputCollections()
int	inputQueryBufferSize()
int	inputResultBufferSize()
boolean	isAllowEmptyMetadata()
boolean	isCopyCollections()
boolean	isCopyPermissions()
boolean	isCopyProperties()
boolean	isCopyQuality()
boolean	isDeleteOutputCollection()
boolean	isFatalErrors()
boolean	isInputQueryCachable()
boolean	isOutputConnection()
boolean	isRepairInputXml()
boolean	isRepairMultipleDocumentsPerUri()
boolean	isSkipExisting()
boolean	isThrottled()
protected boolean	isValidConnectionString(java.lang.String connectionString)
boolean	keepUriQueueFile()
Session	newInputSession()
Session	newOutputSession()
Session	newOutputSession(java.lang.String forestId)
ReaderInterface	newReader()
WriterInterface	newWriter()
void	setProperties(java.util.Properties properties)
boolean	useChecksumModule()
boolean	useInForestEval()
boolean	useInMemoryUriQueue()
boolean	useMultiStmtTxn()
boolean	useQueueFile()
boolean	useRandomOutputUri()

Methods inherited from class com.marklogic.ps.xqsync.AbstractConfiguration

getLogger, getProperties, load, load, setDefaults, setLogger, validateProperties

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_EMPTY_METADATA_KEY

public static final java.lang.String ALLOW_EMPTY_METADATA_KEY

See Also:

Constant Field Values

ALLOW_EMPTY_METADATA_DEFAULT

public static final java.lang.String ALLOW_EMPTY_METADATA_DEFAULT

See Also:

Constant Field Values

CONFIGURATION_CLASSNAME_KEY

public static final java.lang.String CONFIGURATION_CLASSNAME_KEY

See Also:

Constant Field Values

CONFIGURATION_CLASSNAME_DEFAULT

public static final java.lang.String CONFIGURATION_CLASSNAME_DEFAULT

COPY_COLLECTIONS_KEY

public static final java.lang.String COPY_COLLECTIONS_KEY

See Also:

Constant Field Values

COPY_COLLECTIONS_DEFAULT

public static final java.lang.String COPY_COLLECTIONS_DEFAULT

See Also:

Constant Field Values

COPY_PROPERTIES_KEY

public static final java.lang.String COPY_PROPERTIES_KEY

See Also:

Constant Field Values

COPY_PROPERTIES_DEFAULT

public static final java.lang.String COPY_PROPERTIES_DEFAULT

See Also:

Constant Field Values

COPY_PERMISSIONS_KEY

public static final java.lang.String COPY_PERMISSIONS_KEY

See Also:

Constant Field Values

COPY_PERMISSIONS_DEFAULT

public static final java.lang.String COPY_PERMISSIONS_DEFAULT

See Also:

Constant Field Values

COPY_QUALITY_KEY

public static final java.lang.String COPY_QUALITY_KEY

See Also:

Constant Field Values

COPY_QUALITY_DEFAULT

public static final java.lang.String COPY_QUALITY_DEFAULT

See Also:

Constant Field Values

DELETE_COLLECTION_KEY

public static final java.lang.String DELETE_COLLECTION_KEY

See Also:

Constant Field Values

FATAL_ERRORS_KEY

public static final java.lang.String FATAL_ERRORS_KEY

See Also:

Constant Field Values

FATAL_ERRORS_DEFAULT_BOOLEAN

public static final boolean FATAL_ERRORS_DEFAULT_BOOLEAN

See Also:

Constant Field Values

INPUT_BATCH_SIZE_KEY

public static final java.lang.String INPUT_BATCH_SIZE_KEY

See Also:

Constant Field Values

INPUT_BATCH_SIZE_DEFAULT

public static final java.lang.String INPUT_BATCH_SIZE_DEFAULT

See Also:

Constant Field Values

OUTPUT_BATCH_SIZE_KEY

public static final java.lang.String OUTPUT_BATCH_SIZE_KEY

See Also:

Constant Field Values

OUTPUT_BATCH_SIZE_DEFAULT

public static final java.lang.String OUTPUT_BATCH_SIZE_DEFAULT

See Also:

Constant Field Values

USE_MULTI_STMT_TXN_KEY

public static final java.lang.String USE_MULTI_STMT_TXN_KEY

See Also:

Constant Field Values

USE_MULTI_STMT_TXN_DEFAULT

public static final java.lang.String USE_MULTI_STMT_TXN_DEFAULT

See Also:

Constant Field Values

ENCODE_OUTPUT_URI_KEY

public static final java.lang.String ENCODE_OUTPUT_URI_KEY

See Also:

Constant Field Values

ENCODE_OUTPUT_URI_DEFAULT

public static final java.lang.String ENCODE_OUTPUT_URI_DEFAULT

See Also:

Constant Field Values

USE_RANDOM_OUTPUT_URI_KEY

public static final java.lang.String USE_RANDOM_OUTPUT_URI_KEY

See Also:

Constant Field Values

USE_RANDOM_OUTPUT_URI_DEFAULT

public static final java.lang.String USE_RANDOM_OUTPUT_URI_DEFAULT

See Also:

Constant Field Values

INPUT_CACHABLE_KEY

public static final java.lang.String INPUT_CACHABLE_KEY

See Also:

Constant Field Values

INPUT_CACHABLE_DEFAULT

public static final java.lang.String INPUT_CACHABLE_DEFAULT

See Also:

Constant Field Values

INPUT_COLLECTION_URI_KEY

public static final java.lang.String INPUT_COLLECTION_URI_KEY

See Also:

Constant Field Values

INPUT_CONNECTION_STRING_KEY

public static final java.lang.String INPUT_CONNECTION_STRING_KEY

See Also:

Constant Field Values

INPUT_DIRECTORY_URI_KEY

public static final java.lang.String INPUT_DIRECTORY_URI_KEY

See Also:

Constant Field Values

INPUT_DOCUMENT_URIS_KEY

public static final java.lang.String INPUT_DOCUMENT_URIS_KEY

See Also:

Constant Field Values

INPUT_MODULE_URI_KEY

public static final java.lang.String INPUT_MODULE_URI_KEY

See Also:

Constant Field Values

INPUT_PACKAGE_KEY

public static final java.lang.String INPUT_PACKAGE_KEY

See Also:

Constant Field Values

INPUT_PATH_KEY

public static final java.lang.String INPUT_PATH_KEY

See Also:

Constant Field Values

INPUT_QUERY_KEY

public static final java.lang.String INPUT_QUERY_KEY

See Also:

Constant Field Values

INPUT_QUERY_BUFFER_BYTES_KEY

public static final java.lang.String INPUT_QUERY_BUFFER_BYTES_KEY

See Also:

Constant Field Values

INPUT_QUERY_BUFFER_BYTES_DEFAULT

public static final java.lang.String INPUT_QUERY_BUFFER_BYTES_DEFAULT

See Also:

Constant Field Values

INPUT_RESULT_BUFFER_SIZE_KEY

public static final java.lang.String INPUT_RESULT_BUFFER_SIZE_KEY

See Also:

Constant Field Values

INPUT_RESULT_BUFFER_SIZE_DEFAULT

public static final java.lang.String INPUT_RESULT_BUFFER_SIZE_DEFAULT

See Also:

Constant Field Values

INPUT_START_POSITION_KEY

public static final java.lang.String INPUT_START_POSITION_KEY

See Also:

Constant Field Values

INPUT_TIMESTAMP_AUTO

public static final java.lang.String INPUT_TIMESTAMP_AUTO

See Also:

Constant Field Values

INPUT_TIMESTAMP_KEY

public static final java.lang.String INPUT_TIMESTAMP_KEY

See Also:

Constant Field Values

INPUT_INDENTED_KEY

public static final java.lang.String INPUT_INDENTED_KEY

See Also:

Constant Field Values

MAX_RETRIES_DEFAULT

public static final java.lang.String MAX_RETRIES_DEFAULT

See Also:

Constant Field Values

MAX_RETRIES_KEY

public static final java.lang.String MAX_RETRIES_KEY

See Also:

Constant Field Values

OUTPUT_COLLECTIONS_KEY

public static final java.lang.String OUTPUT_COLLECTIONS_KEY

See Also:

Constant Field Values

OUTPUT_CONNECTION_STRING_KEY

public static final java.lang.String OUTPUT_CONNECTION_STRING_KEY

See Also:

Constant Field Values

OUTPUT_FILTER_FORMATS_KEY

public static final java.lang.String OUTPUT_FILTER_FORMATS_KEY

See Also:

Constant Field Values

OUTPUT_FORESTS_KEY

public static final java.lang.String OUTPUT_FORESTS_KEY

See Also:

Constant Field Values

OUTPUT_PACKAGE_KEY

public static final java.lang.String OUTPUT_PACKAGE_KEY

See Also:

Constant Field Values

OUTPUT_PATH_KEY

public static final java.lang.String OUTPUT_PATH_KEY

See Also:

Constant Field Values

QUEUE_SIZE_KEY

public static final java.lang.String QUEUE_SIZE_KEY

See Also:

Constant Field Values

ROLES_READ_KEY

public static final java.lang.String ROLES_READ_KEY

See Also:

Constant Field Values

ROLES_UPDATE_KEY

public static final java.lang.String ROLES_UPDATE_KEY

See Also:

Constant Field Values

ROLES_INSERT_KEY

public static final java.lang.String ROLES_INSERT_KEY

See Also:

Constant Field Values

ROLES_EXECUTE_KEY

public static final java.lang.String ROLES_EXECUTE_KEY

See Also:

Constant Field Values

REPAIR_INPUT_XML_KEY

public static final java.lang.String REPAIR_INPUT_XML_KEY

See Also:

Constant Field Values

REPAIR_INPUT_XML_DEFAULT

public static final java.lang.String REPAIR_INPUT_XML_DEFAULT

See Also:

Constant Field Values

REPAIR_MULTIPLE_DOCUMENTS_PER_URI_DEFAULT

public static final java.lang.String REPAIR_MULTIPLE_DOCUMENTS_PER_URI_DEFAULT

See Also:

Constant Field Values

REPAIR_MULTIPLE_DOCUMENTS_PER_URI_KEY

public static final java.lang.String REPAIR_MULTIPLE_DOCUMENTS_PER_URI_KEY

See Also:

Constant Field Values

SKIP_EXISTING_KEY

public static final java.lang.String SKIP_EXISTING_KEY

See Also:

Constant Field Values

THREADS_KEY

public static final java.lang.String THREADS_KEY

See Also:

Constant Field Values

THREADS_DEFAULT

public static final java.lang.String THREADS_DEFAULT

See Also:

Constant Field Values

THROTTLE_EVENTS_KEY

public static final java.lang.String THROTTLE_EVENTS_KEY

See Also:

Constant Field Values

THROTTLE_EVENTS_DEFAULT

public static final java.lang.String THROTTLE_EVENTS_DEFAULT

See Also:

Constant Field Values

THROTTLE_BYTES_KEY

public static final java.lang.String THROTTLE_BYTES_KEY

See Also:

Constant Field Values

THROTTLE_BYTES_DEFAULT

public static final java.lang.String THROTTLE_BYTES_DEFAULT

See Also:

Constant Field Values

URI_PREFIX_KEY

public static final java.lang.String URI_PREFIX_KEY

See Also:

Constant Field Values

URI_SUFFIX_KEY

public static final java.lang.String URI_SUFFIX_KEY

See Also:

Constant Field Values

URI_PREFIX_STRIP_KEY

public static final java.lang.String URI_PREFIX_STRIP_KEY

See Also:

Constant Field Values

URI_SUFFIX_STRIP_KEY

public static final java.lang.String URI_SUFFIX_STRIP_KEY

See Also:

Constant Field Values

USE_IN_MEMORY_URI_QUEUE_KEY

public static final java.lang.String USE_IN_MEMORY_URI_QUEUE_KEY

See Also:

Constant Field Values

USE_IN_MEMORY_URI_QUEUE_DEFAULT

public static final java.lang.String USE_IN_MEMORY_URI_QUEUE_DEFAULT

See Also:

Constant Field Values

TMP_DIR_KEY

public static final java.lang.String TMP_DIR_KEY

See Also:

Constant Field Values

TMP_DIR_DEFAULT

public static final java.lang.String TMP_DIR_DEFAULT

URI_QUEUE_FILE_KEY

public static final java.lang.String URI_QUEUE_FILE_KEY

See Also:

Constant Field Values

URI_QUEUE_FILE_DEFAULT

public static final java.lang.String URI_QUEUE_FILE_DEFAULT

KEEP_URI_QUEUE_FILE_KEY

public static final java.lang.String KEEP_URI_QUEUE_FILE_KEY

See Also:

Constant Field Values

KEEP_URI_QUEUE_FILE_DEFAULT

public static final java.lang.String KEEP_URI_QUEUE_FILE_DEFAULT

See Also:

Constant Field Values

PRINT_CURRENT_RATE_KEY

public static final java.lang.String PRINT_CURRENT_RATE_KEY

See Also:

Constant Field Values

PRINT_CURRENT_RATE_DEFAULT

public static final java.lang.String PRINT_CURRENT_RATE_DEFAULT

See Also:

Constant Field Values

USE_IN_FOREST_EVAL_KEY

public static final java.lang.String USE_IN_FOREST_EVAL_KEY

See Also:

Constant Field Values

USE_IN_FOREST_EVAL_DEFAULT

public static final java.lang.String USE_IN_FOREST_EVAL_DEFAULT

See Also:

Constant Field Values

CHECKSUM_MODULE_KEY

public static final java.lang.String CHECKSUM_MODULE_KEY

See Also:

Constant Field Values

CSV_SCSV_SSV_REGEX

protected static final java.lang.String CSV_SCSV_SSV_REGEX

See Also:

Constant Field Values

XCC_PREFIX

protected static final java.lang.String XCC_PREFIX

See Also:

Constant Field Values

XCCS_PREFIX

protected static final java.lang.String XCCS_PREFIX

See Also:

Constant Field Values

XCC_PREFIX_OLD

protected static final java.lang.String XCC_PREFIX_OLD

See Also:

Constant Field Values

permissionRoles

protected final java.util.Collection<com.marklogic.xcc.ContentPermission> permissionRoles

placeKeys

protected java.lang.String[] placeKeys

outputConnection

protected Connection[] outputConnection

outputPath

protected java.lang.String outputPath

firstConfiguration

protected boolean firstConfiguration

inputConnection

protected Connection inputConnection

inputPath

protected java.lang.String inputPath

inputPackagePath

protected java.lang.String inputPackagePath

outputPackagePath

protected java.lang.String outputPackagePath

startPosition

protected java.lang.Long startPosition

throttledEventsPerSecond

protected double throttledEventsPerSecond

throttledBytesPerSecond

protected int throttledBytesPerSecond

uriPrefix

protected java.lang.String uriPrefix

outputCollections

protected java.lang.String[] outputCollections

outputFormatFilters

protected java.lang.String[] outputFormatFilters

timestamp

protected java.math.BigInteger timestamp

forestMap

protected java.util.Map<java.lang.String,java.math.BigInteger> forestMap

Constructor Detail

Configuration

public Configuration()

Method Detail

setProperties

public void setProperties(java.util.Properties properties)

configure

public void configure()
               throws java.lang.Exception

Throws:

com.marklogic.xcc.exceptions.XccException

java.io.IOException

java.net.URISyntaxException

SyncException

java.security.NoSuchAlgorithmException

java.security.KeyManagementException

java.lang.Exception

configureOutput

protected void configureOutput()
                        throws java.lang.Exception

Throws:

java.lang.Exception

isValidConnectionString

protected boolean isValidConnectionString(java.lang.String connectionString)

Parameters:

connectionString -

Returns:

isCopyCollections

public boolean isCopyCollections()

Returns:

isCopyPermissions

public boolean isCopyPermissions()

Returns:

isCopyProperties

public boolean isCopyProperties()

Returns:

isCopyQuality

public boolean isCopyQuality()

Returns:

isFatalErrors

public boolean isFatalErrors()

Returns:

isRepairMultipleDocumentsPerUri

public boolean isRepairMultipleDocumentsPerUri()

Returns:

isRepairInputXml

public boolean isRepairInputXml()

Returns:

getPlaceKeys

public java.lang.String[] getPlaceKeys()

getPermissionRoles

public java.util.Collection<com.marklogic.xcc.ContentPermission> getPermissionRoles()

isDeleteOutputCollection

public boolean isDeleteOutputCollection()

Returns:

newOutputSession

public Session newOutputSession()

Returns:

newOutputSession

public Session newOutputSession(java.lang.String forestId)

Returns:

a Session that would perform inForestEval

getOutputForestMap

public java.util.Map<java.lang.String,java.math.BigInteger> getOutputForestMap()

Returns:

a map of forest names to forest ids

getOutputForestNames

public java.lang.String[] getOutputForestNames()

Returns:

an array of forest names

getOutputPackagePath

public java.lang.String getOutputPackagePath()

Returns:

getOutputPath

public java.lang.String getOutputPath()

Returns:

getThreadCount

public int getThreadCount()

Returns:

newInputSession

public Session newInputSession()

Returns:

getInputPath

public java.lang.String getInputPath()

Returns:

getInputPackagePath

public java.lang.String getInputPackagePath()

Returns:

getStartPosition

public java.lang.Long getStartPosition()

Returns:

getConfigurationClassName

public java.lang.String getConfigurationClassName()

Returns:

getInputCollectionUris

public java.lang.String[] getInputCollectionUris()

Returns:

getInputDirectoryUris

public java.lang.String[] getInputDirectoryUris()

Returns:

getInputDocumentUris

public java.lang.String[] getInputDocumentUris()

Returns:

getInputQuery

public java.lang.String[] getInputQuery()

Returns:

getInputIndented

public boolean getInputIndented()

Returns:

isSkipExisting

public boolean isSkipExisting()

Returns:

getPackageFileExtension

public static java.lang.String getPackageFileExtension()

Returns:

getUriPrefix

public java.lang.String getUriPrefix()

Returns:

getOutputCollections

public java.lang.String[] getOutputCollections()

hasOutputCollections

public boolean hasOutputCollections()

Returns:

isAllowEmptyMetadata

public boolean isAllowEmptyMetadata()

Returns:

getTimestamp

public java.math.BigInteger getTimestamp()

Returns:

isInputQueryCachable

public boolean isInputQueryCachable()

Returns:

inputQueryBufferSize

public int inputQueryBufferSize()

Returns:

getQueueSize

public int getQueueSize()

Returns:

getOutputFormatFilters

public java.lang.String[] getOutputFormatFilters()

Returns:

getInputModule

public java.lang.String getInputModule()

Returns:

inputResultBufferSize

public int inputResultBufferSize()

Returns:

getInputBatchSize

public int getInputBatchSize()

Returns:

getMaxRetries

public int getMaxRetries()

Returns:

getOutputBatchSize

public int getOutputBatchSize()

Returns:

useMultiStmtTxn

public boolean useMultiStmtTxn()

Returns:

encodeOutputUri

public boolean encodeOutputUri()

Returns:

useRandomOutputUri

public boolean useRandomOutputUri()

Returns:

isOutputConnection

public boolean isOutputConnection()

Returns:

getUriPrefixStrip

public java.lang.String getUriPrefixStrip()

Returns:

getUriSuffixStrip

public java.lang.String getUriSuffixStrip()

Returns:

getUriSuffix

public java.lang.String getUriSuffix()

Returns:

isThrottled

public boolean isThrottled()

Returns:

getThrottledBytesPerSecond

public int getThrottledBytesPerSecond()

Returns:

getThrottledEventsPerSecond

public double getThrottledEventsPerSecond()

Returns:

useInMemoryUriQueue

public boolean useInMemoryUriQueue()

Returns:

whether to use the in memory uri queue or not

useQueueFile

public boolean useQueueFile()

Returns:

whether to use a file for uri queue or not

getTmpDir

public java.lang.String getTmpDir()

Returns:

the temporary directory location

getUriQueueFile

public java.lang.String getUriQueueFile()

Returns:

the uri queue file location

keepUriQueueFile

public boolean keepUriQueueFile()

Returns:

whether the queue file should be kept

doPrintCurrRate

public boolean doPrintCurrRate()

Returns:

boolean, true if we should print out the current rate

useInForestEval

public boolean useInForestEval()

Returns:

boolean, true if we should use in-forest eval

useChecksumModule

public boolean useChecksumModule()

Returns:

whether hash module should be used or not

getChecksumModule

public java.lang.String getChecksumModule()

Returns:

close

public void close()

newWriter

public WriterInterface newWriter()
                          throws SyncException

Returns:

Throws:

SyncException - This method always returns a SessionWriter or FilePathWriter. However, overriding subclasses can return any object that implements ReaderInterface.

newReader

public ReaderInterface newReader()
                          throws SyncException

Throws:

SyncException - This method always returns a SessionReader object. However, overriding subclasses can return any object that implements WriterInterface.