WireHose Developer Center
NewsProductsDownloadDevelopersAbout Us

WireHose Properties

Contents

Introduction

The runtime behavior of the WireHose frameworks can be controlled through a variety of properties. These defaults can be set and overridden in several different ways:

  • As entries in a framework or application's Properties file. This sets a default value for that framework or application which can be overridden at runtime by launch arguments. Note that in a properties file the name of the default is specified without an initial hyphen, e.g.:
    # my properties file
    # set intersect operator for OpenBase
    WHSQLIntersectOperator = NO

  • As launch arguments to a WebObjects application in Xcode on Mac OS X:
    • Select the "Executables" tab in the main application target (not the WebServer or Application Server targets).
    • Select the "Arguments" tab.
    • Click the "Add" button at the bottom of the screen to add a new set of arguments. Note that the name of the default should be preceded by a hyphen, e.g.:
      -WHAdaptorDict /path/to/OracleAdaptorDict.plist
    • Check the "Use" column to indicate which set of arguments to use when launching the application.

  • As arguments to a batch file or executable launched via a command line. Note that the name of the default should be preceded by a hyphen, e.g.:
    ./importLocalHeadlines -WHAdaptorDict myAdaptorDict.plist

  • As additional arguments when launching an application using JavaMonitor. See Apple's documentation for details.

Properties Reference

PropertyDescriptionUsed by
WHAdaptorDict Name of file in current application bundle (or path to file) which contains the adaptor dictionary to use. Defaults to "adaptorDict.plist". You can switch between multiple databases by specifying a different adaptor dictionary on the command line when launching your application. WHEnterpriseObject
WHComponentsWith
ContentAreStateless
Controls whether or not WireHose components which wrap content are stateless or not. Defaults to YES. WHArea, WHAreaWrapper, WHBorderedTable, WHComponent, WHHTMLString, WHMatrixTable, WHPage, WHShowComponentChannel, WHShowFetcher, WHSmartBorderedTable, WHSwitchEditor, WHSwitchRenderer, WHWrapper
WHCookieDomain Specifies the domain set on cookies. Defaults to "default", which means no domain is set. WHApplicationHelper, WHSessionHelper, WHLogoutPage
WHCookiePath Specifies the path set on cookies. Defaults to "/". WHApplicationHelper, WHSessionHelper, WHLogoutPage
WHDefaultAffiliate Specifies the application's affiliate name. Defaults to "default", which tells WHApplicationHelper to use the name of the application. WHApplicationHelper
WHDefaultLayout Specifies the layout name to be used if the layout specified by a user's currentLayout isn't available, and the value set for currentLayout during WHUser's awakeFromInsertion. Defaults to "Default". WHApplicationHelper, WHSessionHelper, WHUser
WHDefaultTagEntity Specifies the default tag entity to be used. Defaults to "WHTag" WHTag
WHDisableAutoSubEntities Controls whether or not automatic subentity creation happens at startup. The default is NO, meaning subentities are created automatically. WHApplicationHelper
WHDisableGuestPreloading If YES, guest channels are not refreshed during application startup before waiting for incoming requests. Defaults to NO. WHApplicationHelper
WHDisableLayout
DictionaryCaching
If YES, the layout dictionary will be reset for each incoming request. Default is NO. WHApplication
WHDisableShared
ObjectLoading
If YES, shared object loading is disabled. Default is NO. WHEnterpriseObject
WHHeaderDebugEnabled If YES, WHApplication will log HTTP request and response headers. Setting this property to YES sets NSLog's allowedDebugLevel to DebugLevelDetailed and enables debug group WHLog.DebugGroupRequestHandling. Default is NO. WHApplication
WHIgnoreMissingEntities If set to "true" or "YES" (the default), WHTagDataSource will not throw an exception if any entities gathered from a tag's entity hints cannot be found. WHTagDataSource
WHLayoutDict Name of file in application bundle (or absolute path to file) which contains this application's layout dictionary in plist format. Defaults to "layoutDict.plist". WHApplicationHelper
WHLookupDictionary
DebugEnabled
If YES, WHLookupDictionary will log the values set and returned. Setting this property to YES sets NSLog's allowedDebugLevel to DebugLevelDetailed and enables debug group WHLog.DebugGroupDictionaryLookup. Default is NO. WHLookupDictionary
WHRewriteSession
CookiePath
Specifies whether the application should rewrite session cookie paths during appendToResponse. Defaults to YES. Note that for this behavior to occur you must either subclass WHApplication or include support in your own WOApplication subclass. WHApplication, WHApplicationHelper
WHServerName Specifies the server name to be used if the server name cannot be determined from the incoming request. This value is also used by WHHyperlink's $SERVER_NAME rewrite rule substitution. Defaults to "127.0.0.1" WHHyperlink, WHSessionHelper
WHServerNameHeaderKeys Specifies in plist format the array of request header keys to inspect, in order, to determine the name of the server when constructing URLs. A key of "WHServerName" means use the value of the WHServerName property. Defaults to "("x-webobjects-server-name", "SERVER_NAME", "WHServerName")" WHSessionHelper
WHServerNameHeaderKeys Specifies in plist format the array of request header keys to inspect, in order, for performing browser sniffing. Defaults to "("HTTP_USER_AGENT", "user-agent")" WHSessionHelper
WHSQLDebugEnabled If YES, WHTagDataSource will log information about SQL generation. Setting this property to YES sets NSLog's allowedDebugLevel to DebugLevelDetailed and enables debug group DebugGroupSQLGeneration. Default is NO. WHApplication
WHSQLExceptOperator SQL operator to use when constructing queries. For Oracle, you would set this to "MINUS". If set to "false" or "NO", then an alternate syntax is used which does not require EXCEPT functionality. This default is ignored if WHSQLIntersectOperator is set to "false" or "NO". WHTagDataSource
WHSQLFetchLimitOperator SQL operator to use when constructing queries. If set to "false" or "NO", then server-side fetchlimits are not used. For MySQL, set this to "LIMIT 0, %@". For OpenBase, set this to "RETURN RESULTS 0 TO %@". WHTagDataSource
WHSQLInOperator SQL operator to use when constructing queries. Defaults to "IN". If set to "false" or "NO", then an alternate syntax is used which does not require subselect functionality. WHTagDataSource
WHSQLIntersectOperator SQL operator to use when constructing queries. Defaults to "INTERSECT". If set to "false" or "NO", then an alternate syntax is used which does not require INTERSECT functionality. WHTagDataSource
WHSQLTimestampFormat Format to be applied to timestamps when constructing queries. See NSTimestampFormatter and java.text.SimpleDateFormat for possible formats. Defaults to "default". There are two convenience values:
  "default" specifies "''yyyy-MM-dd HH:mm:ss zzz''"
   "oracle" specifies "'TO_DATE'(''yyyy-MM-dd hh:mm:ssaa'', '''YYYY/MM/DD HH:MI:SSAM''')"
WHTagDataSource
WHSQLUseDistinct Whether to use "SELECT" or "SELECT DISTINCT" when constructing queries. For OpenBase, this should be set to "NO". Defaults to "YES". WHTagDataSource
WHStopWordsList Path to list of stop words. If not specified, stop words are read from a resource called "stopwords.txt" in the WireHoseBase framework bundle. WHTextIndexer
WHTagCacheSize Number of tags to hold in cache. Least recently used tags are dropped from the cache. Defaults to "infinite". WHTag
WHUseEntityHints If set to "true" or "YES" (the default), WHTagDataSource will only fetch entities which have been identified as being associated with its optional and required tags. WHTagDataSource
WHUserEntityName Specifies which base entity WHApplicationHelper will use when fetching and creating users. The actual entity fetched and created will be an affiliate-based subentity of this entity for the default affiliate. For example, if WHDefaultAffiliate is "Seattle" and WHUserEntityName is "WHUser" (the default), users and guest users will be of the "SeattleUser" entity. WHApplicationHelper
Copyright ©2000-2014 Gary Teter. All rights reserved. WireHose and the eyeball-and-arrows logo are trademarks of Gary Teter.