Skip to content

Commit

Permalink
Merge pull request #1581 from shawnoden/CF2021Updates-AppCFC
Browse files Browse the repository at this point in the history 
Cf2021 adds part? - Updated Application.cfc Params Guide #1366
  • Loading branch information
@pfreitag
pfreitag authored Oct 21, 2022
2 parents 1282338 + ca294d3 commit 2aca3a3
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions data/en/application-cfc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
"description":"Defines application level variables and event handlers (functions invoked at various application lifecycle events).",
"params": [
{"name":"this.name","description":"Name of application. Up to 64 characters","required":false,"default":"","type":"string","values":[]},
{"name":"this.loginStorage","description":"cookie: store login information in the Cookie scope.\n session: store login information in the Session scope.","required":false,"default":"cookie","type":"string","values":["cookie","session"]},
{"name":"this.loginStorage","description":"This defines where to store login information.","required":false,"default":"cookie","type":"string","values":["cookie","session"]},
{"name":"this.clientManagement","description":"Enables client variables","required":false,"default":false,"type":"boolean","values":[true,false]},
{"name":"this.clientStorage","description":"How client variables are stored\n * datasource_name: in ODBC or native data source.\n You must create storage repository in the\n Administrator.\n * registry: in the system registry.\n * cookie: on client computer in a cookie. Scalable.\n If client disables cookies in the browser, client\n variables do not work","required":false,"default":"registry","type":"string","values":["cookie","registry","datasource_name"]},
{"name":"this.setClientCookies","description":"No: CFML does not automatically send CFID and CFTOKEN\n cookies to client browser; you must manually code CFID and\n CFTOKEN on the URL for every page that uses Session or\n Client variables","required":false,"default":true,"type":"boolean","values":[true,false]},
{"name":"this.clientStorage","description":"This determines where client variables are stored.\n * datasource_name: in ODBC or native data source.\n You must create storage repository in the Administrator.\n * registry: in the system registry.\n * cookie: on client computer in a cookie. Scalable.\n If client disables cookies in the browser, client variables do not work","required":false,"default":"registry","type":"string","values":["cookie","registry","datasource_name"]},
{"name":"this.setClientCookies","description":"This determines whether to send CFID and CFTOKEN cookies to the client browser.\n * No: CFML does not automatically send CFID and CFTOKEN cookies to client browser; you must manually code CFID and CFTOKEN on the URL for every page that uses Session or Client variables","required":false,"default":true,"type":"boolean","values":[true,false]},
{"name":"this.sessionManagement","description":"Enables session variables","required":false,"default":false,"type":"boolean","values":[true,false]},
{"name":"this.sessionTimeout","description":"Lifespan of session variables. CreateTimeSpan function and\n values in days, hours, minutes, and seconds, separated by\n commas","required":false,"default":"","type":"numeric","values":[]},
{"name":"this.applicationTimeout","description":"Lifespan of application variables. CreateTimeSpan function\n and values in days, hours, minutes, and seconds, separated\n by commas.","required":false,"default":"","type":"numeric","values":[]},
{"name":"this.setDomainCookies","description":"Yes: Sets CFID and CFTOKEN cookies for a domain (not a host)\n Required, for applications running on clusters.","required":false,"default":false,"type":"boolean","values":[true,false]},
{"name":"this.scriptProtect","description":"Specifies whether to attempt to protect variables from cross-site scripting attacks.\n - none: do not protect variables\n - all: protect Form, URL, CGI, and Cookie variables\n - comma-delimited list of ColdFusion scopes: protect variables in the specified scopes","required":false,"default":"","type":"string","values":["none","all","form","url","cookie","cgi","form,url","form,url,cookie","form,url,cookie,cgi"]},
{"name":"this.sessionTimeout","description":"Lifespan of session variables. CreateTimeSpan function and values in days, hours, minutes, and seconds, separated by commas","required":false,"default":"","type":"numeric","values":[]},
{"name":"this.applicationTimeout","description":"Lifespan of application variables. CreateTimeSpan function and values in days, hours, minutes, and seconds, separated by commas.","required":false,"default":"","type":"numeric","values":[]},
{"name":"this.setDomainCookies","description":"Yes: Sets CFID and CFTOKEN cookies for a domain (not a host) Required, for applications running on clusters.","required":false,"default":false,"type":"boolean","values":[true,false]},
{"name":"this.scriptProtect","description":"Specifies whether to attempt to protect variables from cross-site scripting attacks.\n * none: do not protect variables\n * all: protect Form, URL, CGI, and Cookie variables\n - comma-delimited list of ColdFusion scopes: protect variables in the specified scopes","required":false,"default":"","type":"string","values":["none","all","form","url","cookie","cgi","form,url","form,url,cookie","form,url,cookie,cgi"]},
{"name":"this.secureJSONPrefix","description":"CF8+ The security prefix to put in front of the value that a ColdFusion function returns in JSON-format \n\t\t\t\tin response to a remote call if the secureJSON setting is true.","required":false,"default":"","type":"string","values":[]},
{"name":"this.secureJSON","description":"CF8+ A Boolean value that specifies whether to add a security prefix in front of any value that a ColdFusion function returns in JSON-format\n\t\t\t\t in response to a remote call.","required":false,"default":"","type":"boolean","values":[true,false]},
{"name":"this.customTagPaths","description":"CF8+ A comma delimited list of absolute file paths pointing to directories containing custom tags.","required":false,"default":"","type":"string","values":[]},
Expand All @@ -37,6 +37,8 @@
{"name":"this.sessioncookie.domain","description":"CF10+ Specifies the cookie domain the session cookies (CFID/CFTOKEN).","required":false,"default":"false","type":"string","values":[]},
{"name":"this.sessioncookie.timeout","description":"CF10+ Specifies the expires value of the session cookies (CFID/CFTOKEN), in days. Set to -1 for browser session cookies.","required":false,"default":"30 years","type":"string","values":[]},
{"name":"this.sessioncookie.disableUpdate","description":"CF10+ Prevents the session cookies (CFID/CFTOKEN), from being updated by cfcookie or cfheader tags.","required":false,"default":"false","type":"boolean","values":[]},
{"name":"this.sessioncookie.samesite","description":"CF2018u9+ 2016u15+ This is a security feature used to mitigate CSRF ( Cross Site Request Forgery) attacks. It tells the browser if the cookie should be sent with a cross-site request.\n* strict - prevents the cookie from being sent to the target site in all cross-browsing contexts. \n* lax - provides a balance between security and usability by maintaining a user session after user arrives from an external link. \n* none - provides no protection. \n\nNote: The default value of the SameSite attribute differs with each browser.\nSee https://owasp.org/www-community/SameSite for more info.","required":false,"default":"","type":"string","values":["Strict","Lax","None"]},
{"name":"this.authcookie.samesite","description":"CF2018u9+ 2016u15+ This is a security feature used to mitigate CSRF ( Cross Site Request Forgery) attacks. It tells the browser if the cookie should be sent with a cross-site request.\n* strict - prevents the cookie from being sent to the target site in all cross-browsing contexts. \n* lax - provides a balance between security and usability by maintaining a user session after user arrives from an external link. \n* none - provides no protection. \n\nNote: The default value of the SameSite attribute differs with each browser.\nSee https://owasp.org/www-community/SameSite for more info.","required":false,"default":"","type":"string","values":["Strict","Lax","None"]},
{"name":"this.javaSettings.loadPaths","description":"CF10+ An array of paths containing jar files or java classes.","required":false,"default":"","type":"array","values":[]},
{"name":"this.javaSettings.loadColdFusionClassPath","description":"CF10+ Loads the classes using ColdFusions classloader.","required":false,"default":"false","type":"boolean","values":[]},
{"name":"this.javaSettings.reloadOnChange","description":"CF10+ Watches the files specified in loadPaths and reloads classes on change.","required":false,"default":"false","type":"boolean","values":[]},
Expand All @@ -47,12 +49,12 @@
{"name":"this.strictNumberValidation","description":"CF11+ Makes isValid, cfargument, cfparam, and cfform more strict with regard to how the treat integer or numeric validation when the string contains a currency.","required":false,"default":"true","type":"boolean","values":[]},
{"name":"this.inMemoryFileSystem.enabled","description":"CF11+ Enables or disables in memory file system.","required":false,"default":"","type":"boolean","values":[]},
{"name":"this.inMemoryFileSystem.size","description":"CF11+ Memory limit in MB for the in memory file system.","required":false,"default":"","type":"numeric","values":[]},
{"name":"this.datasources","description":"CF11+ Create multiple an application specific datasources. This value is a structure whose keys are the name of the datasource to be created, and the values are another structure with keys such as: database, driver, host, username, password, url. Lucee / Railo also support this setting, but are configured with keys class, connectionString, username, password","required":false,"default":"","type":"struct","values":[]},
{"name":"this.datasources","description":"CF11+ This struct of structs is used to define multiple application specific datasources. This value is a structure whose keys are the name of the datasource to be created, and the values are another structure with keys such as: database, driver, host, username, password, url. Lucee / Railo also support this setting, but are configured with keys class, connectionString, username, password.\nCF2021 added MongoDB as a valid datasource type.","required":false,"default":"","type":"struct","values":[]},
{"name":"this.serialization.preserveCaseForStructKey","description":"CF11+ Preserves the case of your variable names when generating JSON using the serializeJSON function.","required":false,"default":"false","type":"boolean","values":[]},
{"name":"this.serialization.preserveCaseForQueryColumn","description":"CF11.0.5+ Preserves the case of your query column names when generating JSON using the serializeJSON function.","required":false,"default":"false","type":"boolean","values":[]},
{"name":"this.customSerializer","description":"CF11+ The name of a CFC pointing to a custom serializer. See https://helpx.adobe.com/coldfusion/developing-applications/changes-in-coldfusion/restful-web-services-in-coldfusion.html","required":false,"default":"","type":"numeric","values":[]},
{"name":"this.locale","description":"Lucee4+ The default locale used for formatting dates, numbers.","required":false,"default":"en_US","type":"string","values":[]},
{"name":"this.timezone","description":"Lucee4+ The default timezone used for date handling.","required":false,"default":"","type":"string","values":["America/Chicago","America/New_York","UTC"]},
{"name":"this.timezone","description":"Lucee4+ ACF2021+ The default timezone used for date handling.","required":false,"default":"","type":"string","values":["America/Chicago","America/New_York","UTC"]},
{"name":"this.sessionType","description":"Lucee4+ Use CFML or JEE based sessions.","required":false,"default":"","type":"string","values":["cfml","jee"]},
{"name":"this.sessionStorage","description":"Lucee4+ The name of the storage provider for session variables.","required":false,"default":"memory","type":"string","values":[]},
{"name":"this.localMode","description":"Lucee4+ Defines how the local scope of a function is invoked when a variable with no scope definition is used. When classic the local scope is only invoked when the key already exists in it, with modern the local scope is always assumed on unscoped variables.","required":false,"default":"classic","type":"string","values":["classic", "modern"]},
Expand All @@ -61,7 +63,9 @@
{"name":"this.compression","description":"Lucee4+ Enables Gzip compression on the HTTP response when true","required":false,"default":"false","type":"boolean","values":[]},
{"name":"this.passArrayByReference","description":"CF2016+ `true`: Arrays will be passed by reference instead of by value for this application.","required":false,"default":"false","type":"boolean","values":[true,false]},
{"name":"this.searchImplicitScopes","description":"CF2016+ Defines the way non-scoped variables are found.\n`false`: Only the variables, local and arguments scopes are searched.\n`true`: Default and < CF2016 behavior. All scopes are searched in the following order: local, arguments, thread local, query, thread, variables, cgi, cffile, url, form, cookie, client.","required":false,"default":"true","type":"boolean","values":[true,false]},
{"name":"this.blockedExtForFileUpload","description":"CF2018.0.3+ CF2016.0.10+ CF11.0.18+ Lucee5.2.9.36+ Lucee5.3.3.1+ 0 A comma delimited list of file extensions to be blocked from upload via cffile, fileUpload or fileUploadAll. You can specify `*` (not yet supported on Lucee) to block all extensions or use an empty string to allow all (previous behavior). If not specified the values specified in ColdFusion Administrator take precedence.", "required":false, "default":"", "type":"string", "values":[]}
{"name":"this.blockedExtForFileUpload","description":"CF2018.0.3+ CF2016.0.10+ CF11.0.18+ Lucee5.2.9.36+ Lucee5.3.3.1+ 0 A comma delimited list of file extensions to be blocked from upload via cffile, fileUpload or fileUploadAll. You can specify `*` (not yet supported on Lucee) to block all extensions or use an empty string to allow all (previous behavior). If not specified the values specified in ColdFusion Administrator take precedence.", "required":false, "default":"", "type":"string", "values":[]},
{"name":"this.security.samlsettings.idp","description":"CF2021+ Used with SAML / SSO to create/configure the Identity Provider. See https://helpx.adobe.com/coldfusion/using/saml-coldfusion.html for more detail.\nNOTE: The SAML Package must be installed.", "required":false, "default":"", "type":"array", "values":[]},
{"name":"this.security.samlsettings.sp","description":"CF2021+ Used with SAML / SSO to create/configure the Service Provider. See https://helpx.adobe.com/coldfusion/using/saml-coldfusion.html for more detail.\nNOTE: The SAML Package must be installed.", "required":false, "default":"", "type":"array", "values":[]}
],
"engines": {
"coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/application-cfc-reference.html"},
Expand All @@ -83,6 +87,11 @@
"title":"JVM flags for cfinclude CF2018u11+",
"description":"[CF2018+] -Dcoldfusion.application.recur_resolve.include=true // cfinclude inside Application.cfc will correctly resolve paths relative from the included file\n",
"url":"https://helpx.adobe.com/coldfusion/kb/coldfusion-2018-update-11.html"
},
{
"title":"SAML In ColdFusion CF2021+",
"description":"[CF2021+] Details of using SAML Services in ColdFusion.",
"url":"https://helpx.adobe.com/coldfusion/using/saml-coldfusion.html"
}
],
"examples": [
Expand Down

0 comments on commit 2aca3a3

Please sign in to comment.