com.endeca.soleng.eac.toolkit.component
Class BatchComponent

java.lang.Object
  com.endeca.soleng.eac.toolkit.base.EacElement
      com.endeca.soleng.eac.toolkit.base.Provisionable
          com.endeca.soleng.eac.toolkit.component.Component
              com.endeca.soleng.eac.toolkit.component.BatchComponent

public class BatchComponent
extends Component

BatchComponent extends component to expose utilities for running non-server components (e.g. forge, dgidx). This object implements methods to run a component synchronously, or to run multiple components synchronously and in parallel.

Author:

sshusteff

Field Summary

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

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

Constructor Summary

BatchComponent()

Method Summary

void	run() Runs the batch component synchronously.
static void	runInParallel(java.util.List<BatchComponent> components) Runs batch components in parallel.

Methods inherited from class com.endeca.soleng.eac.toolkit.component.Component

archiveLogDir, buildEacStub, cleanDir, constructArchiveLogDir, constructCleanDir, getCustomDirectories, getDirProperties, getHost, getHostId, getLongPropertyValueOrDefault, getMaxMissedStatusChecksAllowed, getMaxWaitTimeSeconds, getMinWaitTimeSeconds, getNumLogBackups, getNumMissedStatusChecks, getProperties, getProperty, getSlowPollingIntervalMs, getStandardPollingIntervalMs, getStatus, incrementMissedStatusQueries, initializeEacStub, isActive, isDefined, isDefinitionChanged, isFailed, isHotUpdateDefinitionChange, isSkipTestingForFilesDuringCleanup, removeDefinition, setCustomDirectories, setDefinition, setDefinition, setHost, setHostId, setNumMissedStatusChecks, setProperties, start, stop, updateDefinition, updateEacDefinition, updateEacDefinition, waitForFinished

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

getAppDefinitionFromEac, getCachedAppDefinition, getProvisioningPort, invalidateCachedAppDefinition, setCachedAppDefinition

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchComponent

public BatchComponent()

Method Detail

runInParallel

public static void runInParallel(java.util.List<BatchComponent> components)
                          throws EacCommunicationException,
                                 EacComponentControlException

Runs batch components in parallel. Starts each component, then polls for the status until each component fails or stops.

Throws:

EacCommunicationException - If a communication error occurs while requesting the status of a component from the EAC.

EacComponentControlException - If an error occurs while trying to start a component.

run

public void run()
         throws EacCommunicationException,
                EacComponentControlException

Runs the batch component synchronously. Starts the component, polls for the status until the component fails or stops.

Throws:

EacCommunicationException - If a communication error occurs while requesting the status of the component from the EAC.

EacComponentControlException - If an error occurs while trying to start the component.