ColdFusion 9.0 Resources |
cfapplicationDescriptionDefines the scope of a ColdFusion application; enables and disables storage of Client variables; specifies the Client variable storage mechanism; enables Session variables; and sets Application variable time-outs. Syntax<cfapplication datasource="data_source_name" name = "application name" applicationTimeout = #CreateTimeSpan(days, hours, minutes, seconds)# clientManagement = "yes|no" clientStorage = "data_source_name|Registry|Cookie" loginStorage = "cookie|session" googleMapKey = "map key" scriptProtect = "none|all|list" serverSideFormValidation = "yes|no" sessionManagement = "yes|no" sessionTimeout = #CreateTimeSpan(days, hours, minutes, seconds)# setClientCookies = "yes|no" setDomainCookies = "yes|no"> Note: You
can specify this tag’s attributes in an attributeCollection whose value
is a structure. Specify the structure name in the attributeCollection and
use the tag’s attribute names as structure keys.
See alsocfassociate, cferror, cflock, cfmessagebox; Application.CFC Reference; Designing and Optimizing a ColdFusion Application and Integrating J2EE and Java Elements in CFML Applications in the Developing ColdFusion Applications HistoryColdFusion 9: Added datasource, googleMapKey, and serverSideFormValidation attribute ColdFusion 8: Added secureJSON and SecureJSONPrefix attributes ColdFusion MX 7: Added scriptProtect attribute ColdFusion MX 6.1: Added loginStorage attribute ColdFusion MX:
Attributes
UsageThis tag is typically used in the Application.cfm file, to set defaults for a ColdFusion application. Note: You can also set
the application defaults in the Application.cfc file. For more information,
see Application variables.
This tag enables application variables, unless they are disabled in the ColdFusion Administrator. The Administrator setting also overrides the sessionManagement attribute. For more information, see Configuring and Administering ColdFusion. If ColdFusion is running on a cluster, specify clientStorage = "cookie" or a data source name; you cannot specify "registry". ColdFusion generates an error if the application name is longer than 64 characters. The CFTOKEN variable is 8 bytes in length. Its range is 10000000 —99999999. Note: If you specify ClientStorage=cookie,
any Client scope variables set following a cfflush tag
are not saved in the Client browser.
Protecting variables from cross-site scripting attacksThe ScriptProtect attribute lets you protect one or more variable scopes from cross-site scripting attacks, where a client attempts to get your application to send malicious code back to a user’s browser. In these attacks, user input (for example, from form fields or from URL variables) sets a CF variable which is destined for user output. The submitted data includes malicious code, such as JavaScript or an applet or object reference, which then executes on the user’s system. Note: The ColdFusion Administrator Settings page Enable
Global Script Protection option determines the default script protection
setting. You can use the scriptProtect attribute
to override the Administrator setting. You can also use the Application.cfc
initialization code to set the protection value.
The ColdFusion cross-site scripting protection operation is done when ColdFusion processes the application settings at the beginning of a request. Thus, it can process the URL, and Cookie, CGI, and Form variables in a user’s request. By default, it replaces occurrences of the following HTML tag names with the text InvalidTag: object, embed, script, applet, and meta. It allows these names in plain text, and replaces the words if they are used as tag names. You can specify any or all ColdFusion scopes for protection, but only the Form, URL, CGI, and Cookie scopes have variables that are often provided by unknown sources. Also, protecting a scope requires additional processing. For these reasons, the all attribute value applies protection to only the four scopes. The script protection mechanism applies a regular expression that is defined in the cf_root/lib/neo-security.xml file in the server configuration, or the cf_root/WEB-INF/cfusion/lib/neo-security.xml file in the J2EE configuration to the variable value. You can customize the patterns that ColdFusion replaces by modifying the regular expression in the CrossSiteScriptPatterns variable. Locking server, application, and session variablesWhen you set or update variables in the server, application, and session scopes, use the cflock tag with the scope attribute set to the following value:
In some cases, you must also lock code that reads variables in these scopes. For information about locking scopes, see cflock. Example<!--- This example shows how to use cflock to prevent race conditions during data updates to variables in Application, Server, and Session scopes. ---> <h3>cfapplication Example</h3> <p>cfapplication defines scoping for a ColdFusion application and enables or disables application and/or session variable storage. This tag is placed in a special file called Application.cfm that automatically runs before any other CF page in a directory (or subdirectory) where the Application.cfm file appears.</p> <cfapplication name = "ETurtle" sessionTimeout = #CreateTimeSpan(0, 0, 0, 60)# sessionManagement = "Yes"> <!--- Initialize session and application variables used by E-Turtleneck. ---> <cfparam name="application.number" default="1"> <cfparam name="session.color" default= ""> <cfparam name="session.size" default=""> <cfif IsDefined("session.numPurchased") AND IsNumeric(trim(session.cartTotal))> <!--- Use the application scope for the application variable to prevent race condition. This variable keeps track of total number of turtlenecks sold. ---> <cflock scope = "Application" timeout = "30" type = "Exclusive"> <cfset application.number = application.number + session.numPurchased> </cflock> </cfif> <cfoutput> E-Turtleneck is proud to say that we have sold #application.number# turtlenecks to date. </cfoutput> <!--- End of Application.cfm ---> |