Application Router

Master Class Video Training Community Support
Search…
Application Router
Every ColdBox application has a URL router and can be located by convention at config/Router.cfc.  This is called the application router and it is based on the router core class: coldbox.system.web.routing.Router.  Here is where you will configure router settings and define routes using our routing DSL.
Please see the latest API Docs for investigating all the methods and properties of the Router.
Tip: Unlike previous versions of ColdBox, the new routing services in ColdBox 5 are automatically configured to detect the base URLs and support multi-domain hosting. There is no more need to tell the Router about your base URL.
Application Router - Router.cfc
config/Router.cfc
1
component {
2
​
3
	function configure() {
4
		// Set Full Rewrites
5
		setFullRewrites( true );
6
​
7
		/**
8
		 * --------------------------------------------------------------------------
9
		 * App Routes
10
		 * --------------------------------------------------------------------------
11
		 *
12
		 * Here is where you can register the routes for your web application!
13
		 * Go get Funky!
14
		 *
15
		 */
16
​
17
		// A nice healthcheck route example
18
		route( "/healthcheck", function( event, rc, prc ) {
19
			return "Ok!";
20
		} );
21
​
22
		// A nice RESTFul Route example
23
		route( "/api/echo", function( event, rc, prc ) {
24
			return {
25
				"error" : false,
26
				"data"  : "Welcome to my awesome API!"
27
			};
28
		} );
29
​
30
		route(
31
			pattern : "/api/contacts",
32
			target  : "contacts.index",
33
			name    : "api.contacts"
34
		);
35
​
36
		// Conventions based routing
37
		route( ":handler/:action?" ).end();
38
	}
39
​
40
}
41
​
Copied!
The application router is a simple CFC that virtually inherits from the core ColdBox Router class and is configured via the configure() method.  It will be decorated with all the capabilities to work with any request much like any event handler or interceptor.  In this router you will be doing 1 of 2 things:
1.Configuring the Router
2.Adding Routes via the Routing DSL
Router as an Interceptor
The router and indeed all module routers are also registered as full fledged ColdBox interceptors. So they can listen to any event within your application.
Generated Settings
Once the routing service loads your Router it will create several application settings for you:
SesBaseUrl : The multi-domain URL base URL of your application: http://localhost
SesBasePath : The multi-domain path with no protocol or host
HtmlBaseUrl : The same path as SESBaseURLbut without any index.cfm in it (Just in case you are using index.cfm rewrite). This is a setting used most likely by the HTML <base> tag.
HtmlBasePath : Does not include protocol or host
Configuration Methods
You can use the following methods to fine tune the configuration and operation of the routing services:
Method
Description
setEnabled( boolean )
Enable/Disable routing, enabled by default
setFullRewrites( boolean )
If true, then no index.cfm will be used in the URLs. If false, then /index.cfm/ will be added to all generated URLs. Default is false.
setUniqueURLS( boolean )
Enables SES only URL's with permanent redirects for non-ses urls. Default is true.  If true and a URL is detected with ? or & then the application will do a 301 Permanent Redirect and try to translate the URL to a valid SES URL.
setBaseURL( string )
The base URL to use for URL writing and relocations. This is automatically detected by ColdBox 5 e.g. http://www.coldbox.org/, http://mysite.com/index.cfm''
setLooseMatching( boolean )
By default URL pattern matching starts at the beginning of the URL, however, you can choose loose matching so it searches anywhere in the URL. Default is false.
setMultiDomainDiscovery( boolean )
Defaults to true.  With this setting on, every request will be inspected for the incoming host for usage in building links and domain detection.
setExtensionDetection( boolean )
By default ColdBox detects URL extensions like json, xml, html, pdf which can allow you to build awesome RESTful web services. Default is true.
setValidExtensions( list )
Tell the interceptor what valid extensions your application can listen to. By default it listens to: json, jsont, xml, cfm, cfml, html, htm, rss, pdf
setThrowOnInvalidExtensions( boolean )
By default ColdBox does not throw an exception when an invalid extension is detected. If true, then the interceptor will throw a 406 Invalid Requested Format Extension: {extension} exception. Default is false.
​
1
function configure(){
2
​
3
    setFullRewrites( true );
4
    setExtensionDetection( true );
5
    setValidExtensions( "json,cfm,pdf" );
6
    setMultiDomainDiscovery( false )
7
​
8
}
Copied!
The next sections will discus how to register routes for your application.
Rewrite Rules
Routing DSL
Last modified 1yr ago
Copy link
Edit on GitHub
Contents
Application Router - Router.cfc
Router as an Interceptor
Generated Settings
Configuration Methods