com.endeca.soleng.eac.toolkit.utility.perl
Class RemoveFileUtility

java.lang.Object
  com.endeca.soleng.eac.toolkit.base.EacElement
      com.endeca.soleng.eac.toolkit.utility.Utility
          com.endeca.soleng.eac.toolkit.utility.ShellUtility
              com.endeca.soleng.eac.toolkit.utility.perl.PerlUtility
                  com.endeca.soleng.eac.toolkit.utility.perl.PerlInlineScriptUtility
                      com.endeca.soleng.eac.toolkit.utility.perl.RemoveFileUtility

public class RemoveFileUtility
extends PerlInlineScriptUtility

Utility used to remove a file or files that match a specified path.

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

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

Method Summary

void	init(java.lang.String host, java.lang.String path) Convenience wrapper of init(host, path, workingDir) that specifies a null workingDir.
void	init(java.lang.String host, java.lang.String path, java.lang.String workingDir) RemoveDir initializer.
void	init(java.lang.String token, java.lang.String host, java.lang.String path, java.lang.String workingDir) RemoveDir initializer that specifies a custom token.

Methods inherited from class com.endeca.soleng.eac.toolkit.utility.perl.PerlUtility

getPerlBinary

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

buildEacStub, conditionalRun, getCommand, getHostId, initializeEacStub, maximumAllowedTokenLength, setCommand, setHostId

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

RemoveFileUtility

public RemoveFileUtility(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.

Method Detail

init

public void init(java.lang.String host,
                 java.lang.String path)

Convenience wrapper of init(host, path, workingDir) that specifies a null workingDir.

Parameters:

host - ID of the host on which to execute the command.

path - File path to remove.

init

public void init(java.lang.String host,
                 java.lang.String path,
                 java.lang.String workingDir)

RemoveDir initializer.

Parameters:

host - ID of the host on which to execute the command.

path - File path to remove.

workingDir - Working directory from which to execute the command.

init

public void init(java.lang.String token,
                 java.lang.String host,
                 java.lang.String path,
                 java.lang.String workingDir)

RemoveDir initializer that specifies a custom token.

Overrides:

init in class PerlInlineScriptUtility

Parameters:

token - custom token to use for the shell invocation.

host - ID of the host on which to execute the command.

path - File path to remove.

workingDir - Working directory from which to execute the command.