# Jaxer.Config : Object
Return to: Jaxer Framework index

Namespace containing the config properties.

## Platform Support

Jaxer Server Framework | Jaxer Client Framework
--- | ---
1.0 | no

## Properties

Property | Action | Jaxer Server Framework | Jaxer Client Framework
--- | --- | --- | ---
static ALERT_CALLBACK_ERRORS : Boolean A Boolean flag to indicate whether to popup a window.alert(...) when a callback returns an error. By default this is set to true; if this is not the desired behavior in production, override it in your local Jaxer config. | Show Details | 1.0 | no

See Also

  Jaxer.Config.CALLBACK_ERROR_MESSAGE|Jaxer.Config.CALLBACK_FATAL_ERROR_MESSAGE

static AUTO_CREATE_APP_PATHS : Boolean Whether to automatically create folders at the locations specified by each app's (resolved) PATH property, either at server start (if the app's name is a string) or when the app is first requested (if the app's name is a function of the request). This is true by default. | No Details | 1.0 | no

static CACHE_USING_SOURCE_CODE : String A Boolean flag to indicate where to cache as source or bytecode. This is set to true by default, so it's easy in development time to read what was cached rather than caching the bytecode. Override it to false for better performance. | No Details | 1.0 | no

static CALLBACK_ERROR_MESSAGE : String Contains the message to display when a callback error occurs. | Show Details | 1.0 | no

See Also

  Jaxer.Config.ALERT_CALLBACK_ERRORS

static CALLBACK_FATAL_ERROR_MESSAGE : String Contains the message to display when a fatal callback error occurs. | Show Details | 1.0 | no

See Also

  Jaxer.Config.ALERT_CALLBACK_ERRORS

static CALLBACK_URI : String The special url designator, usually "/jaxer-server/callback". It is defined in the apache conf. | No Details | 1.0 | no

static CLIENT_FRAMEWORK_SRC : String
The URL at which the client should look for the Jaxe client-side framework, if EMBEDDED_CLIENT_FRAMEWORK_SRC is undefined or null. To embed the client part of the Jaxer framework in the web page, specify its location in EMBEDDED_CLIENT_FRAMEWORK_SRC Alternatively, to have the web server serve its contents,
1) comment out EMBEDDED_CLIENT_FRAMEWORK_SRC,
2) copy the client framework to somewhere the web server can reach it, and
3) set CLIENT_FRAMEWORK_SRC to the src of the script element that will be inserted into the page
EMBEDDED_CLIENT_FRAMEWORK_SRC: "resource:///framework/clientFramework_compressed.js"

No Details

1.0

no

static COMMAND_LINE_PARAMS : Object If any config-type parameters were specified on the command line when launching Jaxer, they will be included as properties of this object. Note: This is created and populated inside aptEventHandler.js | No Details | 1.0 | no

static DEFAULT_APP : Object
Contains the parameters that will be used for pages and applications that don't match any of the custom entries in Jaxer.Config.apps, as defined in configApps.js. This property is best managed, if needed, in the local_jaxer/conf/configApps.js which will not be overwritten by subsequent jaxer updates. Changes in that file will get picked up automatically on restart. Note: even though this is created as a plain object (hashmap) in config.js, it is wrapped up into a Jaxer.App object upon server start

No Details

1.0

no

static DEFAULT_DB : Object
Contains the parameters for a connection object of one of the supported DB implementations. At the very least, the IMPLEMENTATION property must be defined and be the name of one of the supported implementations in the DB namespace (e.g. "SQLite", "MySQL"). The remaining parameters have all the information required to connect to the database. This will be used for pages and applications that don't match any of the custom entries in Jaxer.Config.apps, as defined in configApps.js. This property is best managed in the local_jaxer/conf/configApps.js which will not be overwritten by subsequent jaxer updates. Changes in that file will get picked up automatically on restart.

Show Details

1.0

no

See Also

  Jaxer.DB.MySQL.Connection|Jaxer.DB.SQLite.Connection

static DEFAULT_PATH_BASE : String For convenience, a central starting point from which to build paths used as default locations where apps read and write files. To make it easier to use cross-platform, should include trailing path separator. | No Details | 1.0 | no

static DEV_MODE : Boolean A flag to allow a central place to flip the operational behavior of a Jaxer instance from development to production mode. CAUTION: this should be set to false in a production environment to prevent sensitive information from getting to the browser! | Show Details | 1.0 | no

See Also

  Jaxer.Config.DISPLAY_ERRORS|Jaxer.Config.ALERT_CALLBACK_ERRORS|Jaxer.Config.RELOAD_AUTOLOADS_EVERY_PAGE_REQUEST|Jaxer.Config.CACHE_USING_SOURCE_CODE

static DISPLAY_ERRORS : Boolean A Boolean flag to indicate whether errors should be displayed to the user. By default this is set to true, which is fit for development/debug mode only. CAUTION: In a production environment this should be set to false so that sensitive server content is not displayed to the client -- instead users will see a generic error page. | Show Details | 1.0 | no

See Also

  Jaxer.Config.RESPONSE_ERROR_PAGE|Jaxer.Config.FATAL_ERROR_PAGE

static EXPOSE_JAXER : Boolean If this is true, a conventional "X-Powered-By" HTTP header is added to every response processed by Jaxer indicating that is was processed by Jaxer and giving the Jaxer version. This is set to false by default for added security. | No Details | 1.0 | no

static EXTENSIONS_DIR : String The folder containing JavaScript extension scripts. All JavaScript files in this folder will be loaded on startup after the Jaxer framework. | No Details | 1.0 | no

static FATAL_ERROR_PAGE : String Contains the path (including filename) of the html file to be displayed instead of the detailed error message when a fatal error occurs, if Jaxer.Config.DISPLAY_ERRORS is set to false (i.e. in production mode). By default this is "resource:///content/fatalError.html", and if it is not set a default HTML string is used. | Show Details | 1.0 | no

See Also

  Jaxer.Config.RESPONSE_ERROR_PAGE|Jaxer.Config.DISPLAY_ERRORS

static FRAMEWORK_DB : Object
Contains the parameters for a connection object of one of the supported DB implementations. At the very least, the IMPLEMENTATION property must be defined and be the name of one of the supported implementations in the DB namespace (e.g. "SQLite", "MySQL"). The remaining parameters have all the information required to connect to the database. This will be used for the Jaxer framework's internal persistence needs. It defaults to using SQLite. This property is best managed in the local_jaxer/conf/config.js which will not be overwritten by subsequent jaxer updates. Changes in that file will get picked up automatically on restart.

No Details

1.0

no

static FRAMEWORK_DIR : String Indicates where to find the framework content, usually a mozilla resource url relative to the jaxer executable install folder. By default it is "resource:///framework" | No Details | 1.0 | no

static FRAMEWORK_FILE_NAME : String The name of the JavaScript file containing the Jaxer framework code. By default it is "serverFramework.js". It is located in the folder indicated by Jaxer.Config.FRAMEWORK_DIR | No Details | 1.0 | no

static INCLUDE_ERRORS_ARE_RESPONSE_ERRORS : Boolean A flag to indicate whether errors during fetching of a file to be included are to be handled as response errors, e.g. using the response error page. By default this is true. | Show Details | 1.0 | no

See Also

  Jaxer.Config.RESPONSE_ERROR_PAGE|Jaxer.Config.DISPLAY_ERRORS

static LIBRARY_FILE_NAMES : String Additional libraries to load on Jaxer startup. Multiple library names should be separated by spaces, commas, or semicolons. By default this is "JSLib.js". | No Details | 1.0 | no

static LOCAL_CONF_DIR : String Contains the path to the folder containing local variants of the various Jaxer config-type files, which will override settings in the corresponding default files. The local files will not be overwritten by a Jaxer update. Relative paths should be anchored from the Jaxer executable folder. | Show Details | 1.0 | no

Examples
  "../local_jaxer/conf"
See Also

  Jaxer.System.executableFolder

static LOCAL_CONFIG_LOADED : Boolean A flag that indicates (by convention) that the local config file was loaded during startup. | No Details | 1.0 | no

static LOCAL_EXTENSIONS_DIR : String Contains the path (including filename) to the local folder containing JavaScript extension scripts. All JavaScript file in this folder will be loaded on startup after the Jaxer framework. Relative paths should be anchored from the Jaxer executable folder. | Show Details | 1.0 | no

See Also

  Jaxer.System.executableFolder|Jaxer.Config.EXTENSIONS_DIR

static LOG_FILE_NAME : String Contains the name of the log file to use if Jaxer.Config.USE_CORE_LOG_FILE is set to false. By default this is neither set nor used. | Show Details | 1.0 | no

See Also

  Jaxer.Config.USE_CORE_LOG_FILE

static MOZ_PREFS : Object To set any of Mozilla preferences, add properties to Jaxer.Config.MOZ_PREFS. The name of each property should correspond exactly to the Mozilla preference, and the value should be an integer, boolean, or string. To see some of the available options, launch Firefox and browse to about:config | No Details | 1.0 | no

static RELOAD_AUTOLOADS_EVERY_PAGE_REQUEST : Boolean
When true, the Jaxer framework will force reloading from source every script tag marked with autoload="true" during every request to the page (not during callbacks), rather than using the cached version which is refreshed only on server restart. This is intended for use while developing, as it allows you to edit autoloaded file and see the changes without restarting Jaxer. This is set to "true" by default and should be overridden to "false" for production.

No Details

1.0

no

static RESPONSE_ERROR_PAGE : String Contains the path (including filename) of the html file to be displayed instead of the detailed error message when a response error occurs, if Jaxer.Config.DISPLAY_ERRORS is set to false (i.e. in production mode). By default this is "resource:///content/responseError.html", and if it is not set a default HTML string is used. | Show Details | 1.0 | no

See Also

  Jaxer.Config.FATAL_ERROR_PAGE|Jaxer.Config.DISPLAY_ERRORS

static REWRITE_RELATIVE_URL : String
To include scripts, access files, and so on, Jaxer may need to fetch content from the web server. If your web server needs to be reached via a different domain/port than the incoming request, uncomment and change the following to replace the protocol://domain:port with this value. For example, setting it to "http://192.168.0.1:8082" will mean that Jaxer will request content from your web server using the IP address 192.168.0.1 on port 8082. This is neither used nor set by default.

No Details

1.0

no

static REWRITE_RELATIVE_URL_REGEX : String
A regular expression used to test the requested url and determine whether or not to apply the Jaxer.Config.REWRITE_RELATIVE_URL If this is not set, and Jaxer.Config.REWRITE_RELATIVE_URL is set, then all requests to the web server are rewritten using Jaxer.Config.REWRITE_RELATIVE_URL. For example, setting it to "^http\\:\\/\\/my.domain.com" will mean that Jaxer will request content from your web server using Jaxer.Config.REWRITE_RELATIVE_URL only for URLs starting with "http://my.domain.com". This is neither used nor set by default.

Show Details

1.0

no

See Also

  Jaxer.Config.REWRITE_RELATIVE_URL

static REWRITE_TO_FILE_URL_REGEX : RegExp If a URL matches this regular expression, it will be treated as a file URL even when resolved for Web-type operations such as within script tags, in Jaxer.load(), or in Web.get(). This is useful for accessing files that reside the jaxer-include folder which are protected from being served out by the web server. | No Details | 1.0 | no

static UNCAUGHT_ERRORS_ARE_RESPONSE_ERRORS : Boolean A flag to indicate whether uncaught JavaScript errors are to be handled as response errors, e.g. using the response error page. By default this is true. | Show Details | 1.0 | no

See Also

  Jaxer.Config.RESPONSE_ERROR_PAGE|Jaxer.Config.DISPLAY_ERRORS

static USE_CORE_LOG_FILE : Boolean A boolean flag to indicate whether to use the Jaxer core logfile for framework and application logging. By default this is true. | Show Details | 1.0 | no

See Also

  Jaxer.Config.LOG_FILE_NAME

aptana_docs