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

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.PerlScriptUtility

public class PerlScriptUtility
extends PerlUtility

Utility used to invoke a Perl script.

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

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

Method Summary

void	init(java.lang.String token, java.lang.String host, java.lang.String perlScriptPath, java.lang.String workingDir) Perl script runner initializer.
void	init(java.lang.String token, java.lang.String host, java.lang.String perlScriptPath, java.lang.String[] scriptArgs, java.lang.String workingDir) Perl script runner initializer that takes an array of argument strings to pass to the Perl script.

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

PerlScriptUtility

public PerlScriptUtility(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 token,
                 java.lang.String host,
                 java.lang.String perlScriptPath,
                 java.lang.String workingDir)

Perl script runner initializer.

Overrides:

init in class ShellUtility

Parameters:

token - ID of the shell utility.

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

perlScriptPath - path to the Perl Script to be executed.

workingDir - Working directory from which to execute the command.

init

public void init(java.lang.String token,
                 java.lang.String host,
                 java.lang.String perlScriptPath,
                 java.lang.String[] scriptArgs,
                 java.lang.String workingDir)

Perl script runner initializer that takes an array of argument strings to pass to the Perl script.

Parameters:

token - ID of the shell utility.

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

perlScriptPath - path to the Perl Script to be executed.

scriptArgs - String array of arguments to pass to the Perl script.

workingDir - Working directory from which to execute the command.