Configuration (ATG Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

atg.search.routing
Class Configuration

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.search.routing.Configuration

All Implemented Interfaces:: atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class Configuration
extends GenericService
extends GenericService

Configuration for Routing components

Field Summary
`static java.lang.String`	`CLASS_VERSION` Class version string

Fields inherited from class atg.nucleus.GenericService
`SERVICE_INFO_KEY`

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging
`DEFAULT_LOG_TRACE_STATUS`

Fields inherited from interface atg.nucleus.logging.ApplicationLogging
`DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS`

Constructor Summary
`Configuration()`

Method Summary
`java.lang.String`	`getAEConfigXmlFileName()` Gets the name of the engine's config file, by default "AEConfig.xml"
`java.lang.String`	`getAEConfigXmlTemplateFileName()` Gets the name of the engine's AEConfig template XML file, used for generating the config file if missing.
`atg.search.routing.SearchEngineArbiterService.ArbiterType`	`getArbiterType()` Returns the engine arbiter type.
`java.lang.String`	`getCleanPhysicalPartitionFile()` Returns the file name of the clean physical partition.
`java.lang.String`	`getCleanPhysicalPartitionPath()` Returns the full path to the clean physical partition file.
`java.lang.String`	`getCompressedIndexExtension()` Returns the extension of compressed index files, default is "gz"
`int`	`getConnectTimeoutMs()` Gets the timeout in ms for non-multiplexed search and indexing for connecting to an engine prior to searching/indexing.
`java.lang.String`	`getDefaultIndexFilenameFragment()` Gets the filename fragment looked for during cleanup.
`int`	`getDefaultLaunchServicePort()` Returns the default RMI port for remote machines running launching service.
`int`	`getDefaultMaximumSearchEngines()` Returns default max number of search engines run by an environment on a given machine.
`int`	`getDefaultNumberOfDaysPerShard()` Returns the default number of days per shard.
`int`	`getDefaultNumberOfShards()` Returns the default number of shards.
`int`	`getDefaultPhysicalPartitionCount()` Returns the number of physical partitions to start with in a fresh logical partition for estimation.
`java.lang.String`	`getDefaultRootIndexPath()` Gets the default index directory for engines' local files.
`int`	`getDefaultSearchEngineEndPort()` Returns the default end port for search engines.
`int`	`getDefaultSearchEngineStartPort()` Returns the default start port for search engines.
`java.lang.String`	`getDefaultStorageFilenameFragment()` Gets the filename fragment looked for during cleanup.
`java.io.File`	`getDeferredWorkRoot()` The deferred work is a bunch of temporary files written during estimation for indexing.
`java.io.File`	`getDeployShare()` Returns the deploy share directory, the location for master copies of index files.
`java.io.File`	`getEngineActivityPath()` Location of all logged files for all request types.
`java.io.File`	`getEngineDir()` Returns the base SearchEngine directory.
`java.lang.String`	`getEngineLogLevel()` Gets engine log level, one of E\|W\|I\|D\|X, for error, warning, info, debug, or disabled.
`java.lang.String[]`	`getEngineParams()` Returns Search Engine parameters, starting with the executable name.
`java.lang.String`	`getEngineVersion()` Gets the explicitly set engine version directory name
`double`	`getFullnessOfRecommendedPartitions()` Returns the ideal proportion of maximum physical partition size to be used when calculating the estimated number of physical partitions.
`java.lang.String[]`	`getIgnoreErrorCodeList()` A list of response error codes that should not cause a warning to be logged
`int`	`getIndexingReadTimeoutMs()` Read timeouts for all indexing requests.
`int`	`getInitialDeploymentTimeoutPerLPMs()` Gets Initial Deployment timeout for one logical partition.
`int`	`getInitialRequestsToTrack()` Returns the number of initial requests that are saved for a given engine.
`java.util.Map`	`getOsNameToExecutableExtension()` Gets a map from the value of "os.name" property to the executable extension.
`java.lang.String`	`getOsVersionDelim()` Returns the deploy share directory, the location for master copies of index files.
`java.util.Map`	`getOsVersionToSubDir()` Gets the mapping from OS version to engine subdirectory.
`int`	`getReadTimeoutMs()` When reads timeout for all search and non-indexing requests.
`int`	`getRecentRequestsToTrack()` Gets the number of recent requests that are saved for a given engine.
`int`	`getServerIdPort()` Returns the port used for the unique server Id.
`int`	`getSlowIndexRequestMs()` Returns the minimum response time for an indexing request to be considered slow for logging purposes
`int`	`getSlowSearchRequestMs()` Returns the minimum response time for a request to be considered slow for logging purposes
`atg.search.routing.SearchStrategy.StrategyType`	`getStrategyType()` Returns the search strategy type.
`java.lang.String`	`getUniqueServerId()`
`boolean`	`isEnableLogProblematicRequestResponse()` Whether to log problematic request and response to the warning log in addition to request/response files.
`void`	`isEnableLogProblematicRequestResponse(boolean pEnableLogProblematicRequestResponse)` Sets whether to log problematic request and response to the warning log in addition to request/response files.
`boolean`	`isEngineCleanupOnStartupEnabled()` Indicates whether all engine ports will be checked on startup.
`boolean`	`isIndexingServerEnabled()` Returns whether this instance of Routing is enabled as an indexing server.
`boolean`	`isLoggingAllRequests()` If true, logs ALL requests (and responses) to `getEngineActivityPath()`.
`boolean`	`isLoggingDeploy()` Indicates whether deploy requests are being logged
`boolean`	`isLoggingIndex()` Indicates whether index requests are being logged
`boolean`	`isLoggingLoad()` Indicates whether load requests are being logged
`boolean`	`isLoggingSearch()` Indicates whether search requests are being logged
`boolean`	`isLoggingSlowRequests()` Inidicates whether slow requests will be logged to the engine activity folder
`boolean`	`isLoggingStart()` Indicates whether start requests are being logged
`boolean`	`isLoggingStop()` Indicates whether stop requests are being logged
`boolean`	`isLoggingVerboseStyle()` Verbose style for request logging.
`boolean`	`isMonitorIgnoredEngines()` Indicates whether the Routing monitors ignored engines periodically.
`boolean`	`isMonitoringEnabled()` Indicates whether recent requests and responses should be saved for display in dyn/admin.
`boolean`	`isOptimisticIndexing()` Enable the optimistic indexing feature.
`boolean`	`isPreserveLocalhost()` Indicates whether Routing preserves `"localhost"` as a hostname.
`boolean`	`isRestartFailedEngines()` Indicates whether failed engines are restarted by `RoutingSystemService`'s scheduled service task.
`void`	`setAEConfigXmlFileName(java.lang.String pAEConfigXmlFileName)` Sets the name of the engine's config file, by default "AEConfig.xml".
`void`	`setAEConfigXmlTemplateFileName(java.lang.String pAEConfigXmlTemplateFileName)` Sets the name of the engine's AEConfig template XML file, used for generating the config file if missing.
`void`	`setArbiterType(atg.search.routing.SearchEngineArbiterService.ArbiterType pArbiterType)` Sets the type of engine arbiter to use.
`void`	`setCleanPhysicalPartitionFile(java.lang.String cleanPhysicalPartitionFile)` Sets the file name of the clean physical partition.
`void`	`setCleanPhysicalPartitionPath(java.lang.String pPath)` You must set this when you want to use remote engines for indexing.
`void`	`setCompressedIndexExtension(java.lang.String pCompressedIndexExtension)` Sets the extension of compressed index files, default is "gz"
`void`	`setConnectTimeoutMs(int pConnectTimeoutMs)` The timeout in milliseconds during non-multiplexed search and indexing for connecting to an engine prior to searching/indexing.
`void`	`setDefaultIndexFilenameFragment(java.lang.String defaultIndexFilenameFragment)` Sets the filename fragment looked for during cleanup.
`void`	`setDefaultLaunchServicePort(int defaultLaunchServicePort)` Sets the default RMI port for remote machines running launching service.
`void`	`setDefaultMaximumSearchEngines(int defaultMaximumSearchEngines)` Sets default max number of search engines run by an environment on a given machine.
`void`	`setDefaultNumberOfDaysPerShard(int pDefaultNumberOfDaysPerShard)` Sets the default number of days per shard.
`void`	`setDefaultNumberOfShards(int pDefaultNumberOfShards)` Sets the default number of shards.
`void`	`setDefaultPhysicalPartitionCount(int defaultPhysicalPartitionCount)` The is the number of initial physical partitions to use during estimation.
`void`	`setDefaultRootIndexPath(java.lang.String defaultRootIndexPath)` Sets the default index directory for engines' local files.
`void`	`setDefaultSearchEngineEndPort(int defaultSearchEngineEndPort)` Sets the default end port for search engines.
`void`	`setDefaultSearchEngineStartPort(int defaultSearchEngineStartPort)` Sets the default start port for search engines.
`void`	`setDefaultStorageFilenameFragment(java.lang.String defaultStorageFilenameFragment)` Sets the filename fragment looked for during cleanup.
`void`	`setDeferredWorkRoot(java.io.File deferredWorkRoot)` The deferred work is a bunch of temporary files written during estimation for indexing.
`void`	`setDeployShare(java.io.File pDeployShare)` Specify a deploy share.
`void`	`setEngineActivityPath(java.io.File pOutputPath)` Location of all logged files for all request types.
`void`	`setEngineCleanupOnStartupEnabled(boolean pEngineCleanupOnStartupEnabled)` Controls whether all engine ports will be checked on startup.
`void`	`setEngineDir(java.io.File pEngineDir)` Sets the SearchEngine's base directory on this machine.
`void`	`setEngineLogLevel(java.lang.String pEngineLogLevel)` Sets engine log level, one of `E\|W\|I\|D\|X`, for error, warning, info, debug, or disabled.
`void`	`setEngineParams(java.lang.String[] pEngineParams)` Sets Search Engine parameters, starting with the executable name.
`void`	`setEngineVersion(java.lang.String version)` Sets the engine version directory name.
`void`	`setFullnessOfRecommendedPartitions(double fullnessOfRecommendedPartitions)` Returns the ideal proportion of maximum physical partition size to be used when calculating the estimated number of physical partitions.
`void`	`setIgnoreErrorCodeList(java.lang.String[] pIgnoreErrorCodeList)` A list of response error codes that should not cause a warning to be logged
`void`	`setIndexingReadTimeoutMs(int pIndexingReadTimeoutMs)` Sets the timeout in milliseconds for indexing requests.
`void`	`setIndexingServerEnabled(boolean pIndexingServerEnabled)` Sets whether this instance of Routing is enabled as an indexing server.
`void`	`setInitialDeploymentTimeoutPerLPMs(int pInitialDeploymentTimeoutPerLPMs)` Sets Initial Deployment timeout for one logical partition.
`void`	`setInitialRequestsToTrack(int pInitialRequestsToTrack)` Sets the number of initial requests that are saved for a given engine.
`void`	`setLoggingAllRequests(boolean pLoggingAllRequests)` If true, logs all request types to `getEngineActivityPath()`.
`void`	`setLoggingDeploy(boolean isLogging)` If true, logs deploy requests to `getEngineActivityPath()`.
`void`	`setLoggingIndex(boolean isLogging)` If true, logs index requests to `getEngineActivityPath()`.
`void`	`setLoggingLoad(boolean isLogging)` If true, logs load requests to `getEngineActivityPath()`.
`void`	`setLoggingSearch(boolean isLogging)` If true, logs search requests to `getEngineActivityPath()`.
`void`	`setLoggingSlowRequests(boolean pLoggingSlowRequests)` Sets whether slow requests will be logged to the engine activity folder.
`void`	`setLoggingStart(boolean isLogging)` If true, logs start requests to `getEngineActivityPath()`.
`void`	`setLoggingStop(boolean isLogging)` If true, logs stop requests to `getEngineActivityPath()`.
`void`	`setLoggingVerboseStyle(boolean pLoggingVerboseStyle)` Verbose style for request logging.
`void`	`setMonitorIgnoredEngines(boolean pMonitorIgnoredEngines)` Controls whether the Routing monitors ignored engines periodically.
`void`	`setMonitoringEnabled(boolean monitoringEnabled)` Controls engine monitoring.
`void`	`setOptimisticIndexing(boolean pOptimistic)` Enable the optimistic indexing feature.
`void`	`setOsNameToExecutableExtension(java.util.Map pOsNameToExecutableExtension)` Set a map from the value of "os.name" property to the executable extension.
`void`	`setOsVersionDelim(java.lang.String pOsVersionDelim)` Specifies the delimiter used to separate version directories in the `getOsVersionToSubDir()` map.
`void`	`setOsVersionToSubDir(java.util.Map pOsVersionToSubDir)` Sets the mapping from OS version to engine subdirectory.
`void`	`setPreserveLocalhost(boolean pPreserveLocalhost)` This option allows one to enter `"localhost"` as a hostname in SearchAdmin and force Routing to preserve it.
`void`	`setReadTimeoutMs(int pReadTimeoutMs)` Timeout in milliseconds for all search and non-indexing requests.
`void`	`setRecentRequestsToTrack(int pRecentRequestsToTrack)` Sets the number of recent requests that are saved for a given engine.
`void`	`setRestartFailedEngines(boolean pRestartFailedEngines)` Controls whether failed engines are restarted by `RoutingSystemService`'s scheduled service task.
`void`	`setServerIdPort(int mServerIdPort)` Sets the port used for the unique server Id.
`void`	`setSlowIndexRequestMs(int pSlowSearchRequestMs)` Sets the minimum response time for an indexing request to be considered slow for logging purposes.
`void`	`setSlowSearchRequestMs(int pSlowSearchRequestMs)` Sets the minimum response time for a request to be considered slow for logging purposes.
`void`	`setStrategyType(atg.search.routing.SearchStrategy.StrategyType pStrategyType)` Sets the type of search strategy to use.

Methods inherited from class atg.nucleus.GenericService
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
`vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Configuration

public Configuration()

Method Detail

setOptimisticIndexing

public void setOptimisticIndexing(boolean pOptimistic)

Enable the optimistic indexing feature. Optimistic Indexing means index concurrently with document generation. This should increase indexing performance by running estimation only when necessary. If the indexed content exceeds the size of the current number of partitions, the indexing will run estimation and re-index from the deferred content (pre-Dupont behaviour). Otherwise it will index during content generation.

isOptimisticIndexing

public boolean isOptimisticIndexing()

getUniqueServerId

public java.lang.String getUniqueServerId()

Returns:

isLoggingSlowRequests

public boolean isLoggingSlowRequests()

Inidicates whether slow requests will be logged to the engine activity folder

Returns:: whether slow requests will be logged to the engine activity folder
See Also:: setSlowSearchRequestMs(int), setSlowIndexRequestMs(int)

setLoggingSlowRequests

public void setLoggingSlowRequests(boolean pLoggingSlowRequests)

Sets whether slow requests will be logged to the engine activity folder.

Parameters:: pLoggingSlowRequests - whether slow requests will be logged to the engine activity folder
See Also:: setSlowSearchRequestMs(int), setSlowIndexRequestMs(int)

getSlowSearchRequestMs

public int getSlowSearchRequestMs()

Returns the minimum response time for a request to be considered slow for logging purposes

Returns:: the minimum response time for a request to be considered slow for logging purposes
See Also:: isLoggingSlowRequests()

setSlowSearchRequestMs

public void setSlowSearchRequestMs(int pSlowSearchRequestMs)

Sets the minimum response time for a request to be considered slow for logging purposes. Ignored if isLoggingSlowRequests() returns false.

Parameters:: pSlowSearchRequestMs - the minimum response time for a request to be considered slow for logging purposes
See Also:: isLoggingSlowRequests ()

getSlowIndexRequestMs

public int getSlowIndexRequestMs()

Returns the minimum response time for an indexing request to be considered slow for logging purposes

Returns:: the minimum response time for an indexing request to be considered slow for logging purposes
See Also:: isLoggingSlowRequests()

setSlowIndexRequestMs

public void setSlowIndexRequestMs(int pSlowSearchRequestMs)

Sets the minimum response time for an indexing request to be considered slow for logging purposes. Ignored if isLoggingSlowRequests() returns false.

Parameters:: pSlowSearchRequestMs - the minimum response time for a request to be considered slow for logging purposes
See Also:: isLoggingSlowRequests ()

isIndexingServerEnabled

public boolean isIndexingServerEnabled()

Returns whether this instance of Routing is enabled as an indexing server. This must be enabled for the instance to perform indexing and deployment.

Returns:: whether this instance of Routing is enabled as an indexing server

setIndexingServerEnabled

public void setIndexingServerEnabled(boolean pIndexingServerEnabled)

Sets whether this instance of Routing is enabled as an indexing server. This must be enabled for the instance to perform indexing and deployment. Enable this on instances where you will be using Routing for indexing and deployment. Generally this should only be enabled on one instance of Routing, specifically the one running SearchAdmin or Live indexing. If it is disabled, this Routing instance will not be able to perform index deployments. It is disabled by default.

Parameters:: pIndexingServerEnabled - whether this instance of Routing is enabled as an indexing server

setDeployShare

public void setDeployShare(java.io.File pDeployShare)

Specify a deploy share. This should be configured manually. The deployShare is the destination for the master copies of physical partitions. SearchEngines will copy their own copies of index files from this location, so it needs to be accessible from all machines. If (and ONLY if) everything is local, a local absolute path will work fine; otherwise it needs to be visible on the network. If the path is local and does not exist, it will be created provided only one directory level is missing.

Parameters:: pDeployShare - the deploy share directory, the location for master copies of index files

getDeployShare

public java.io.File getDeployShare()

Returns the deploy share directory, the location for master copies of index files. See setDeployShare(java.io.File) for details.

Returns:: the deploy share directory, the location for master copies of index files

getEngineDir

public java.io.File getEngineDir()

Returns the base SearchEngine directory. See setEngineDir(java.io.File) for details.

Returns:: the base SearchEngine directory

setEngineDir

public void setEngineDir(java.io.File pEngineDir)

Sets the SearchEngine's base directory on this machine. This is not the full path. Routing constructs the full path to the engine as follows. Routing uses two user-configured properties (in **):

full path = **engineDir** / **versionForCurrentPlatform** / bin

where versionForCurrentPlatform =

a) engineVersion, if explicitly configured via setEngineVersion(String)

b) "os.name-os.arch" entry in osVersionToSubDir map, see setOsVersionToSubDir(java.util.Map)

Example for a 64-bit Linux server:

engineDir might resolve to /home/ATG/ATG9.1/Search9.1/SearchEngine.
engineVersion is generally not set, so Routing looks up the JVM system properties os.name and os.arch, which give "Linux" and "amd64".
osVersionToSubDir maps "Linux-amd64" to the engine version "x86-linux64", so this is the value of versionForCurrentPlatform.

Thus, the binary is located in:

engineDir / versionForCurrentPlatform / bin

/home/ATG/ATG9.1/Search9.1/SearchEngine / x86-linux64 / bin

To achieve this manually without the map and module resource reference, set:

engineDir=/home/ATG/ATG9.1/Search9.1/SearchEngine
engineVersion=x86-linux64

This component only runs in Routing, but many of its properties are automatically provided to remote standalone search engine launchers. These launchers are very similar to the launcher embedded within Routing, but they are standalone. The lists below explain which properties are used only here, and which are also provided to remote launchers.

setEngineDir(java.io.File) : only applies here; remote launcher has its own
setEngineVersion(String) : only applies here; remote launcher has its own

Everything else applies locally and remotely, because Routing passes them to the remote launcher:

setEngineLogLevel(String) : passed to remote launcher
setEngineParams(String[]) : passed to remote launcher
setOsVersionToSubDir(java.util.Map) : passed to remote launcher
setDefaultStorageFilenameFragment(String) : passed to remote launcher
setDefaultIndexFilenameFragment(String) : passed to remote launcher
setAEConfigXmlFileName(String) : passed to remote launcher
setAEConfigXmlTemplateFileName(String) : passed to remote launcher
setOsNameToExecutableExtension(java.util.Map) : passed to remote launcher

Parameters:: pEngineDir - the SearchEngine's base directory on this machine

setEngineLogLevel

public void setEngineLogLevel(java.lang.String pEngineLogLevel)

Sets engine log level, one of E|W|I|D|X, for error, warning, info, debug, or disabled. Default is I. D is verbose, but slow. X is not recommended, since it makes troubleshooting very hard.

Parameters:: pEngineLogLevel - engine log level, one of E|W|I|D|X, for error, warning, info, debug, or disabled. Default is I. D is verbose, but slow.

getEngineLogLevel

public java.lang.String getEngineLogLevel()

Gets engine log level, one of E|W|I|D|X, for error, warning, info, debug, or disabled. Default is I.

Returns:: engine log level, one of E|W|I|D|X, for error, warning, info, debug, or disabled. Default is I.

isLoggingVerboseStyle

public boolean isLoggingVerboseStyle()

Verbose style for request logging. If true, requests/responses are output in encoded (the 'raw' files, if available) and decoded forms, along with engine information and a callstack. Disabling this usually cuts the file count by about half. The files are written to getEngineActivityPath().

Returns:: whether engine activity logging will be verbose, or terse. Verbose logging produces a callstack, extra files for raw requests and responses, and engine information.

setLoggingVerboseStyle

public void setLoggingVerboseStyle(boolean pLoggingVerboseStyle)

Parameters:: pLoggingVerboseStyle - whether engine activity logging will be verbose, or terse. Verbose logging produces a callstack, extra files for raw requests and responses, and engine information.

isLoggingAllRequests

public boolean isLoggingAllRequests()

If true, logs ALL requests (and responses) to getEngineActivityPath().

Returns:: true if all requests are being logged

setLoggingAllRequests

public void setLoggingAllRequests(boolean pLoggingAllRequests)

If true, logs all request types to getEngineActivityPath(). This will create a huge number of files on a busy site, and should usually only be used in production for brief periods. If only certain request types should be logged, leave this disabled and set the appropriate properties (listed below). This may log up to six or more files for every request. The number of files can be reduced somewhat by disabling verbose logging via setLoggingVerboseStyle(boolean).

Parameters:: pLoggingAllRequests - whether request types should be logged
See Also:: getEngineActivityPath(), setLoggingDeploy(boolean), setLoggingIndex(boolean), setLoggingLoad(boolean), setLoggingSearch(boolean), setLoggingStart(boolean), setLoggingStop(boolean)

setLoggingSearch

public void setLoggingSearch(boolean isLogging)

If true, logs search requests to getEngineActivityPath(). Generates a huge number of files. This should not be left enabled for very long if the site is under heavy load.

Parameters:: isLogging - whether to log search requests
See Also:: getEngineActivityPath(), setLoggingAllRequests(boolean)

isLoggingSearch

public boolean isLoggingSearch()

Indicates whether search requests are being logged

Returns:: whether search requests are being logged
See Also:: isLoggingAllRequests()

setLoggingIndex

public void setLoggingIndex(boolean isLogging)

If true, logs index requests to getEngineActivityPath().

Parameters:: isLogging - whether to log index requests
See Also:: getEngineActivityPath(), setLoggingAllRequests(boolean)

isLoggingIndex

public boolean isLoggingIndex()

Indicates whether index requests are being logged

Returns:: whether index requests are being logged
See Also:: isLoggingAllRequests()

setLoggingDeploy

public void setLoggingDeploy(boolean isLogging)

If true, logs deploy requests to getEngineActivityPath().

Parameters:: isLogging - whether to log deploy requests
See Also:: getEngineActivityPath(), setLoggingAllRequests(boolean)

isLoggingDeploy

public boolean isLoggingDeploy()

Indicates whether deploy requests are being logged

Returns:: whether deploy requests are being logged
See Also:: isLoggingAllRequests()

setLoggingStart

public void setLoggingStart(boolean isLogging)

If true, logs start requests to getEngineActivityPath().

Parameters:: isLogging - whether to log start requests
See Also:: getEngineActivityPath(), setLoggingAllRequests(boolean)

isLoggingStart

public boolean isLoggingStart()

Indicates whether start requests are being logged

Returns:: whether start requests are being logged
See Also:: isLoggingAllRequests()

setLoggingStop

public void setLoggingStop(boolean isLogging)

If true, logs stop requests to getEngineActivityPath().

Parameters:: isLogging - whether to log stop requests
See Also:: getEngineActivityPath(), setLoggingAllRequests(boolean)

isLoggingStop

public boolean isLoggingStop()

Indicates whether stop requests are being logged

Returns:: whether stop requests are being logged
See Also:: isLoggingAllRequests()

setLoggingLoad

public void setLoggingLoad(boolean isLogging)

If true, logs load requests to getEngineActivityPath().

Parameters:: isLogging - whether to log load requests
See Also:: getEngineActivityPath(), setLoggingAllRequests(boolean)

isLoggingLoad

public boolean isLoggingLoad()

Indicates whether load requests are being logged

Returns:: whether load requests are being logged
See Also:: isLoggingAllRequests()

getEngineActivityPath

public java.io.File getEngineActivityPath()

Returns:: output path for logged request/response XML and diagnostic files

setEngineActivityPath

public void setEngineActivityPath(java.io.File pOutputPath)

Location of all logged files for all request types. Bad requests and other request-related problems (such as failed merges) will also show up in here. Only requests that pass through this instance of Routing will be logged here. On a busy site, this directory will quickly get unmanageable if the logging settings are allowing too much logging. A single request produces 3 or more files, depending on isLoggingVerboseStyle().

Parameters:: pOutputPath - path for logged request/response XML and diagnostic files
See Also:: setLoggingVerboseStyle(boolean), setLoggingAllRequests(boolean), setLoggingDeploy(boolean), setLoggingIndex(boolean), setLoggingLoad(boolean), setLoggingSearch(boolean), setLoggingStart(boolean), setLoggingStop(boolean)

getStrategyType

public atg.search.routing.SearchStrategy.StrategyType getStrategyType()

Returns the search strategy type.

Returns:: the search strategy type

setStrategyType

public void setStrategyType(atg.search.routing.SearchStrategy.StrategyType pStrategyType)

Sets the type of search strategy to use. The options are multiplexed or serialized. Multiplexed is recommended for multi-partition indexes, and is the default. Serialized is automatically selected for single-partition indexes, even if this is set to multiplexed.

Parameters:: pStrategyType - the search strategy type

getArbiterType

public atg.search.routing.SearchEngineArbiterService.ArbiterType getArbiterType()

Returns the engine arbiter type.

Returns:: the engine arbiter type

setArbiterType

public void setArbiterType(atg.search.routing.SearchEngineArbiterService.ArbiterType pArbiterType)

Sets the type of engine arbiter to use. The choices are load or random. The load arbiter distributes load evenly across engines, while the random arbiter distributes requests evenly across engines. The load arbiter requires isMonitoringEnabled() to be true.

Parameters:: pArbiterType - the engine arbiter type

isMonitoringEnabled

public boolean isMonitoringEnabled()

Indicates whether recent requests and responses should be saved for display in dyn/admin. This also enables performance statistics.

Returns:: whether monitoring is enabled
See Also:: getInitialRequestsToTrack(), getRecentRequestsToTrack()

setMonitoringEnabled

public void setMonitoringEnabled(boolean monitoringEnabled)

Controls engine monitoring. Engine monitoring enables gathering of performance statistics for internal use and for viewing in SearchEngineService in dyn/admin. It is required if the load arbiter is being used (see setArbiterType(atg.search.routing.SearchEngineArbiterService.ArbiterType).

As part of monitoring, recent requests are tracked and are viewable in SearchEngineService. The first getInitialRequestsToTrack() requests are preserved and are always viewable, and the most recent getRecentRequestsToTrack() requests are saved using a circular buffer.

Parameters:: monitoringEnabled - whether monitoring is enabled

getConnectTimeoutMs

public int getConnectTimeoutMs()

Gets the timeout in ms for non-multiplexed search and indexing for connecting to an engine prior to searching/indexing.

Returns:: timeout in ms for connections to engines
See Also:: setConnectTimeoutMs(int)

setConnectTimeoutMs

public void setConnectTimeoutMs(int pConnectTimeoutMs)

The timeout in milliseconds during non-multiplexed search and indexing for connecting to an engine prior to searching/indexing. If you are observing connect failures under heavy load (and you have a single-partition index or explicitly passed serialized to setStrategyType(atg.search.routing.SearchStrategy.StrategyType)), increase this value. But be careful, since the larger this value is, the longer it takes for Routing to recognize a network failure. For example, if the network plug is pulled at the remote engine's machine, and this is 20000, then it can take up to 20 seconds to failover to another engine. The default is 1000 milliseconds. Multiplexed search does not have a connect timeout.

Parameters:: pConnectTimeoutMs - timeout in ms for connects
See Also:: setConnectTimeoutMs(int)

getReadTimeoutMs

public int getReadTimeoutMs()

When reads timeout for all search and non-indexing requests.

Returns:: read timeout in milliseconds for all search and non-indexing requests
See Also:: getIndexingReadTimeoutMs()

setReadTimeoutMs

public void setReadTimeoutMs(int pReadTimeoutMs)

Timeout in milliseconds for all search and non-indexing requests. Setting this to a low value has the benefit of not keeping website visitors waiting when the engines are running slow or being unresponsive. Setting it too low, however, can result in a huge number of abandoned requests, because Routing stops waiting before the engine has a chance to finish. The default is 20,000 milliseconds.

Parameters:: pReadTimeoutMs - timeout in ms for reads
See Also:: setIndexingReadTimeoutMs(int)

getIndexingReadTimeoutMs

public int getIndexingReadTimeoutMs()

Read timeouts for all indexing requests.

Returns:: timeout in ms to use for indexing requests
See Also:: getReadTimeoutMs()

setIndexingReadTimeoutMs

public void setIndexingReadTimeoutMs(int pIndexingReadTimeoutMs)

Sets the timeout in milliseconds for indexing requests. This should be much higher than for search commands (set by setReadTimeoutMs(int)), long enough to let the engine finish a long-running command like Topic Load. The default is 300,000 milliseconds (5 minutes).

Parameters:: pIndexingReadTimeoutMs - timeout in ms to use for indexing requests
See Also:: setReadTimeoutMs(int)

getInitialRequestsToTrack

public int getInitialRequestsToTrack()

Returns the number of initial requests that are saved for a given engine. This is only applicable when isMonitoringEnabled() is true. The requests are viewable in dyn/admin in SearchEngineService.

Returns:: number of initial requests that are saved for a given engine

setInitialRequestsToTrack

public void setInitialRequestsToTrack(int pInitialRequestsToTrack)

Sets the number of initial requests that are saved for a given engine. This is only applicable when isMonitoringEnabled() is true. The requests are viewable in dyn/admin in SearchEngineService.

Parameters:: pInitialRequestsToTrack - number of initial requests that are saved for a given engine

getRecentRequestsToTrack

public int getRecentRequestsToTrack()

Gets the number of recent requests that are saved for a given engine. This is only applicable when isMonitoringEnabled() is true. The requests are viewable in dyn/admin in SearchEngineService.

Returns:: number of recent requests that are saved for a given engine

setRecentRequestsToTrack

public void setRecentRequestsToTrack(int pRecentRequestsToTrack)

Sets the number of recent requests that are saved for a given engine. This is only applicable when isMonitoringEnabled() is true. The requests are viewable in dyn/admin in SearchEngineService.

Parameters:: pRecentRequestsToTrack - number of recent requests that are saved for a given engine

isMonitorIgnoredEngines

public boolean isMonitorIgnoredEngines()

Indicates whether the Routing monitors ignored engines periodically. See RoutingSystemService for the schedule. If this is disabled, an ignored engine will never be returned to service (unless the app server is restarted). This property can be changed without restarting the app server or Routing.

Returns:: true if ignored engines are monitored

setMonitorIgnoredEngines

public void setMonitorIgnoredEngines(boolean pMonitorIgnoredEngines)

Controls whether the Routing monitors ignored engines periodically. Engines are ignored when they are unresponsive and it is not possible for Routing to determine the engine's state (see setRestartFailedEngines(boolean) for a description of what happens when Routing can determine the state). If monitoring is enabled, Routing will return ignored engines to service when they become accessible. See RoutingSystemService for the monitoring schedule. If this is disabled, an ignored engine that has recovered will never be returned to service (unless the app server is restarted). This property can be changed without restarting the app server or Routing.

Parameters:: pMonitorIgnoredEngines - if true, ignored engines are monitored

isRestartFailedEngines

public boolean isRestartFailedEngines()

Indicates whether failed engines are restarted by RoutingSystemService's scheduled service task. A failed engine is an engine that was initially ignored (see setMonitorIgnoredEngines(boolean)), but whose actual state Routing was able to ascertain, and was found to be dead. If this property is set to true, such engines will be restarted automatically. If set to false, failed engines will never be restarted, even after app server restart.

Returns:: true if failed engines should be restarted

setRestartFailedEngines

public void setRestartFailedEngines(boolean pRestartFailedEngines)

Controls whether failed engines are restarted by RoutingSystemService's scheduled service task. A failed engine is an engine that was initially ignored (see setMonitorIgnoredEngines(boolean)), but whose actual state Routing was able to ascertain, and was found to be dead. If this property is set to true, such engines will be restarted automatically. If set to false, failed engines will never be restarted, even after app server restart.

Parameters:: pRestartFailedEngines - if true, failed engines are restarted

isPreserveLocalhost

public boolean isPreserveLocalhost()

Indicates whether Routing preserves "localhost" as a hostname. See setPreserveLocalhost(boolean) for details.

Returns:: whether localhost (as a hostname) will be preserved

setPreserveLocalhost

public void setPreserveLocalhost(boolean pPreserveLocalhost)

This option allows one to enter "localhost" as a hostname in SearchAdmin and force Routing to preserve it. This option should only be enabled if one is copying a Routing repository to multiple machines for independent operation (say, in a classroom setting). This should never be set to true otherwise, as it will appear to every Routing instance that every engine is local.

Parameters:: pPreserveLocalhost - whether hostnames of "localhost" will be preserved

getCleanPhysicalPartitionFile

public java.lang.String getCleanPhysicalPartitionFile()

Returns the file name of the clean physical partition. This file is normally found in each engine installation's data directory, adjacent to the bin directory. Routing automatically finds it in the directory:

getEngineDir() / getVersionForCurrentPlatform() / data

Returns:: file name for the clean physical partition

setCleanPhysicalPartitionFile

public void setCleanPhysicalPartitionFile(java.lang.String cleanPhysicalPartitionFile)

Sets the file name of the clean physical partition. This file is normally found in each engine installation's data directory, adjacent to the bin directory. Routing automatically finds it in the directory:

getEngineDir() / getVersionForCurrentPlatform() / data

Parameters:: cleanPhysicalPartitionFile - file name for the clean physical partition

setOsNameToExecutableExtension

public void setOsNameToExecutableExtension(java.util.Map pOsNameToExecutableExtension)

Set a map from the value of "os.name" property to the executable extension. For example, a "Windows" key might have a value of ".exe". Both keys and values should be strings. Unix platforms don't need entries.

Parameters:: pOsNameToExecutableExtension - map from the value of "os.name" property to the executable extension

getOsNameToExecutableExtension

public java.util.Map getOsNameToExecutableExtension()

Gets a map from the value of "os.name" property to the executable extension. For example, a "Windows" key might have a value of ".exe". Both keys and values should be strings. Unix platforms don't have entries.

Returns:: a map from the value of "os.name" property to the executable extension

getEngineVersion

public java.lang.String getEngineVersion()

Gets the explicitly set engine version directory name

Returns:: the explicitly set engine version directory name

setEngineVersion

public void setEngineVersion(java.lang.String version)

Sets the engine version directory name. If set, this bypasses the getOsVersionToSubDir() lookup. Normally this is not set. Even if this is set, you must still make sure getEngineDir() is right. See getEngineDir() for an details.

Parameters:: version - the explicitly set engine version directory name

getCleanPhysicalPartitionPath

public java.lang.String getCleanPhysicalPartitionPath()
                                               throws atg.search.routing.RoutingConfigException

Returns the full path to the clean physical partition file. This comes from the engine's local data directory

Returns:: full path to the clean physical partition file.
Throws:: atg.search.routing.RoutingConfigException

setCleanPhysicalPartitionPath

public void setCleanPhysicalPartitionPath(java.lang.String pPath)

You must set this when you want to use remote engines for indexing. It is the full path to the clean physical partition. By default, it is empty. This can point to a concrete path as long as it makes sense to every search engine installation The path can also point to a share, such as /home/ATG/share/initial.index. If this is not set, then getCleanPhysicalPartitionFile() will use the installation's root to determine the path to the clean physical partition, but it will only work for local indexing engines.

Parameters:: pPath - full path of clean physical partition file

getEngineParams

public java.lang.String[] getEngineParams()

Returns Search Engine parameters, starting with the executable name. The $id$ argument is replaced by the engine's repository id; the engine puts it in its local logfile name which facilitates matching a routing engine with its log. The "$port$" argument is replaced with the port passed into the invocation method. The port is automatically calculated by Routing. The $AEConfigXml$" argument is replaced with the value of getAEConfigXmlFileName(). The "$loglevel$" argument is replaced with the value of getEngineLogLevel().

Returns:: array of engine parameters

setEngineParams

public void setEngineParams(java.lang.String[] pEngineParams)

Sets Search Engine parameters, starting with the executable name. The $id$ argument is replaced by the engine's repository id; the engine puts it in its local logfile name which facilitates matching a routing engine with its log. The "$port$" argument is replaced with the port passed into the invocation method. The port is automatically calculated by Routing. The $AEConfigXml$" argument is replaced with the value of getAEConfigXmlFileName(). The "$loglevel$" argument is replaced with the value of getEngineLogLevel(). Refer to the search engine documentation for other parameters.

Parameters:: pEngineParams - arrany of engine parameters

setOsVersionToSubDir

public void setOsVersionToSubDir(java.util.Map pOsVersionToSubDir)

Sets the mapping from OS version to engine subdirectory. It is a map whose keys are "{os.name}-{os.arch}", where the properties are defined by the JVM's System properties (for example "Windows-i386"). This map is used by default. It can be bypassed if getEngineVersion() is provided.

Parameters:: pOsVersionToSubDir - map of OS version to engine subdir

getOsVersionToSubDir

public java.util.Map getOsVersionToSubDir()

Gets the mapping from OS version to engine subdirectory. It is a map whose keys are "{os.name}-{os.arch}", where the properties are defined by the JVM's System properties (for example "Windows-i386"). This map is used by default. It can be bypassed if getEngineVersion() is provided.

Returns:: mapping from OS version to engine subdirectory

getDefaultStorageFilenameFragment

public java.lang.String getDefaultStorageFilenameFragment()

Gets the filename fragment looked for during cleanup. Routing will not ask the engine to cleanup any files missing this fragment.

Returns:: the filename fragment looked for during cleanup

setDefaultStorageFilenameFragment

public void setDefaultStorageFilenameFragment(java.lang.String defaultStorageFilenameFragment)

Sets the filename fragment looked for during cleanup. Routing will not ask the engine to cleanup any files missing this fragment.

Parameters:: defaultStorageFilenameFragment - the filename fragment looked for during cleanup

getDefaultIndexFilenameFragment

public java.lang.String getDefaultIndexFilenameFragment()

Gets the filename fragment looked for during cleanup. Routing will not ask the engine to cleanup any files missing this fragment.

Returns:: the filename fragment looked for during cleanup

setDefaultIndexFilenameFragment

public void setDefaultIndexFilenameFragment(java.lang.String defaultIndexFilenameFragment)

Sets the filename fragment looked for during cleanup. Routing will not ask the engine to cleanup any files missing this fragment.

Parameters:: defaultIndexFilenameFragment - the filename fragment looked for during cleanup

setAEConfigXmlFileName

public void setAEConfigXmlFileName(java.lang.String pAEConfigXmlFileName)

Sets the name of the engine's config file, by default "AEConfig.xml". Every engine installation has one of these in its bin directory.

Parameters:: pAEConfigXmlFileName - the name of the engine's config file

getAEConfigXmlFileName

public java.lang.String getAEConfigXmlFileName()

Gets the name of the engine's config file, by default "AEConfig.xml"

Returns:: the name of the engine's config file, by default "AEConfig.xml"

setAEConfigXmlTemplateFileName

public void setAEConfigXmlTemplateFileName(java.lang.String pAEConfigXmlTemplateFileName)

Sets the name of the engine's AEConfig template XML file, used for generating the config file if missing. Every engine installation has one of these in its bin directory.

Parameters:: pAEConfigXmlTemplateFileName - the name of the engine's AEConfig template XML file

getAEConfigXmlTemplateFileName

public java.lang.String getAEConfigXmlTemplateFileName()

Gets the name of the engine's AEConfig template XML file, used for generating the config file if missing. Every engine installation has one of these in its bin directory.

Returns:: the name of the engine's AEConfig template XML file

getDefaultSearchEngineStartPort

public int getDefaultSearchEngineStartPort()

Returns the default start port for search engines. This applies to a new host when it is added in SearchAdmin, and can always be edited later. See getDefaultSearchEngineEndPort().

Returns:: the default start port for search engines

setDefaultSearchEngineStartPort

public void setDefaultSearchEngineStartPort(int defaultSearchEngineStartPort)

Sets the default start port for search engines. This applies to a new host when it is added in SearchAdmin, and can always be edited later. See setDefaultSearchEngineEndPort(int).

Parameters:: defaultSearchEngineStartPort - the default start port for search engines

getDefaultSearchEngineEndPort

public int getDefaultSearchEngineEndPort()

Returns the default end port for search engines. This applies to a new host when it is added in SearchAdmin, and can always be edited later. See getDefaultSearchEngineStartPort().

Returns:: the default end port for search engines

setDefaultSearchEngineEndPort

public void setDefaultSearchEngineEndPort(int defaultSearchEngineEndPort)

Sets the default end port for search engines. This applies to a new host when it is added in SearchAdmin, and can always be edited later. See setDefaultSearchEngineStartPort(int).

Parameters:: defaultSearchEngineEndPort - the default end port for search engines

getDefaultMaximumSearchEngines

public int getDefaultMaximumSearchEngines()

Returns default max number of search engines run by an environment on a given machine. This can be edited in SearchAdmin on a per-machine basis after the machine has been added to an environment.

Returns:: default max number of search engines for new hosts of this environment

setDefaultMaximumSearchEngines

public void setDefaultMaximumSearchEngines(int defaultMaximumSearchEngines)

Sets default max number of search engines run by an environment on a given machine. This can be edited in SearchAdmin on a per-machine basis after the machine has been added to an environment.

Parameters:: defaultMaximumSearchEngines - default max number of search engines for new hosts of this environment

getDefaultRootIndexPath

public java.lang.String getDefaultRootIndexPath()

Gets the default index directory for engines' local files. It doesn't matter if all environments using a given machine use this same directory, since unique subdirectories will be created for index files. This directory will show up on each machine adjacent to the engine's bin directory.

Returns:: default index root path for new host

setDefaultRootIndexPath

public void setDefaultRootIndexPath(java.lang.String defaultRootIndexPath)

Sets the default index directory for engines' local files. It doesn't matter if all environments using a given machine use this same directory, since unique subdirectories will be created for index files. This directory will show up on each machine adjacent to the engine's bin directory. This should alway sbe a relative path, since it needs to make sense for all engines on all machines. If it is not relative, then it might need to be adjusted for every machine.

Parameters:: defaultRootIndexPath - default index root path for new host

getDefaultLaunchServicePort

public int getDefaultLaunchServicePort()

Returns the default RMI port for remote machines running launching service. This can be edited in SearchAdmin on a per-machine basis.

Returns:: the default RMI port for remote machines running launching service

setDefaultLaunchServicePort

public void setDefaultLaunchServicePort(int defaultLaunchServicePort)

Sets the default RMI port for remote machines running launching service. This can be edited in SearchAdmin on a per-machine basis.

Parameters:: defaultLaunchServicePort - the default RMI port for remote machines running launching service

getCompressedIndexExtension

public java.lang.String getCompressedIndexExtension()

Returns the extension of compressed index files, default is "gz"

Returns:: extension of compressed index files, default is "gz"

setCompressedIndexExtension

public void setCompressedIndexExtension(java.lang.String pCompressedIndexExtension)

Sets the extension of compressed index files, default is "gz"

Parameters:: pCompressedIndexExtension - extension of compressed index file, default is "gz"

isEngineCleanupOnStartupEnabled

public boolean isEngineCleanupOnStartupEnabled()

Indicates whether all engine ports will be checked on startup. Returns true by default.

Returns:: whether all engine ports will be checked on startup.

setEngineCleanupOnStartupEnabled

public void setEngineCleanupOnStartupEnabled(boolean pEngineCleanupOnStartupEnabled)

Controls whether all engine ports will be checked on startup. This can be time-consuming (over a minunte) if there are many hosts and engines. Disabling this check will improve startup speed, but will expose the system to port conflicts and stray engine problems. This should never be disabled in a production system. The default is true, which means the port check will run.

Parameters:: pEngineCleanupOnStartupEnabled - whether to check ports on startup

getDeferredWorkRoot

public java.io.File getDeferredWorkRoot()

The deferred work is a bunch of temporary files written during estimation for indexing. This property indicates where those files are written. By default, they go underneath the logs directory.

Returns:: directory for deferred work

setDeferredWorkRoot

public void setDeferredWorkRoot(java.io.File deferredWorkRoot)

The deferred work is a bunch of temporary files written during estimation for indexing. This property controls where those files are written. By default, they go underneath the logs directory.

Parameters:: deferredWorkRoot - location for deferred work

getDefaultPhysicalPartitionCount

public int getDefaultPhysicalPartitionCount()

Returns the number of physical partitions to start with in a fresh logical partition for estimation. See setDefaultPhysicalPartitionCount(int) for details.

Returns:: number of physical partitions to start with in a fresh logical partition for estimation

setDefaultPhysicalPartitionCount

public void setDefaultPhysicalPartitionCount(int defaultPhysicalPartitionCount)

The is the number of initial physical partitions to use during estimation. (1 / this number) is the sample proportion for estimation; the default of 19 samples about 5%. The larger this number, the smaller (and thus the less representative) the sample for estimation will be.

This number must be a prime number. If a non-prime is used, then the resulting buckets of work will not be evenly distributed during indexing: instead there will be large bands of work that will go to specific engines (even though the overall distribution will be even), with the result that one or more engines sit idle for extended periods during indexing. If the number is prime, this will never happen. The default of 19 is fine for nearly all implementations.

IF YOU HAVE A FULL PHYSICAL PARTITION DURING ESTIMATION:

A full physical partition during estimation means that the sampled content is too large to fit in a single partition. You are probably in a 32-bit environment if you are seeing this. The solution is to decrease the size of the sampled content by increasing the number of sample partitions (this setting here), since the proportion of total content that is sampled equals 1/defaultPhysicalPartitionCount. The next few prime numbers are 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97

Parameters:: defaultPhysicalPartitionCount - number of physical partitions during estimation.

getFullnessOfRecommendedPartitions

public double getFullnessOfRecommendedPartitions()

Returns the ideal proportion of maximum physical partition size to be used when calculating the estimated number of physical partitions. For example, if the max size on your platform is 1 GB, a value here of 0.8 will mean that Routing will base its estimation calculations on a 0.8 GB partition size. This means that, post-estimation, it is extremely unlikely that a partition will fill up immediately (which would force another full index).

Returns:: degree of fullness used for calculating number of recommended partitions, greater than 0.02, up to 1.0

setFullnessOfRecommendedPartitions

public void setFullnessOfRecommendedPartitions(double fullnessOfRecommendedPartitions)

Values lower than 0.02 will be ignored, and 0.02 will be used instead. Values much below, say, 0.2 or 0.3, will only result in many partitions that are nearly empty.

Parameters:: fullnessOfRecommendedPartitions - degree of fullness used for calculating number of recommended partitions, greater than 0.02, up to 1.0

setOsVersionDelim

public void setOsVersionDelim(java.lang.String pOsVersionDelim)

Specifies the delimiter used to separate version directories in the getOsVersionToSubDir() map. The delimiter cannot be a comma since the values are stored in a map and the comma delimits entries in the map. The delimiter cannot be a equal sign since the values are stored in a map and the equal sign separates the key and value in the map. The default value is colon (:). There shouldn't be any need to change the default delimiter.

isEnableLogProblematicRequestResponse

public boolean isEnableLogProblematicRequestResponse()

Whether to log problematic request and response to the warning log in addition to request/response files. Default is true.

Returns:: true if we should log problematic request and response to the warning log.

isEnableLogProblematicRequestResponse

public void isEnableLogProblematicRequestResponse(boolean pEnableLogProblematicRequestResponse)

Sets whether to log problematic request and response to the warning log in addition to request/response files. Default is true.

getOsVersionDelim

public java.lang.String getOsVersionDelim()

Returns the deploy share directory, the location for master copies of index files. See setDeployShare(java.io.File) for details.

Returns:: the deploy share directory, the location for master copies of index files

getInitialDeploymentTimeoutPerLPMs

public int getInitialDeploymentTimeoutPerLPMs()

Gets Initial Deployment timeout for one logical partition.

Returns:: initial Deployment timeout for one logical partition

setInitialDeploymentTimeoutPerLPMs

public void setInitialDeploymentTimeoutPerLPMs(int pInitialDeploymentTimeoutPerLPMs)

Sets Initial Deployment timeout for one logical partition.

Parameters:: pInitialDeploymentTimeoutPerLPMs - initial Deployment timeout for one logical partition

getServerIdPort

public int getServerIdPort()

Returns the port used for the unique server Id. See getUniqueServerId(). By default this is the RMI port of the instance, and normally should not be changed.

Returns:

setServerIdPort

public void setServerIdPort(int mServerIdPort)

Sets the port used for the unique server Id. See getUniqueServerId(). By default this is the RMI port of the instance, and normally should not be changed.

getDefaultNumberOfDaysPerShard

public int getDefaultNumberOfDaysPerShard()

Returns the default number of days per shard. Only applies to live indexing and only if sharding is enabled.

Returns:: the default number of days per shard.

setDefaultNumberOfDaysPerShard

public void setDefaultNumberOfDaysPerShard(int pDefaultNumberOfDaysPerShard)

Sets the default number of days per shard. Only applies to live indexing and only if sharding is enabled.

Parameters:: pDefaultNumberOfDaysPerShard - the default number of days per shard

getDefaultNumberOfShards

public int getDefaultNumberOfShards()

Returns the default number of shards. There must always be at least two shards.

Returns:: the default number of shards.

setDefaultNumberOfShards

public void setDefaultNumberOfShards(int pDefaultNumberOfShards)

Sets the default number of shards. There must always be at least two shards.

Parameters:: pDefaultNumberOfShards - the default number of shards

getIgnoreErrorCodeList

public java.lang.String[] getIgnoreErrorCodeList()

A list of response error codes that should not cause a warning to be logged

setIgnoreErrorCodeList

public void setIgnoreErrorCodeList(java.lang.String[] pIgnoreErrorCodeList)

A list of response error codes that should not cause a warning to be logged

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

atg.search.routing Class Configuration

CLASS_VERSION

Configuration

setOptimisticIndexing

isOptimisticIndexing

getUniqueServerId

isLoggingSlowRequests

setLoggingSlowRequests

getSlowSearchRequestMs

setSlowSearchRequestMs

getSlowIndexRequestMs

setSlowIndexRequestMs

isIndexingServerEnabled

setIndexingServerEnabled

setDeployShare

getDeployShare

getEngineDir

setEngineDir

setEngineLogLevel

getEngineLogLevel

isLoggingVerboseStyle

setLoggingVerboseStyle

isLoggingAllRequests

setLoggingAllRequests

setLoggingSearch

isLoggingSearch

setLoggingIndex

isLoggingIndex

setLoggingDeploy

isLoggingDeploy

setLoggingStart

isLoggingStart

setLoggingStop

isLoggingStop

setLoggingLoad

isLoggingLoad

getEngineActivityPath

setEngineActivityPath

getStrategyType

setStrategyType

getArbiterType

setArbiterType

isMonitoringEnabled

setMonitoringEnabled

getConnectTimeoutMs

setConnectTimeoutMs

getReadTimeoutMs

setReadTimeoutMs

getIndexingReadTimeoutMs

setIndexingReadTimeoutMs

getInitialRequestsToTrack

setInitialRequestsToTrack

getRecentRequestsToTrack

setRecentRequestsToTrack

isMonitorIgnoredEngines

setMonitorIgnoredEngines

isRestartFailedEngines

setRestartFailedEngines

isPreserveLocalhost

setPreserveLocalhost

getCleanPhysicalPartitionFile

setCleanPhysicalPartitionFile

setOsNameToExecutableExtension

getOsNameToExecutableExtension

getEngineVersion

setEngineVersion

getCleanPhysicalPartitionPath

setCleanPhysicalPartitionPath

getEngineParams

setEngineParams

setOsVersionToSubDir

getOsVersionToSubDir

getDefaultStorageFilenameFragment

setDefaultStorageFilenameFragment

getDefaultIndexFilenameFragment

setDefaultIndexFilenameFragment

setAEConfigXmlFileName

getAEConfigXmlFileName

setAEConfigXmlTemplateFileName

getAEConfigXmlTemplateFileName

atg.search.routing
Class Configuration