com.endeca.soleng.eac.toolkit.utility
Class BackupUtility

java.lang.Object
  com.endeca.soleng.eac.toolkit.base.EacElement
      com.endeca.soleng.eac.toolkit.utility.Utility
          com.endeca.soleng.eac.toolkit.utility.BackupUtility

public class BackupUtility
extends Utility

BackupUtility extends the Utility object, exposing the fields that make up a backup utility invocation and convenience initializer methods that take all of the arguments required to define a backup utility.

Author:

sshusteff

Field Summary

Fields inherited from class com.endeca.soleng.eac.toolkit.utility.Utility

EAC_MAX_TOKEN_LENGTH, ENDECA_CONF, IS_WINDOWS, WINDOWS_MAX_PATH_LENGTH

Fields inherited from class com.endeca.soleng.eac.toolkit.base.EacElement

appName, dataPrefix, eacHost, eacPort, elementId, lockManager, logDir, sslEnabled, workingDir

Constructor Summary

BackupUtility()

BackupUtility(java.lang.String appName, java.lang.String eacHost, int eacPort, boolean sslEnabled)
Default (inherited) constructor.

Method Summary

com.endeca.eac.client.RunUtilityType	buildEacStub() Builds a RunUtilityType object to send to the EAC.
java.lang.String	getDir()
java.lang.String	getHostId()
int	getNumBackups()
void	init(java.lang.String token, java.lang.String host, java.lang.String dir, boolean isMove, int numBackups) Backup initializer.
protected void	initializeEacStub(com.endeca.eac.client.RunBackupType stub)
boolean	isMove()
protected int	maximumAllowedTokenLength()
void	setDir(java.lang.String dir)
void	setHostId(java.lang.String hostId)
void	setMove(boolean isMove)
void	setNumBackups(int numBackups)

Methods inherited from class com.endeca.soleng.eac.toolkit.utility.Utility

getDirContents, getMaxMissedStatusChecksAllowed, getMaxWaitTimeSeconds, getMinWaitTimeSeconds, getNonNullPositiveLongValueOrDefault, getNumMissedStatusChecks, getSlowPollingIntervalMs, getStandardPollingIntervalMs, getStatus, incrementMissedStatusQueries, initializeEacStub, isActive, isFailed, run, runInParallel, setElementId, setMaxMissedStatusQueriesAllowed, setMaxWaitSeconds, setMinWaitSeconds, setNumMissedStatusChecks, setPollingIntervalMs, setSlowPollingIntervalMs, start, stop, waitForFinished

Methods inherited from class com.endeca.soleng.eac.toolkit.base.EacElement

getAppName, getDataPrefix, getEacHost, getEacPort, getElementId, getLockManager, getLogDir, getWorkingDir, isSslEnabled, setAppName, setDataPrefix, setEacHost, setEacPort, setLockManager, setLogDir, setSslEnabled, setWorkingDir

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupUtility

public BackupUtility(java.lang.String appName,
                     java.lang.String eacHost,
                     int eacPort,
                     boolean sslEnabled)
              throws AppConfigurationException

Default (inherited) constructor.

Throws:

AppConfigurationException - If the application name or EAC host is null.

BackupUtility

public BackupUtility()

Method Detail

init

public void init(java.lang.String token,
                 java.lang.String host,
                 java.lang.String dir,
                 boolean isMove,
                 int numBackups)

Backup initializer.

Parameters:

token - ID of the backup utility.

host - ID of the host on which to backup the directory.

dir - Directory to back up.

isMove - True if the backup should remove the existing directory, false if the backup should simply copy the directory.

numBackups - Number of backups to keep.

buildEacStub

public com.endeca.eac.client.RunUtilityType buildEacStub()

Description copied from class: Utility

Builds a RunUtilityType object to send to the EAC. If necessary, translates or transforms fields to match the EAC's requirements.

Overrides:

buildEacStub in class Utility

Returns:

Returns the RunUtilityType WSDL stub object for this Utility.

initializeEacStub

protected void initializeEacStub(com.endeca.eac.client.RunBackupType stub)

getDir

public java.lang.String getDir()

setDir

public void setDir(java.lang.String dir)

getHostId

public java.lang.String getHostId()

setHostId

public void setHostId(java.lang.String hostId)

isMove

public boolean isMove()

setMove

public void setMove(boolean isMove)

getNumBackups

public int getNumBackups()

setNumBackups

public void setNumBackups(int numBackups)

maximumAllowedTokenLength

protected int maximumAllowedTokenLength()

Overrides:

maximumAllowedTokenLength in class Utility