|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.search.routing.Configuration
public class Configuration
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 |
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. |
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 |
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 |
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 |
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 |
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.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public Configuration()
Method Detail |
---|
public java.lang.String getUniqueServerId()
public boolean isLoggingSlowRequests()
setSlowSearchRequestMs(int)
,
setSlowIndexRequestMs(int)
public void setLoggingSlowRequests(boolean pLoggingSlowRequests)
pLoggingSlowRequests
- whether slow requests will be logged to the engine activity foldersetSlowSearchRequestMs(int)
,
setSlowIndexRequestMs(int)
public int getSlowSearchRequestMs()
isLoggingSlowRequests()
public void setSlowSearchRequestMs(int pSlowSearchRequestMs)
isLoggingSlowRequests()
returns false.
pSlowSearchRequestMs
- the minimum response time for a request to be considered slow for logging purposesisLoggingSlowRequests ()
public int getSlowIndexRequestMs()
isLoggingSlowRequests()
public void setSlowIndexRequestMs(int pSlowSearchRequestMs)
isLoggingSlowRequests()
returns false.
pSlowSearchRequestMs
- the minimum response time for a request to be considered slow for logging purposesisLoggingSlowRequests ()
public boolean isIndexingServerEnabled()
public void setIndexingServerEnabled(boolean pIndexingServerEnabled)
pIndexingServerEnabled
- whether this instance of Routing is enabled as an indexing serverpublic void setDeployShare(java.io.File pDeployShare)
pDeployShare
- the deploy share directory, the location for master copies of index filespublic java.io.File getDeployShare()
setDeployShare(java.io.File)
for details.
public java.io.File getEngineDir()
setEngineDir(java.io.File)
for details.
public void setEngineDir(java.io.File pEngineDir)
full path = **engineDir** / **versionForCurrentPlatform** / bin
where versionForCurrentPlatform =
a) engineVersion
, if explicitly configured via setEngineVersion(String)
or
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
.
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
setEngineDir(java.io.File)
: only applies here; remote launcher has its own
setEngineVersion(String)
: only applies here; remote launcher has its own
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
pEngineDir
- the SearchEngine's base directory on this machinepublic void setEngineLogLevel(java.lang.String pEngineLogLevel)
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.
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.public java.lang.String getEngineLogLevel()
public boolean isLoggingVerboseStyle()
getEngineActivityPath()
.
public void setLoggingVerboseStyle(boolean pLoggingVerboseStyle)
getEngineActivityPath()
.
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.public boolean isLoggingAllRequests()
getEngineActivityPath()
.
public void setLoggingAllRequests(boolean pLoggingAllRequests)
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)
.
pLoggingAllRequests
- whether request types should be loggedgetEngineActivityPath()
,
setLoggingDeploy(boolean)
,
setLoggingIndex(boolean)
,
setLoggingLoad(boolean)
,
setLoggingSearch(boolean)
,
setLoggingStart(boolean)
,
setLoggingStop(boolean)
public void setLoggingSearch(boolean isLogging)
getEngineActivityPath()
. Generates a huge number of files. This should
not be left enabled for very long if the site is under heavy load.
isLogging
- whether to log search requestsgetEngineActivityPath()
,
setLoggingAllRequests(boolean)
public boolean isLoggingSearch()
isLoggingAllRequests()
public void setLoggingIndex(boolean isLogging)
getEngineActivityPath()
.
isLogging
- whether to log index requestsgetEngineActivityPath()
,
setLoggingAllRequests(boolean)
public boolean isLoggingIndex()
isLoggingAllRequests()
public void setLoggingDeploy(boolean isLogging)
getEngineActivityPath()
.
isLogging
- whether to log deploy requestsgetEngineActivityPath()
,
setLoggingAllRequests(boolean)
public boolean isLoggingDeploy()
isLoggingAllRequests()
public void setLoggingStart(boolean isLogging)
getEngineActivityPath()
.
isLogging
- whether to log start requestsgetEngineActivityPath()
,
setLoggingAllRequests(boolean)
public boolean isLoggingStart()
isLoggingAllRequests()
public void setLoggingStop(boolean isLogging)
getEngineActivityPath()
.
isLogging
- whether to log stop requestsgetEngineActivityPath()
,
setLoggingAllRequests(boolean)
public boolean isLoggingStop()
isLoggingAllRequests()
public void setLoggingLoad(boolean isLogging)
getEngineActivityPath()
.
isLogging
- whether to log load requestsgetEngineActivityPath()
,
setLoggingAllRequests(boolean)
public boolean isLoggingLoad()
isLoggingAllRequests()
public java.io.File getEngineActivityPath()
public void setEngineActivityPath(java.io.File pOutputPath)
isLoggingVerboseStyle()
.
pOutputPath
- path for logged request/response XML and diagnostic filessetLoggingVerboseStyle(boolean)
,
setLoggingAllRequests(boolean)
,
setLoggingDeploy(boolean)
,
setLoggingIndex(boolean)
,
setLoggingLoad(boolean)
,
setLoggingSearch(boolean)
,
setLoggingStart(boolean)
,
setLoggingStop(boolean)
public atg.search.routing.SearchStrategy.StrategyType getStrategyType()
public void setStrategyType(atg.search.routing.SearchStrategy.StrategyType pStrategyType)
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.
pStrategyType
- the search strategy typepublic atg.search.routing.SearchEngineArbiterService.ArbiterType getArbiterType()
public void setArbiterType(atg.search.routing.SearchEngineArbiterService.ArbiterType pArbiterType)
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.
pArbiterType
- the engine arbiter typepublic boolean isMonitoringEnabled()
getInitialRequestsToTrack()
,
getRecentRequestsToTrack()
public void setMonitoringEnabled(boolean monitoringEnabled)
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.
monitoringEnabled
- whether monitoring is enabledpublic int getConnectTimeoutMs()
setConnectTimeoutMs(int)
public void setConnectTimeoutMs(int pConnectTimeoutMs)
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.
pConnectTimeoutMs
- timeout in ms for connectssetConnectTimeoutMs(int)
public int getReadTimeoutMs()
getIndexingReadTimeoutMs()
public void setReadTimeoutMs(int pReadTimeoutMs)
pReadTimeoutMs
- timeout in ms for readssetIndexingReadTimeoutMs(int)
public int getIndexingReadTimeoutMs()
getReadTimeoutMs()
public void setIndexingReadTimeoutMs(int pIndexingReadTimeoutMs)
setReadTimeoutMs(int)
), long enough
to let the engine finish a long-running command like Topic Load. The default is 300,000 milliseconds
(5 minutes).
pIndexingReadTimeoutMs
- timeout in ms to use for indexing requestssetReadTimeoutMs(int)
public int getInitialRequestsToTrack()
isMonitoringEnabled()
is true. The requests are viewable in dyn/admin in SearchEngineService.
public void setInitialRequestsToTrack(int pInitialRequestsToTrack)
isMonitoringEnabled()
is true. The requests are viewable in dyn/admin in SearchEngineService.
pInitialRequestsToTrack
- number of initial requests that are saved for a given enginepublic int getRecentRequestsToTrack()
isMonitoringEnabled()
is true. The requests are viewable in dyn/admin in SearchEngineService.
public void setRecentRequestsToTrack(int pRecentRequestsToTrack)
isMonitoringEnabled()
is true. The requests are viewable in dyn/admin in SearchEngineService.
pRecentRequestsToTrack
- number of recent requests that are saved for a given enginepublic boolean isMonitorIgnoredEngines()
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.
public void setMonitorIgnoredEngines(boolean pMonitorIgnoredEngines)
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.
pMonitorIgnoredEngines
- if true, ignored engines are monitoredpublic boolean isRestartFailedEngines()
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.
public void setRestartFailedEngines(boolean pRestartFailedEngines)
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.
pRestartFailedEngines
- if true, failed engines are restartedpublic boolean isPreserveLocalhost()
"localhost"
as a hostname. See setPreserveLocalhost(boolean)
for details.
public void setPreserveLocalhost(boolean pPreserveLocalhost)
"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.
pPreserveLocalhost
- whether hostnames of "localhost" will be preservedpublic java.lang.String getCleanPhysicalPartitionFile()
data
directory, adjacent to the bin
directory.
Routing automatically finds it in the directory:
getEngineDir()
/ getVersionForCurrentPlatform()
/ data
public void setCleanPhysicalPartitionFile(java.lang.String cleanPhysicalPartitionFile)
data
directory, adjacent to the bin
directory.
Routing automatically finds it in the directory:
getEngineDir()
/ getVersionForCurrentPlatform()
/ data
cleanPhysicalPartitionFile
- file name for the clean physical partitionpublic void setOsNameToExecutableExtension(java.util.Map pOsNameToExecutableExtension)
pOsNameToExecutableExtension
- map from the value of "os.name" property to the executable extensionpublic java.util.Map getOsNameToExecutableExtension()
public java.lang.String getEngineVersion()
public void setEngineVersion(java.lang.String version)
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.
version
- the explicitly set engine version directory namepublic java.lang.String getCleanPhysicalPartitionPath() throws atg.search.routing.RoutingConfigException
atg.search.routing.RoutingConfigException
public void setCleanPhysicalPartitionPath(java.lang.String pPath)
/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.
pPath
- full path of clean physical partition filepublic java.lang.String[] getEngineParams()
getAEConfigXmlFileName()
. The "$loglevel$" argument is replaced with the
value of getEngineLogLevel()
.
public void setEngineParams(java.lang.String[] pEngineParams)
getAEConfigXmlFileName()
. The "$loglevel$" argument is replaced with the
value of getEngineLogLevel()
. Refer to the search engine documentation for other parameters.
pEngineParams
- arrany of engine parameterspublic void setOsVersionToSubDir(java.util.Map pOsVersionToSubDir)
getEngineVersion()
is provided.
pOsVersionToSubDir
- map of OS version to engine subdirpublic java.util.Map getOsVersionToSubDir()
getEngineVersion()
is provided.
public java.lang.String getDefaultStorageFilenameFragment()
public void setDefaultStorageFilenameFragment(java.lang.String defaultStorageFilenameFragment)
defaultStorageFilenameFragment
- the filename fragment looked for during cleanuppublic java.lang.String getDefaultIndexFilenameFragment()
public void setDefaultIndexFilenameFragment(java.lang.String defaultIndexFilenameFragment)
defaultIndexFilenameFragment
- the filename fragment looked for during cleanuppublic void setAEConfigXmlFileName(java.lang.String pAEConfigXmlFileName)
pAEConfigXmlFileName
- the name of the engine's config filepublic java.lang.String getAEConfigXmlFileName()
public void setAEConfigXmlTemplateFileName(java.lang.String pAEConfigXmlTemplateFileName)
pAEConfigXmlTemplateFileName
- the name of the engine's AEConfig template XML filepublic java.lang.String getAEConfigXmlTemplateFileName()
public int getDefaultSearchEngineStartPort()
getDefaultSearchEngineEndPort()
.
public void setDefaultSearchEngineStartPort(int defaultSearchEngineStartPort)
setDefaultSearchEngineEndPort(int)
.
defaultSearchEngineStartPort
- the default start port for search enginespublic int getDefaultSearchEngineEndPort()
getDefaultSearchEngineStartPort()
.
public void setDefaultSearchEngineEndPort(int defaultSearchEngineEndPort)
setDefaultSearchEngineStartPort(int)
.
defaultSearchEngineEndPort
- the default end port for search enginespublic int getDefaultMaximumSearchEngines()
public void setDefaultMaximumSearchEngines(int defaultMaximumSearchEngines)
defaultMaximumSearchEngines
- default max number of search engines for new hosts of this environmentpublic java.lang.String getDefaultRootIndexPath()
public void setDefaultRootIndexPath(java.lang.String defaultRootIndexPath)
defaultRootIndexPath
- default index root path for new hostpublic int getDefaultLaunchServicePort()
public void setDefaultLaunchServicePort(int defaultLaunchServicePort)
defaultLaunchServicePort
- the default RMI port for remote machines running launching servicepublic java.lang.String getCompressedIndexExtension()
public void setCompressedIndexExtension(java.lang.String pCompressedIndexExtension)
pCompressedIndexExtension
- extension of compressed index file, default is "gz"public boolean isEngineCleanupOnStartupEnabled()
public void setEngineCleanupOnStartupEnabled(boolean pEngineCleanupOnStartupEnabled)
pEngineCleanupOnStartupEnabled
- whether to check ports on startuppublic java.io.File getDeferredWorkRoot()
public void setDeferredWorkRoot(java.io.File deferredWorkRoot)
deferredWorkRoot
- location for deferred workpublic int getDefaultPhysicalPartitionCount()
setDefaultPhysicalPartitionCount(int)
for details.
public void setDefaultPhysicalPartitionCount(int defaultPhysicalPartitionCount)
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
defaultPhysicalPartitionCount
- number of physical partitions during estimation.public double getFullnessOfRecommendedPartitions()
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.
fullnessOfRecommendedPartitions
- degree of fullness used for calculating number of recommended partitions, greater than 0.02, up to 1.0public void setOsVersionDelim(java.lang.String pOsVersionDelim)
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.
public boolean isEnableLogProblematicRequestResponse()
public void isEnableLogProblematicRequestResponse(boolean pEnableLogProblematicRequestResponse)
public java.lang.String getOsVersionDelim()
setDeployShare(java.io.File)
for details.
public int getInitialDeploymentTimeoutPerLPMs()
public void setInitialDeploymentTimeoutPerLPMs(int pInitialDeploymentTimeoutPerLPMs)
pInitialDeploymentTimeoutPerLPMs
- initial Deployment timeout for one logical partitionpublic int getServerIdPort()
getUniqueServerId()
.
By default this is the RMI port of the instance, and normally should not be changed.
public void setServerIdPort(int mServerIdPort)
getUniqueServerId()
.
By default this is the RMI port of the instance, and normally should not be changed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |