com.endeca.soleng.eac.toolkit.utility.webstudio
Class WSUtility

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.webstudio.WSUtility

Direct Known Subclasses:

GetAllFilesUtility, GetWSDgraphFilesUtility, GetWSFilesUtility, RemoveAllConfigUtility, SetInstanceConfigUtility, SetPostForgeDimsUtility

public class WSUtility
extends ShellUtility

Utility used to interact with Web Studio via calls to emgr_update.

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

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

Method Summary

protected java.lang.String	getEmgrUpdateExecutable()
void	init(java.lang.String token, java.lang.String commandHost, java.lang.String wsHost, java.lang.String wsPort, java.lang.String command, java.lang.String workingDir) Web Studio command 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

WSUtility

public WSUtility(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 commandHost,
                 java.lang.String wsHost,
                 java.lang.String wsPort,
                 java.lang.String command,
                 java.lang.String workingDir)

Web Studio command initializer.

Parameters:

token - ID of the shell utility.

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

wsHost - Hostname of machine running Web Studio.

wsPort - Port on which Web Studio is listening.

command - Command string to pass to emgr_update. For example "--action get_ws_settings --prefix wine --dir /apps/endeca/data/forge_input"

workingDir - Working directory from which to execute the command.

getEmgrUpdateExecutable

protected java.lang.String getEmgrUpdateExecutable()