A B C D E F G H I L M P R S U W
A
- acquireLock(String) -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Tries to acquire a lock.
- acquireLock() -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Convenience wrapper that calls acquireLock(String) with a null string.
- acquireLockBlocking(String, long) -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Tries to acquire a lock.
- acquireLockBlocking(long) -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Convenience wrapper that calls acquireLockBlocking(String) with a null string.
- addAppConfigDoc(String) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- addConfigOverrideDoc(String) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- addHeldLock(String) -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Adds a lock to the list of held locks.
- AppConfigurationException - Exception in com.endeca.soleng.eac.toolkit.exception
- This exception captures various error conditions associated with invalid
configuration specified for an EAC application.
- AppConfigurationException() -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- Generic constructor.
- AppConfigurationException(String) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- Constructor that takes an error message as input.
- AppConfigurationException(Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- Constructor that takes a nested Throwable as input.
- AppConfigurationException(String, Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- Constructor that takes an error message and a nested Throwable as input.
- AppControlException - Exception in com.endeca.soleng.eac.toolkit.exception
- This exception captures various error conditions associated with failures
in controlling an Endeca application (e.g.
- AppControlException() -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.AppControlException
- Generic constructor.
- AppControlException(String) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.AppControlException
- Constructor that takes an error message as input.
- AppControlException(Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.AppControlException
- Constructor that takes a nested Throwable as input.
- AppControlException(String, Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.AppControlException
- Constructor that takes an error message and a nested Throwable as input.
- Application - Class in com.endeca.soleng.eac.toolkit.application
- This class represents an application in the EAC.
- Application() -
Constructor for class com.endeca.soleng.eac.toolkit.application.Application
- Default construcor.
- appName -
Variable in class com.endeca.soleng.eac.toolkit.base.EacElement
- Name of the application
- archiveLogDir() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Creates a backup of the components log directory (i.e.
B
- BackupUtility - Class in com.endeca.soleng.eac.toolkit.utility
- BackupUtility extends the Utility object, exposing the fields that
make up a backup utility invocation and convenience initializer methods
that take all of the arguments required to define a backup utility.
- BackupUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.BackupUtility
- Default (inherited) constructor.
- BackupUtility() -
Constructor for class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- BatchComponent - Class in com.endeca.soleng.eac.toolkit.component
- BatchComponent extends component to expose utilities for running non-server
components (e.g.
- BatchComponent() -
Constructor for class com.endeca.soleng.eac.toolkit.component.BatchComponent
-
- buildEacStub() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Builds a ComponentType object to send to the EAC.
- buildEacStub() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
- Builds the map of properties that serve as the definition for this
component.
- buildEacStub() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
- Builds a HostType object to send to the EAC.
- buildEacStub() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
- Builds a ScriptType object to send to the EAC.
- buildEacStub() -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- buildEacStub() -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- buildEacStub() -
Method in class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
-
- buildEacStub() -
Method in class com.endeca.soleng.eac.toolkit.utility.ShellUtility
-
- buildEacStub() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Builds a RunUtilityType object to send to the EAC.
C
- CasCommunicationException - Exception in com.endeca.soleng.eac.toolkit.exception
- This exception captures various error conditions encountered during
communication with the CAS server.
- CasCommunicationException() -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.CasCommunicationException
- Generic constructor.
- CasCommunicationException(String) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.CasCommunicationException
- Constructor that takes an error message as input.
- CasCommunicationException(Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.CasCommunicationException
- Constructor that takes a nested Throwable as input.
- CasCommunicationException(String, Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.CasCommunicationException
- Constructor that takes an error message and a nested Throwable as input.
- CasControlException - Exception in com.endeca.soleng.eac.toolkit.exception
- This exception captures various error conditions encountered when executing
crawls with the CAS server.
- CasControlException() -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.CasControlException
- Generic constructor.
- CasControlException(String) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.CasControlException
- Constructor that takes an error message as input.
- CasControlException(Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.CasControlException
- Constructor that takes a nested Throwable as input.
- CasControlException(String, Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.CasControlException
- Constructor that takes an error message and a nested Throwable as input.
- cleanDir(String) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Cleans all contents for the target directory, if the specified path is not null or empty.
- CleanDirUtility - Class in com.endeca.soleng.eac.toolkit.utility.perl
- Utility used to clean a directory.
- CleanDirUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
- Default (inherited) constructor.
- com.endeca.soleng.eac.toolkit - package com.endeca.soleng.eac.toolkit
-
- com.endeca.soleng.eac.toolkit.application - package com.endeca.soleng.eac.toolkit.application
-
- com.endeca.soleng.eac.toolkit.base - package com.endeca.soleng.eac.toolkit.base
-
- com.endeca.soleng.eac.toolkit.component - package com.endeca.soleng.eac.toolkit.component
-
- com.endeca.soleng.eac.toolkit.exception - package com.endeca.soleng.eac.toolkit.exception
-
- com.endeca.soleng.eac.toolkit.host - package com.endeca.soleng.eac.toolkit.host
-
- com.endeca.soleng.eac.toolkit.logging - package com.endeca.soleng.eac.toolkit.logging
-
- com.endeca.soleng.eac.toolkit.script - package com.endeca.soleng.eac.toolkit.script
-
- com.endeca.soleng.eac.toolkit.utility - package com.endeca.soleng.eac.toolkit.utility
-
- com.endeca.soleng.eac.toolkit.utility.perl - package com.endeca.soleng.eac.toolkit.utility.perl
-
- com.endeca.soleng.eac.toolkit.utility.webstudio - package com.endeca.soleng.eac.toolkit.utility.webstudio
-
- com.endeca.soleng.eac.toolkit.utility.wget - package com.endeca.soleng.eac.toolkit.utility.wget
-
- com.endeca.soleng.eac.toolkit.utils - package com.endeca.soleng.eac.toolkit.utils
-
- Component - Class in com.endeca.soleng.eac.toolkit.component
- Component is the provisionable object from which all components inherit.
- Component() -
Constructor for class com.endeca.soleng.eac.toolkit.component.Component
-
- conditionalRun() -
Method in class com.endeca.soleng.eac.toolkit.utility.ShellUtility
- Runs the shell utility synchronously, returning true if the invocation completes
with no error condition and false if the shell call results in an error condition.
- ConsoleFormatter - Class in com.endeca.soleng.eac.toolkit.logging
- Custom java.util.logging formatter used to produce user-friendly console
output during script execution.
- ConsoleFormatter() -
Constructor for class com.endeca.soleng.eac.toolkit.logging.ConsoleFormatter
-
- constructArchiveLogDir() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Construct utility for archiving the log directory or, if number of archives is configured to be
"-1" (indicating the user wants to clear the log directory, but not archive the logs), this method
constructs a utility to clean the log directory.
- constructCleanDir(String) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Construct utility for cleaning the specified directory.
- constructFromEacStub(HostType) -
Method in class com.endeca.soleng.eac.toolkit.host.Host
- Populates the fields in this object from associated values in the HostType
WSDL stub object.
- Controller - Class in com.endeca.soleng.eac.toolkit
- This class handles provisioning and exposes an interface for interaction
with the components and scripts in an EAC application.
- Controller() -
Constructor for class com.endeca.soleng.eac.toolkit.Controller
-
- CopyUtility - Class in com.endeca.soleng.eac.toolkit.utility
- CopyUtility extends the Utility object, exposing the fields that
make up a copy utility invocation and convenience initializer methods
that take all of the arguments required to define a copy utility.
- CopyUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.CopyUtility
- Default (inherited) constructor.
- CopyUtility() -
Constructor for class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- CreateDirUtility - Class in com.endeca.soleng.eac.toolkit.utility.perl
- Utility used to create a directory.
- CreateDirUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.perl.CreateDirUtility
- Default (inherited) constructor.
- CustomComponent - Class in com.endeca.soleng.eac.toolkit.component
- Custom components are "provisioned" like a component in the app configuration, but
provisioning is stored as a set of custom properties (key value pairs) on the
provisioned host on which this component runs.
- CustomComponent() -
Constructor for class com.endeca.soleng.eac.toolkit.component.CustomComponent
- Custom component constructor.
- cycle() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
- Cycles the server component.
D
- dataPrefix -
Variable in class com.endeca.soleng.eac.toolkit.base.EacElement
- Data prefix to use for all elements.
- DgraphConfigUpdateUtility - Class in com.endeca.soleng.eac.toolkit.utility.wget
- Utility used to trigger a dgraph configuration update via a wget
call to the Dgraphs config?op=update administrative URL.
- DgraphConfigUpdateUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.wget.DgraphConfigUpdateUtility
- Default (inherited) constructor.
- DgraphFlushCacheUtility - Class in com.endeca.soleng.eac.toolkit.utility.wget
- Utility used to trigger a dgraph dynamic cache flush via a wget
call to the Dgraphs admin?op=flush administrative URL.
- DgraphFlushCacheUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.wget.DgraphFlushCacheUtility
- Default (inherited) constructor.
- DgraphReloadServicesUtility - Class in com.endeca.soleng.eac.toolkit.utility.wget
- Utility used to trigger reloading of XQuery modules via a wget
call to the Dgraph's admin?op=reload-services administrative URL.
- DgraphReloadServicesUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.wget.DgraphReloadServicesUtility
- Default (inherited) constructor.
- DgraphUpdateUtility - Class in com.endeca.soleng.eac.toolkit.utility.wget
- Utility used to trigger a dgraph partial update via a wget
call to the Dgraphs admin?op=update administrative URL.
- DgraphUpdateUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.wget.DgraphUpdateUtility
- Default (inherited) constructor.
- dirContainsFiles(String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.FileUtility
- Tests whether there are any files in a directory.
- dirExists(String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.FileUtility
- Tests whether a specified directory exists.
E
- EAC_MAX_TOKEN_LENGTH -
Static variable in class com.endeca.soleng.eac.toolkit.utility.Utility
- Maximum token length that the EAC can handle
- EacCommunicationException - Exception in com.endeca.soleng.eac.toolkit.exception
- This exception captures various error conditions encountered during
communication with the EAC or the EAC's communication with an agent.
- EacCommunicationException() -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
- Generic constructor.
- EacCommunicationException(String) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
- Constructor that takes an error message as input.
- EacCommunicationException(Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
- Constructor that takes a nested Throwable as input.
- EacCommunicationException(String, Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
- Constructor that takes an error message and a nested Throwable as input.
- EacComponentControlException - Exception in com.endeca.soleng.eac.toolkit.exception
- This exception captures various error conditions associated with failures
in controlling EAC components.
- EacComponentControlException() -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
- Generic constructor.
- EacComponentControlException(String) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
- Constructor that takes an error message as input.
- EacComponentControlException(Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
- Constructor that takes a nested Throwable as input.
- EacComponentControlException(String, Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
- Constructor that takes an error message and a nested Throwable as input.
- EacElement - Class in com.endeca.soleng.eac.toolkit.base
- Root object from which all EAC objects extend.
- EacElement() -
Constructor for class com.endeca.soleng.eac.toolkit.base.EacElement
-
- eacHost -
Variable in class com.endeca.soleng.eac.toolkit.base.EacElement
- Hostname of the EAC central server
- eacPort -
Variable in class com.endeca.soleng.eac.toolkit.base.EacElement
- Port on which the EAC central server is listening
- EacProvisioningException - Exception in com.endeca.soleng.eac.toolkit.exception
- This exception captures various error conditions associated with failures
in provisionging EAC components, hosts or applications.
- EacProvisioningException() -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacProvisioningException
- Generic constructor.
- EacProvisioningException(String) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacProvisioningException
- Constructor that takes an error message as input.
- EacProvisioningException(Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacProvisioningException
- Constructor that takes a nested Throwable as input.
- EacProvisioningException(String, Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacProvisioningException
- Constructor that takes an error message and a nested Throwable as input.
- EacSynchronizationException - Exception in com.endeca.soleng.eac.toolkit.exception
- This exception captures various error conditions associated with failures
in controlling EAC components.
- EacSynchronizationException() -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacSynchronizationException
- Generic constructor.
- EacSynchronizationException(String) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacSynchronizationException
- Constructor that takes an error message as input.
- EacSynchronizationException(Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacSynchronizationException
- Constructor that takes a nested Throwable as input.
- EacSynchronizationException(String, Throwable) -
Constructor for exception com.endeca.soleng.eac.toolkit.exception.EacSynchronizationException
- Constructor that takes an error message and a nested Throwable as input.
- elementId -
Variable in class com.endeca.soleng.eac.toolkit.base.EacElement
- ID of the EAC object.
- ENDECA_CONF -
Static variable in class com.endeca.soleng.eac.toolkit.utility.Utility
- Holds the ENDECA_CONF environment variable
- execute() -
Method in class com.endeca.soleng.eac.toolkit.Controller
- Main controller method.
F
- fileExists(String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.FileUtility
- Tests whether a specified file exists in a directory.
- FileUtility - Class in com.endeca.soleng.eac.toolkit.utility
- FileUtility extends the Utility object, exposing methods that wrap the
utility web service's listDirectoryContents call.
- FileUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.FileUtility
- Default (inherited) constructor.
- FileUtility() -
Constructor for class com.endeca.soleng.eac.toolkit.utility.FileUtility
-
- format(LogRecord) -
Method in class com.endeca.soleng.eac.toolkit.logging.ConsoleFormatter
-
G
- getAbsolutePath(String, String) -
Static method in class com.endeca.soleng.eac.toolkit.utils.PathUtils
- Returns a string representation of the specified path, resolved against
the working directory, if it isn't absolute.
- GetAllFilesUtility - Class in com.endeca.soleng.eac.toolkit.utility.webstudio
- Utility used to download all instance configuration files from Web Studio,
by invoking the emgr_update action get_all_settings.
- GetAllFilesUtility(String, String, int, boolean, String) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.webstudio.GetAllFilesUtility
- Default (inherited) constructor.
- getAppConfigDocs() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- getAppContext() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- getAppDefinitionFromEac() -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
- Retrieves the application definition from the EAC.
- getAppName() -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Get the application name.
- getBeanShellInterpreter() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- getBeanShellScript() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- getCachedAppDefinition() -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
-
- getCommand() -
Method in class com.endeca.soleng.eac.toolkit.utility.ShellUtility
-
- getConfigOverrideDocs() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- getCustomDirectories() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getCustomDirectories() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- getCustomDirectories() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- getDataPrefix() -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
-
- getDest() -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- getDestHostId() -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- getDir() -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- getDir() -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
-
- getDir() -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CreateDirUtility
-
- getDir() -
Method in class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
-
- getDirContents(String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Retrieves the list of files found in the specified directory on the
specified host.
- getDirectory(String) -
Method in class com.endeca.soleng.eac.toolkit.host.Host
- Retrieves the value of the directory with the specified name from
the provisioned host.
- getDirProperties() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Retrieves a list of properties assumed to be custom directory definitions,
based on the convention that the property name ends with "dir" or "Dir."
- getEacHost() -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Gets the hostname of the EAC central server.
- getEacPort() -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Gets the port of the EAC central server.
- getElementId() -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
-
- getEmgrUpdateExecutable() -
Method in class com.endeca.soleng.eac.toolkit.utility.webstudio.WSUtility
-
- getFileNameFromPath(String) -
Static method in class com.endeca.soleng.eac.toolkit.utils.PathUtils
- Strips the directory path from a file or dir name, returning just
the trailing prefix/filename from a path.
- getHeldLocks() -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Gets a list of held locks.
- getHost() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getHost() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
- Constructs a host object by specifying a host ID that should be retrieved
from the EAC.
- getHost() -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
-
- getHost() -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CreateDirUtility
-
- getHostId() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getHostId() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- getHostId() -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- getHostId() -
Method in class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
-
- getHostId() -
Method in class com.endeca.soleng.eac.toolkit.utility.ShellUtility
-
- getHostName() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- getLockManager() -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
-
- getLogDir() -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Gets the logs directory.
- getLongPropertyValueOrDefault(String, long) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getMaxMissedStatusChecksAllowed() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getMaxMissedStatusChecksAllowed() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- getMaxWaitTimeSeconds() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getMaxWaitTimeSeconds() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- getMinWaitTimeSeconds() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getMinWaitTimeSeconds() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- getNonNullPositiveLongValueOrDefault(long, long) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- getNumBackups() -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- getNumIdleSecondsAfterStop() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- getNumLogBackups() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Retrieves the number of log archives configured as a property
in the app configuration.
- getNumMissedStatusChecks() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getNumMissedStatusChecks() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- getPerlBinary() -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.PerlUtility
-
- getPerlUtilityCmdsScript() -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.PerlUtilityCmdsUtility
-
- getPort() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- getPostStartupScript() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- getPreShutdownScript() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- getProperties() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getProperties() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- getProperties() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- getProperty(String) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Retrieves the value of the property with the specified name from
the provisioned component.
- getProperty(String) -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
- Retrieves a custom property with the specified name.
- getProperty(String) -
Method in class com.endeca.soleng.eac.toolkit.host.Host
- Retrieves the value of the property with the specified name from
the provisioned host.
- getProvisionedScriptCommand() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- getProvisioningPort() -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
- Retrieves the provisioning port that the application will use to send
provisioning commands to the EAC.
- getRequestedBean() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- getRequestedBeanName() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- getRequestedMethod() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- getRequestedMethodArgs() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- getRequestedMethodName() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- getShutdownTimeout() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- getSlowPollingIntervalMs() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getSlowPollingIntervalMs() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- getSrc() -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- getSrcHostId() -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- getStandardPollingIntervalMs() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- getStandardPollingIntervalMs() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- getStartupTimeout() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- getStatus() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Retrieves the status of the component.
- getStatus() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
- Retrieves the status of the script.
- getStatus() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Retrieves the status of the utility.
- getWgetBinary() -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.WgetUtility
-
- getWorkingDir() -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Gets the working directory.
- GetWSDgraphFilesUtility - Class in com.endeca.soleng.eac.toolkit.utility.webstudio
- Utility used to download dgraph configuration files from Web Studio,
by invoking the emgr_update action get_mdex_settings.
- GetWSDgraphFilesUtility(String, String, int, boolean, String) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.webstudio.GetWSDgraphFilesUtility
- Default (inherited) constructor.
- GetWSFilesUtility - Class in com.endeca.soleng.eac.toolkit.utility.webstudio
- Utility used to download Web Studio configuration files from Web Studio,
by invoking the emgr_update action get_ws_settings.
- GetWSFilesUtility(String, String, int, boolean, String) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.webstudio.GetWSFilesUtility
- Default (inherited) constructor.
H
- Host - Class in com.endeca.soleng.eac.toolkit.host
- This class represents a host provisioned in the EAC, implementing
provisioning methods.
- Host() -
Constructor for class com.endeca.soleng.eac.toolkit.host.Host
- Default constructor.
- Host(String, String, int, String, boolean, String, String) -
Constructor for class com.endeca.soleng.eac.toolkit.host.Host
- Constructor to initialize the host object from its EAC definition, by retrieving
the definition associated with the specified hostId.
I
- incrementMissedStatusQueries() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- incrementMissedStatusQueries() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- init(String, String, String, boolean, int) -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
- Backup initializer.
- init(String, String, String, String, String, boolean) -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
- Copy initializer.
- init(String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
- Convenience wrapper of init(host, dir, workingDir) that specifies
a null workingDir.
- init(String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
- CleanDir initializer.
- init(String, String, String, boolean) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
- CleanDir initializer.
- init(String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CreateDirUtility
- Convenience wrapper of init(host, dir, workingDir) that specifies
a null workingDir.
- init(String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CreateDirUtility
- CreateDir initializer.
- init(String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.LocalMoveUtility
- Convenience wrapper of init(host, src, dest, workingDir) that specifies
a null workingDir.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.LocalMoveUtility
- LocalMove initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.PerlInlineScriptUtility
- Perl Utility Command initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.PerlScriptUtility
- Perl script runner initializer.
- init(String, String, String, String[], String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.PerlScriptUtility
- Perl script runner initializer that takes an array of argument strings to pass
to the Perl script.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.PerlUtilityCmdsUtility
- Perl Utility Command initializer.
- init(String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.RemoveDirUtility
- Convenience wrapper of init(host, dir, workingDir) that specifies
a null workingDir.
- init(String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.RemoveDirUtility
- RemoveDir initializer.
- init(String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.RemoveFileUtility
- Convenience wrapper of init(host, path, workingDir) that specifies
a null workingDir.
- init(String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.RemoveFileUtility
- RemoveDir initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.RemoveFileUtility
- RemoveDir initializer that specifies a custom token.
- init(String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
- Rollback initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.ShellUtility
- Shell initializer.
- init(String, String, String, String, boolean, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.webstudio.GetAllFilesUtility
- Get All Web Studio files utility initializer.
- init(String, String, String, String, boolean, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.webstudio.GetWSDgraphFilesUtility
- Get Web Studio dgraph files utility initializer.
- init(String, String, String, String, boolean, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.webstudio.GetWSFilesUtility
- Get Web Studio files utility initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.webstudio.RemoveAllConfigUtility
- Get All Web Studio files utility initializer.
- init(String, String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.webstudio.SetInstanceConfigUtility
- Set Web Studio instance configuration utility initializer.
- init(String, String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.webstudio.SetPostForgeDimsUtility
- Set Web Studio post-forge dimensions utility initializer.
- init(String, String, String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.webstudio.WSUtility
- Web Studio command initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.DgraphConfigUpdateUtility
- Dgraph config update initializer.
- init(String, String, String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.DgraphConfigUpdateUtility
- Dgraph config update initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.DgraphFlushCacheUtility
- Dgraph cache flush initializer.
- init(String, String, String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.DgraphFlushCacheUtility
- Dgraph cache flush initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.DgraphReloadServicesUtility
- Dgraph reload services initializer.
- init(String, String, String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.DgraphReloadServicesUtility
- Dgraph update initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.DgraphUpdateUtility
- Dgraph update initializer.
- init(String, String, String, String, boolean, int) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.DgraphUpdateUtility
- Dgraph update initializer.
- init(String, String, String, String, boolean, int, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.DgraphUpdateUtility
- Dgraph update initializer.
- init(String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.LogServerRollUtility
- Dgraph update initializer.
- init(String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.WgetUtility
- Convenience wrapper of init(host, dir, workingDir) that specifies
a null workingDir.
- init(String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.WgetUtility
- Wget initializer.
- init(String, String, String, String, String) -
Method in class com.endeca.soleng.eac.toolkit.utility.wget.WgetUtility
- Wget initializer.
- initializeEacStub(ComponentType) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- initializeEacStub(RunBackupType) -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- initializeEacStub(RunFileCopyType) -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- initializeEacStub(RunRollbackType) -
Method in class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
-
- initializeEacStub(RunShellType) -
Method in class com.endeca.soleng.eac.toolkit.utility.ShellUtility
-
- initializeEacStub(RunUtilityType) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- instantiateEacStub() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- instantiateEacStub() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- invalidateCachedAppDefinition() -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
-
- IS_WINDOWS -
Static variable in class com.endeca.soleng.eac.toolkit.utility.Utility
- Are we running on a Windows system?
- isAbsolute(String) -
Static method in class com.endeca.soleng.eac.toolkit.utils.PathUtils
- Returns true if the specified path is absolute.
- isActive() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Returns true if the component is active (i.e.
- isActive() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
- Returns true if the script is active (i.e.
- isActive() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Returns true if the utility is active (i.e.
- isDefined() -
Method in class com.endeca.soleng.eac.toolkit.application.Application
- Checks whether the application is defined in the EAC.
- isDefined() -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
- Extending objects will implement this method, returning true if the
provisioned object's definition is set in the EAC.
- isDefined() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Checks whether the component is defined in the EAC.
- isDefined() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- isDefined() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
- Checks whether the host is defined in the EAC.
- isDefined() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- isDefinitionChanged() -
Method in class com.endeca.soleng.eac.toolkit.application.Application
- Returns true if the application definition has changed.
- isDefinitionChanged() -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
- Extending objects will implement this method, returning true if the
provisioned object's definition has changed in the EAC.
- isDefinitionChanged() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Compares the definition of the component in the EAC to the local definition.
- isDefinitionChanged() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- isDefinitionChanged() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
- Compares the definition of the host in the EAC to the local definition.
- isDefinitionChanged() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- isFailed() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Returns true if the component failed when it was run most recently.
- isFailed() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
- Returns true if the script failed when it was run most recently.
- isFailed() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Returns true if the utility failed when it was run most recently.
- isFlagSet(String) -
Method in class com.endeca.soleng.eac.toolkit.base.Synchronizable
- Test whether the specified flag is set in the EAC.
- isHelpRequested() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- isHotUpdateDefinitionChange() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Method to test whether a definition change requires stopping the component
or whether it can be performed as a "hot update." This implementation
assumes that the only hot update that's possible is a change to the
properties.
- isLockHeld(String) -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Determined whether the specified lock is held by this object.
- isMove() -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- isPrintStatusRequested() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- isRecursive() -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- isReleaseLocksOnFailure() -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
-
- isRemoveAppRequested() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- isRunning() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
- Returns true if the component is running.
- isSkipDefinitionRequested() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- isSkipTestingForFiles() -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
-
- isSkipTestingForFilesDuringCleanup() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Retrieves the boolean indicating whether directory cleanup should use the default
behavior of first testing for non-empty directory contents, or if that test
should be skipped.
- isSslEnabled() -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
-
- isStarting() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
- Returns true if the component is starting.
- isUpdateDefinitionRequested() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- isVersionRequested() -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
L
- listFlags() -
Method in class com.endeca.soleng.eac.toolkit.base.Synchronizable
- Retrieves a list of all flags set in the EAC for this application.
- LocalMoveUtility - Class in com.endeca.soleng.eac.toolkit.utility.perl
- Utility used to move files or directories locally.
- LocalMoveUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.perl.LocalMoveUtility
- Default (inherited) constructor.
- lockManager -
Variable in class com.endeca.soleng.eac.toolkit.base.EacElement
- Lock manager used by this object.
- LockManager - Class in com.endeca.soleng.eac.toolkit.base
- Lock Manager used to acquire, track and release locks.
- LockManager() -
Constructor for class com.endeca.soleng.eac.toolkit.base.LockManager
-
- logDir -
Variable in class com.endeca.soleng.eac.toolkit.base.EacElement
- Log directory, inherited by all EAC objects.
- LogServerRollUtility - Class in com.endeca.soleng.eac.toolkit.utility.wget
- Utility used to trigger a logserver "roll" via a wget call to the
logserver's /roll administrative URL.
- LogServerRollUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.wget.LogServerRollUtility
- Default (inherited) constructor.
M
- main(String[]) -
Static method in class com.endeca.soleng.eac.toolkit.Controller
- Main method invoked from the command line.
- maximumAllowedTokenLength() -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- maximumAllowedTokenLength() -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- maximumAllowedTokenLength() -
Method in class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
-
- maximumAllowedTokenLength() -
Method in class com.endeca.soleng.eac.toolkit.utility.ShellUtility
-
- maximumAllowedTokenLength() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
P
- PathUtils - Class in com.endeca.soleng.eac.toolkit.utils
- This class exposes static utility methods for manipulating, parsing and
interpreting paths.
- PathUtils() -
Constructor for class com.endeca.soleng.eac.toolkit.utils.PathUtils
-
- PerlInlineScriptUtility - Class in com.endeca.soleng.eac.toolkit.utility.perl
- Utility used to invoke an inline Perl script.
- PerlInlineScriptUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.perl.PerlInlineScriptUtility
- Default (inherited) constructor.
- PerlScriptUtility - Class in com.endeca.soleng.eac.toolkit.utility.perl
- Utility used to invoke a Perl script.
- PerlScriptUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.perl.PerlScriptUtility
- Default (inherited) constructor.
- PerlUtility - Class in com.endeca.soleng.eac.toolkit.utility.perl
- Abstract utility extended by utilities that execute Perl calls.
- PerlUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.perl.PerlUtility
- Default (inherited) constructor.
- PerlUtilityCmdsUtility - Class in com.endeca.soleng.eac.toolkit.utility.perl
- Utility used to invole utility_cmds.pl in the Endeca IAP installation.
- PerlUtilityCmdsUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.perl.PerlUtilityCmdsUtility
- Default (inherited) constructor.
- Provisionable - Class in com.endeca.soleng.eac.toolkit.base
- Object from which all provisioned EAC objects extend.
- Provisionable() -
Constructor for class com.endeca.soleng.eac.toolkit.base.Provisionable
-
R
- RelativePathFileHandler - Class in com.endeca.soleng.eac.toolkit.logging
- This class extends
FileHandler
, allowing the use of a
relative path for logging. - RelativePathFileHandler() -
Constructor for class com.endeca.soleng.eac.toolkit.logging.RelativePathFileHandler
-
- releaseHeldLocks() -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Releases all locks held by this object.
- releaseLock(String) -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Releases a lock.
- releaseLock() -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Convenience wrapper that calls releaseLock(String) with a null string.
- RemoveAllConfigUtility - Class in com.endeca.soleng.eac.toolkit.utility.webstudio
- Utility used to download all instance configuration files from Web Studio,
by invoking the emgr_update action get_all_settings.
- RemoveAllConfigUtility(String, String, int, boolean, String) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.webstudio.RemoveAllConfigUtility
- Default (inherited) constructor.
- removeDefinition() -
Method in class com.endeca.soleng.eac.toolkit.application.Application
- Removes the application from the EAC, forcing the termination and removal
of components.
- removeDefinition() -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
- Extending objects will implement this method to remove the definition
of the provisioned object from the EAC.
- removeDefinition() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Removes the EAC provisioning of this component.
- removeDefinition() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- removeDefinition() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
- Removes the EAC provisioning of this host.
- removeDefinition() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- RemoveDirUtility - Class in com.endeca.soleng.eac.toolkit.utility.perl
- Utility used to remove a directory.
- RemoveDirUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.perl.RemoveDirUtility
- Default (inherited) constructor.
- RemoveFileUtility - Class in com.endeca.soleng.eac.toolkit.utility.perl
- Utility used to remove a file or files that match a specified path.
- RemoveFileUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.perl.RemoveFileUtility
- Default (inherited) constructor.
- removeFlag(String) -
Method in class com.endeca.soleng.eac.toolkit.base.Synchronizable
- Removes a flag in the EAC.
- removeHeldLock(String) -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Removes a lock from the list of held locks.
- RollbackUtility - Class in com.endeca.soleng.eac.toolkit.utility
- RollbackUtility extends the Utility object, exposing the fields that
make up a rollback utility invocation and convenience initializer methods
that take all of the arguments required to define a rollback utility.
- RollbackUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
- Default (inherited) constructor.
- RollbackUtility() -
Constructor for class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
-
- run() -
Method in class com.endeca.soleng.eac.toolkit.component.BatchComponent
- Runs the batch component synchronously.
- run() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
- Main execution method for the script.
- run() -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
-
- run() -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CreateDirUtility
-
- run() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Runs the utility synchronously.
- runBeanShellScript(String) -
Method in class com.endeca.soleng.eac.toolkit.script.Script
- Invokes the specified String as a BeanShell script.
- runInParallel(List<BatchComponent>) -
Static method in class com.endeca.soleng.eac.toolkit.component.BatchComponent
- Runs batch components in parallel.
- runInParallel(List<Utility>) -
Static method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Static method to run a set of utilities in parallel.
S
- Script - Class in com.endeca.soleng.eac.toolkit.script
- This class contains logic associated with implementing an EAC script.
- Script() -
Constructor for class com.endeca.soleng.eac.toolkit.script.Script
-
- scriptImplementation() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
- Extending objects will override this method with script logic.
- ServerComponent - Class in com.endeca.soleng.eac.toolkit.component
- ServerComponent extends component to expose utilities for running server
components (e.g.
- ServerComponent() -
Constructor for class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- setAppConfigDocs(List<String>) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setAppContext(GenericApplicationContext) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setAppName(String) -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Sets the application name.
- setBeanShellInterpreter(Interpreter) -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- setBeanShellScript(String) -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- setCachedAppDefinition(ApplicationType) -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
-
- setCommand(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.ShellUtility
-
- setConfigOverrideDocs(List<String>) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setCustomDirectories(Map<String, String>) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- setCustomDirectories(Map<String, String>) -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- setCustomDirectories(Map<String, String>) -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- setDataPrefix(String) -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
-
- setDefinition() -
Method in class com.endeca.soleng.eac.toolkit.application.Application
- Defines the (empty) application in the EAC.
- setDefinition() -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
- Extending objects will implement this method to add the definition
of the provisioned object to the EAC.
- setDefinition() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Sets the EAC provisioning of this component, building the definition
from the information in this object.
- setDefinition(ComponentType) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Sets the EAC provisioning of this component to the ComponentType WSDL stub
object passed as a parameter.
- setDefinition() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- setDefinition() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
- Sets the EAC provisioning of this host.
- setDefinition() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- setDest(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- setDestHostId(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- setDir(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- setDir(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
-
- setDir(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CreateDirUtility
-
- setDir(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
-
- setEacHost(String) -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Sets the hostname of the EAC central server.
- setEacPort(int) -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Sets the port of the EAC central server, verifying that the port is valid.
- setElementId(String) -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
-
- setElementId(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- setFlag(String) -
Method in class com.endeca.soleng.eac.toolkit.base.Synchronizable
- Sets a flag in the EAC.
- setHeldLocks(List<String>) -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
- Sets a list of held locks.
- setHelpRequested(boolean) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setHost(Host) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- setHost(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
-
- setHost(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CreateDirUtility
-
- setHostId(String) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- setHostId(String) -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- setHostId(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- setHostId(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.RollbackUtility
-
- setHostId(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.ShellUtility
-
- setHostName(String) -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- SetInstanceConfigUtility - Class in com.endeca.soleng.eac.toolkit.utility.webstudio
- Utility used to upload all instance configuration files to Web Studio,
by invoking the emgr_update action update_mgr_settings.
- SetInstanceConfigUtility(String, String, int, boolean, String) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.webstudio.SetInstanceConfigUtility
- Default (inherited) constructor.
- setLockManager(LockManager) -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
-
- setLogDir(String) -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Sets the logs directory.
- setMaxMissedStatusQueriesAllowed(long) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- setMaxWaitSeconds(long) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- setMinWaitSeconds(long) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- setMove(boolean) -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- setNumBackups(int) -
Method in class com.endeca.soleng.eac.toolkit.utility.BackupUtility
-
- setNumMissedStatusChecks(int) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- setNumMissedStatusChecks(int) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- setPollingIntervalMs(long) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- setPort(int) -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- SetPostForgeDimsUtility - Class in com.endeca.soleng.eac.toolkit.utility.webstudio
- Utility used to upload post-Forge dimensions to Web Studio,
by invoking the emgr_update action set_post_forge_dims.
- SetPostForgeDimsUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.webstudio.SetPostForgeDimsUtility
- Default (inherited) constructor.
- setPostStartupScript(Script) -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- setPreShutdownScript(Script) -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- setPrintStatusRequested(boolean) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setProperties(Map<String, String>) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
-
- setProperties(Map<String, String>) -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- setProperties(Map<String, String>) -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- setProvisionedScriptCommand(String) -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- setRecursive(boolean) -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- setReleaseLocksOnFailure(boolean) -
Method in class com.endeca.soleng.eac.toolkit.base.LockManager
-
- setRemoveAppRequested(boolean) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setRequestedBean(Object) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setRequestedBeanName(String) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setRequestedMethod(Method) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setRequestedMethodArgs(String[]) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setRequestedMethodName(String) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setSkipDefinitionRequested(boolean) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setSkipTestingForFiles(boolean) -
Method in class com.endeca.soleng.eac.toolkit.utility.perl.CleanDirUtility
-
- setSlowPollingIntervalMs(long) -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
-
- setSrc(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- setSrcHostId(String) -
Method in class com.endeca.soleng.eac.toolkit.utility.CopyUtility
-
- setSslEnabled(boolean) -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
-
- setStartupTimeout(long) -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- setUpdateDefinitionRequested(boolean) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setVersionRequested(boolean) -
Method in class com.endeca.soleng.eac.toolkit.Controller
-
- setWorkingDir(String) -
Method in class com.endeca.soleng.eac.toolkit.base.EacElement
- Sets the working directory.
- ShellUtility - Class in com.endeca.soleng.eac.toolkit.utility
- ShellUtility extends the Utility object, exposing the fields that
make up a shell utility invocation and convenience initializer methods
that take all of the arguments required to define a shell utility.
- ShellUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.ShellUtility
- Default (inherited) constructor.
- ShellUtility() -
Constructor for class com.endeca.soleng.eac.toolkit.utility.ShellUtility
-
- splitRootFromAbsolutePath(String) -
Static method in class com.endeca.soleng.eac.toolkit.utils.PathUtils
- Splits an absolute path into an absolute root directory and a path
relative to that root directory.
- sslEnabled -
Variable in class com.endeca.soleng.eac.toolkit.base.EacElement
- Indicates whether SSL should be used for EAC communication.
- start() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Starts the component.
- start() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- start() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Starts the utility.
- startAsynchronously() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
- Starts the component asynchronously, without testing its status after
sending the start command.
- startInParallel(List<ServerComponent>) -
Static method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
- Starts server components in parallel.
- stop() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Stops the component.
- stop() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
-
- stop() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Stops the utility.
- stopAsynchronously() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
- Stops the component asynchronously, without testing its status after
sending the stop command.
- stopInParallel(List<ServerComponent>) -
Static method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
- Stop server components in parallel.
- stripFilenameFromPath(String) -
Static method in class com.endeca.soleng.eac.toolkit.utils.PathUtils
- Removes the trailing prefix/filename from a path, returning
just the directory path.
- Synchronizable - Class in com.endeca.soleng.eac.toolkit.base
- Object from which all synchronized EAC objects extend.
- Synchronizable() -
Constructor for class com.endeca.soleng.eac.toolkit.base.Synchronizable
-
U
- updateDefinition() -
Method in class com.endeca.soleng.eac.toolkit.application.Application
- Updates the application definition.
- updateDefinition() -
Method in class com.endeca.soleng.eac.toolkit.base.Provisionable
- Extending objects will implement this method to update the definition
of the provisioned object in the EAC.
- updateDefinition() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Updates the EAC provisioning of this component.
- updateDefinition() -
Method in class com.endeca.soleng.eac.toolkit.component.CustomComponent
-
- updateDefinition() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
- Updates the EAC provisioning of this host.
- updateDefinition() -
Method in class com.endeca.soleng.eac.toolkit.script.Script
-
- updateEacDefinition() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Updates the EAC provisioning of this component, building the definition from
this object.
- updateEacDefinition(ComponentType) -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Updates the EAC provisioning of this component with the specified component
type.
- updateEacDefinition() -
Method in class com.endeca.soleng.eac.toolkit.host.Host
-
- Utility - Class in com.endeca.soleng.eac.toolkit.utility
- The Utility class is the base class from which all utility implementations
extend.
- Utility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.Utility
- Default constructor.
- Utility() -
Constructor for class com.endeca.soleng.eac.toolkit.utility.Utility
- Empty constructor, for convenience in using utilities as beans.
W
- waitForFinished() -
Method in class com.endeca.soleng.eac.toolkit.component.Component
- Waits for the component to finish, by polling for its status every second,
until the maximum wait time has elapsed.
- waitForFinished() -
Method in class com.endeca.soleng.eac.toolkit.utility.Utility
- Waits for the utility to finish, by polling for its status every second,
until the maximum wait time has elapsed.
- waitForFlagSet(String, long) -
Method in class com.endeca.soleng.eac.toolkit.base.Synchronizable
- Polls, waiting for the specified flag to be set.
- waitForStarted() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
- Waits for the component to start, by polling for its status every second,
until the startup timeout has elapsed.
- waitForStopped() -
Method in class com.endeca.soleng.eac.toolkit.component.ServerComponent
- Waits for the component to stop, by polling for its status every second,
until the stop timeout has elapsed.
- WgetUtility - Class in com.endeca.soleng.eac.toolkit.utility.wget
- Utility used to execute a wget call to a URL.
- WgetUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.wget.WgetUtility
- Default (inherited) constructor.
- WINDOWS_MAX_PATH_LENGTH -
Static variable in class com.endeca.soleng.eac.toolkit.utility.Utility
- Maximum absolute path allowed under the Windows filesystem
- workingDir -
Variable in class com.endeca.soleng.eac.toolkit.base.EacElement
- Working directory, inherited by all EAC objects.
- WSUtility - Class in com.endeca.soleng.eac.toolkit.utility.webstudio
- Utility used to interact with Web Studio via calls to emgr_update.
- WSUtility(String, String, int, boolean) -
Constructor for class com.endeca.soleng.eac.toolkit.utility.webstudio.WSUtility
- Default (inherited) constructor.
A B C D E F G H I L M P R S U W
Copyright © 2011 Endeca Technologies, Inc. All Rights Reserved.
@VERSION
PRODUCT: EAC Toolkit (eacToolkit)
VERSION: 3.2.1
BUILD: NONE
ARCH_OS: n/a
DATE: 2011-11-10T16:21:05-0500