Package com.basis.api.admin

Interface BBjAdminBBjReplicationJob_1310

All Superinterfaces:

BBjAdminBBjReplicationJob, BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, BBjAdminReplicationJob, Remote, Serializable

public interface BBjAdminBBjReplicationJob_1310
extends BBjAdminBBjReplicationJob

Version of BBjAdminBBjReplicationJob that is used for 13.10 and above.

Field Summary

Fields inherited from interface com.basis.api.admin.BBjAdminBBjReplicationJob

HOST, PASSWORD, PORT, SSL, USER

Fields inherited from interface com.basis.api.admin.BBjAdminReplicationJob

ADVISORY_LOCKING, ENABLED, EVENT_EMAIL_RECIPIENTS, EVENT_EMAIL_SERVICE, EVENT_HANDLER, EVENT_HANDLER_CLASSPATH, EVENT_HANDLER_CONFIG, EVENT_HANDLER_PWD, EVENT_HANDLER_USER, EVENT_HANDLER_WORKING_DIR, ID, LOCAL, MAX_BANDWIDTH, NAME, RECOPY_ENABLED, STATE_COPYING_FILES, STATE_ERROR, STATE_NOT_SINCE_START, SYNCHRONOUS

Method Summary

Modifier and Type	Method	Description
void	addGlobExclude(String p_sourceDir, String p_pattern, String p_destinationDir, boolean p_recursive, boolean p_matchPath, String p_modes)
void	addGlobInclude(String p_sourceDir, String p_pattern, String p_destinationDir, boolean p_recursive, boolean p_matchPath, boolean p_advisory, String p_modes)
void	addRegexExclude(String p_sourceDir, String p_pattern, String p_destinationDir, boolean p_recursive, boolean p_matchPath, String p_modes)
void	addRegexInclude(String p_sourceDir, String p_pattern, String p_destinationDir, boolean p_recursive, boolean p_matchPath, boolean p_advisory, String p_modes)
void	clearInclusions()	Clears the list of all included filters.
BBjAdminMap<String,String>	getBadFiles()	Returns a list of "bad files".
BBjAdminList<BBjAdminReplicationFilter>	getExcludeFilters()	Returns a list of all the exclude filters used by this replication job.
BBjAdminList<BBjAdminReplicationFileStats>	getFileStats(String p_filter, boolean p_regex)	Returns a list of the files that match the specified criteria
BBjAdminList<BBjAdminReplicationFilter>	getIncludeFilters()	Returns a list of all the include filters used by this replication job.
void	resetBadFile(String p_file, boolean p_forceCopy)	Resets a file to be no longer "bad".

Methods inherited from interface com.basis.api.admin.BBjAdminBBjReplicationJob

addExclude, addJob, addMapping, addMapping, clearExclusions, clearMappings, getExclusions, getMappings, getModes, removeMapping

Methods inherited from interface com.basis.api.admin.BBjAdminCommitPropertyWriter

getChangedProperties, getClearedProperties, getOriginalProperties

Methods inherited from interface com.basis.api.admin.BBjAdminCommitWriter

commit, rollback

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

addType, canAddNewProperties, canClear, clear, clearProperties, clearProperty, getReadOnly, hasChanged, isReadOnly, setBoolean, setDouble, setInt, setList, setLong, setProperties, setString, setValue

Methods inherited from interface com.basis.api.admin.BBjAdminReplicationJob

cancelDisableWhenCaughtUpToNow, disableWhenCaughtUpToNow, getCurrentError, getDescriptiveProperties, getLastInSync, getLastInSyncString, getLastLag, getLastOpRate, getLastTimestamp, getLastTimestampRatio, getLastTimestampSummary, getLastWaitForLog, getStartProcesses, setDescriptiveProperties, setEnabled, waitingToDisable

Method Details

addRegexInclude

void addRegexInclude(String p_sourceDir,
 String p_pattern,
 String p_destinationDir,
 boolean p_recursive,
 boolean p_matchPath,
 boolean p_advisory,
 String p_modes)
              throws BBjAdminException

Parameters:

p_sourceDir -

p_pattern -

p_destinationDir -

p_recursive -

p_matchPath -

p_advisory -

p_modes -

Throws:

BBjAdminException

addRegexExclude

void addRegexExclude(String p_sourceDir,
 String p_pattern,
 String p_destinationDir,
 boolean p_recursive,
 boolean p_matchPath,
 String p_modes)
              throws BBjAdminException

Parameters:

p_sourceDir -

p_pattern -

p_destinationDir -

p_recursive -

p_matchPath -

p_modes -

Throws:

BBjAdminException

addGlobInclude

void addGlobInclude(String p_sourceDir,
 String p_pattern,
 String p_destinationDir,
 boolean p_recursive,
 boolean p_matchPath,
 boolean p_advisory,
 String p_modes)
             throws BBjAdminException

Parameters:

p_sourceDir -

p_pattern -

p_destinationDir -

p_recursive -

p_matchPath -

p_modes -

Throws:

BBjAdminException

addGlobExclude

void addGlobExclude(String p_sourceDir,
 String p_pattern,
 String p_destinationDir,
 boolean p_recursive,
 boolean p_matchPath,
 String p_modes)
             throws BBjAdminException

Parameters:

p_sourceDir -

p_pattern -

p_destinationDir -

p_recursive -

p_matchPath -

p_modes -

Throws:

BBjAdminException

getIncludeFilters

BBjAdminList<BBjAdminReplicationFilter> getIncludeFilters()
                                                   throws BBjAdminException

Returns a list of all the include filters used by this replication job.

Returns:

List of all the include filters.

Throws:

BBjAdminException

getExcludeFilters

BBjAdminList<BBjAdminReplicationFilter> getExcludeFilters()
                                                   throws BBjAdminException

Returns a list of all the exclude filters used by this replication job.

Returns:

List of all the exclude filters.

Throws:

BBjAdminException

clearInclusions

void clearInclusions()
              throws BBjAdminException

Clears the list of all included filters.

Throws:

BBjAdminException

getBadFiles

BBjAdminMap<String,String> getBadFiles()
                                throws BBjAdminException

Returns a list of "bad files". The "bad files" are those files that replication choked on for some reason. Instead of holding up the whole job, we remove them from the job temporarily and add them to the bad files list. Restarting BBj services will clear out this list as it is not persistent. This method returns the bad file as well as the error message or reason it was bad.

Returns:

List of bad files.

Throws:

BBjAdminException

resetBadFile

void resetBadFile(String p_file,
 boolean p_forceCopy)
           throws BBjAdminException

Resets a file to be no longer "bad". See getBadFiles() for more detail on "bad files".

Parameters:

p_file - File to reset.

p_forceCopy - True if the file should force a complete recopy of the file even if it appears to be unnecessary.

Throws:

BBjAdminException

getFileStats

BBjAdminList<BBjAdminReplicationFileStats> getFileStats(String p_filter,
 boolean p_regex)
                                                 throws BBjAdminException

Returns a list of the files that match the specified criteria

Parameters:

p_filter - Filter to use to match files. This can be a glob or regular expression type pattern. Indicate the type in the p_regex boolean parameter.

p_regex - True if the filter is a regular expression. Otherwise it will be treated as a glob type file matching pattern (i.e. *.txt, etc.).

Returns:

List of files that match the filter.

Throws:

BBjAdminException