org.cdlib.xtf.dynaXML
Class DynaXMLConfig

Object
  extended by TextConfig
      extended by DynaXMLConfig

 class DynaXMLConfig
extends TextConfig

Holds global configuration information for the dynaXML servlet.


Field Summary
 int authCacheExpire
          Max amount of time (seconds) to cache authentication lookups
 int authCacheSize
          Max # of authentication lookups to cache
 boolean buildLazyFilesAlone
          Whether to generate lazy files alone (outside of textIndexer)
 String docLookupSheet
          Filesystem path to the 'doclookup' stylesheet, used to get info about documents given their docId's.
 int ipListCacheExpire
          Max amount of time (seconds) before IP list is automatically reloaded
 int ipListCacheSize
          Max # of IP lists to cache
 int loginCacheExpire
          Max amount of time (seconds) before login attempt fails
 int loginCacheSize
          Max # of simultaneous external logins
 String reverseProxyDefaultMarker
          The default header to recording the original IP address.
 String reverseProxyIP
          IP address of the reverse proxy, if any
 String reverseProxyMarker
          Name of the special HTTP header used to record the original IP address by the reverse proxy.
 boolean stylesheetProfiling
          Whether to print out a stylesheet profile after each request
 boolean useLazyFiles
          Whether to use lazy files
 
Fields inherited from class TextConfig
attribs, dependencyCheckingEnabled, errorGenSheet, latencyCutoffSize, logLevel, reportLatency, runawayKillTime, runawayNormalTime, servlet, sessionEncodeURLPattern, stylesheetCacheExpire, stylesheetCacheSize, tokenizerMap, trackSessions
 
Constructor Summary
DynaXMLConfig(DynaXML servlet, String path)
          Constructor - Reads and parses the global configuration file (XML) for the servlet.
 
Method Summary
 boolean handleProperty(String tagAttr, String strVal)
          Called by when a property is encountered in the configuration file.
 
Methods inherited from class TextConfig
parseBoolean, parseInt, read, requireOrElse
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

reverseProxyIP

public String reverseProxyIP
IP address of the reverse proxy, if any


reverseProxyMarker

public String reverseProxyMarker
Name of the special HTTP header used to record the original IP address by the reverse proxy.


reverseProxyDefaultMarker

public String reverseProxyDefaultMarker
The default header to recording the original IP address.


docLookupSheet

public String docLookupSheet
Filesystem path to the 'doclookup' stylesheet, used to get info about documents given their docId's.


authCacheSize

public int authCacheSize
Max # of authentication lookups to cache


authCacheExpire

public int authCacheExpire
Max amount of time (seconds) to cache authentication lookups


loginCacheSize

public int loginCacheSize
Max # of simultaneous external logins


loginCacheExpire

public int loginCacheExpire
Max amount of time (seconds) before login attempt fails


ipListCacheSize

public int ipListCacheSize
Max # of IP lists to cache


ipListCacheExpire

public int ipListCacheExpire
Max amount of time (seconds) before IP list is automatically reloaded


stylesheetProfiling

public boolean stylesheetProfiling
Whether to print out a stylesheet profile after each request


useLazyFiles

public boolean useLazyFiles
Whether to use lazy files


buildLazyFilesAlone

public boolean buildLazyFilesAlone
Whether to generate lazy files alone (outside of textIndexer)

Constructor Detail

DynaXMLConfig

public DynaXMLConfig(DynaXML servlet,
                     String path)
              throws GeneralException
Constructor - Reads and parses the global configuration file (XML) for the servlet.

Parameters:
path - Filesystem path to the config file.
Throws:
DynaXMLException - If a read or parse error occurs.
GeneralException
Method Detail

handleProperty

public boolean handleProperty(String tagAttr,
                              String strVal)
Called by when a property is encountered in the configuration file. If we recognize the property we process it here; otherwise, we pass it on to the base class for recognition there.

Overrides:
handleProperty in class TextConfig
Parameters:
tagAttr - Combined element/attribute name being considered
strVal - It's string value
Returns:
true if handled, false if unrecognized