com.endeca.soleng.eac.toolkit.utility.curl
Class CurlUtility

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.curl.CurlUtility

Direct Known Subclasses:

DgraphConfigUpdateUtility, DgraphFlushCacheUtility, DgraphReloadServicesUtility, DgraphUpdateUtility, LogServerRollUtility

public class CurlUtility
extends ShellUtility

Utility used to execute a curl call to a URL.

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

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

Method Summary

protected java.lang.String	getBinaryDir()
protected java.lang.String	getCurlBinary()
void	init(java.lang.String host, java.lang.String url) Convenience wrapper of init(host, dir, workingDir) that specifies a null workingDir.
void	init(java.lang.String host, java.lang.String url, java.lang.String workingDir) Curl initializer.
void	init(java.lang.String host, java.lang.String url, java.lang.String workingDir, java.lang.String certFile, java.lang.String caFile) Curl initializer.

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

buildEacStub, conditionalRun, getCommand, getHostId, init, 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

CurlUtility

public CurlUtility(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 url)

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

Parameters:

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

url - URL to curl.

init

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

Curl initializer.

Parameters:

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

url - URL to curl.

workingDir - Working directory from which to execute the command.

init

public void init(java.lang.String host,
                 java.lang.String url,
                 java.lang.String workingDir,
                 java.lang.String certFile,
                 java.lang.String caFile)

Curl initializer.

Parameters:

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

url - URL to curl.

workingDir - Working directory from which to execute the command.

certFile - The certificate file that is needed to use an HTTPS URL. This is 'null' if HTTP is used instead.

caFile - The Certificate Authority that is needed to verify the various certificates when using an HTTPS URL. This is 'null' if HTTP is used instead.

getCurlBinary

protected java.lang.String getCurlBinary()

getBinaryDir

protected java.lang.String getBinaryDir()