Request Context

Last updated 24 days ago

On every request to a ColdBox event, the framework creates an object that models the incoming request. This object is called the Request Context Object(coldbox.system.web.context.RequestContext), it contains the incoming FORM/REMOTE/URL variables the client sent in and the object lives in the ColdFusion request scope.

Please visit the latest API Docs for further information about the request context.

This object contains two structures internally:

  1. RC - The Request Collection which contains the FORM/REMOTE/URL data merged into a single structure. This is considered to be unsafe data as it comes from any request.

  2. PRC - The Private Request Collection which is a structure that can be used to safely put data into it. This structure cannot be modified from the outside world.

The order of preference of variables when merged is FORM first then REMOTE then URL.

REMOTE variables are from leveraging the ColdBox Proxy.

You will use this object in the controller and view layer of your application to get/set values, get metadata about the request, generate URLs, transform data for RESTful requests, and so much more. It is the glue that binds the controller and view layer. As we progress in the guides, you will progress in mastering the request context.

RC/PRC Data Super Highway

Note that there is no model layer in the diagram. This is on purpose, the model will receive data from the handlers/interceptors directly.

Most Commonly Used Methods

Below you can see a listing of the mostly used methods in the request context object. Please note that when interacting with a collection you usually have an equal private collection method.

  • buildLink() : Build a link in SES or non SES mode for you with tons of nice abstractions.

  • clearCollection() : Clears the entire collection

  • collectionAppend() : Append a collection overwriting or not

  • getCollection() : Get a reference to the collection

  • getEventName() : The event name in use in the application (e.g. do, event, fa)

  • getSelf() : Returns index.cfm?event=

  • getValue() : get a value

  • getTrimValue() : get a value trimmed

  • isProxyRequest() : flag if the request is an incoming proxy request

  • isSES() : flag if ses is turned on

  • isAjax() : Is this request ajax based or not

  • noRender(boolean) : flag that tells the framework to not render any html, just process and silently stop.

  • overrideEvent() : Override the event in the collection

  • paramValue(): param a value in the collection

  • removeValue() : remove a value

  • setValue() : set a value

  • setLayout() : Set the layout to use for this request

  • setView() : Used to set a view to render

  • valueExists() : Checks if a value exists in the collection.

  • renderData() : Marshall data to JSON, JSONP, XML, WDDX, PDF, HTML, etc.

Some Samples:

//Get a reference
<cfset var rc = event.getCollection()>
//test if this is an MVC request or a remote request
<cfif event.isProxyRequest()>
<cfset event.setValue('message', 'We are in proxy mode right now')>
</cfif>
//param a variable called page
<cfset event.paramValue('page',1)>
//then just use it
<cfset event.setValue('link','index.cfm?page=#rc.page#')>
//get a value with a default value
<cfset event.setvalue('link','index.cfm?page=#event.getValue('page',1)#')>
//Set the view to render
<cfset event.setView('homepage')>
//Set the view to render with no layout
<cfset event.setView('homepage',true)>
//set the view to render with caching stuff
<cfset event.setview(name='homepage',cache='true',cacheTimeout='30')>
//override a layout
<cfset event.setLayout('Layout.Ajax')>
//check if a value does not exists
<cfif not event.valueExists('username')>
</cfif>
//Tell the framework to stop processing gracefully, no renderings
<cfset event.noRender()>
//Build a link
<form action="#event.buildLink('user.save')#" method="post">
</form>

Please see the online API Docs for the latest methods and arguments.

Request Metadata Methods

  • getCurrentAction() : Get the current execution action (method)

  • getCurrentEvent() : Get's the current incoming event, full syntax.

  • getCurrentHandler() : Get the handler or handler/package path.

  • getCurrentLayout() : Get the current set layout for the view to render.

  • getCurrentView() : Get the current set view

  • getCurrentModule() : The name of the current executing module

  • getCurrentRoutedNamespace() : The current routed URL mapping namespace if found.

  • getCurrentRoutedURL() : The current routed URL if matched.

  • getDebugpanelFlag() : Get's the boolean flag if the ColdBox debugger panel will be rendered.

  • getDefaultLayout() : Get the name of the default layout.

  • getDefaultView() : Get the name of the default view.