Skip to main content

ColdFusion 10: REST settings in Application.cfc

There are a couple of variables that have been introduced in Application.cfc which are REST specific. These are this.restsettings.cfclocation and this.restsettings.skipCFCWithError. If you have a list of directories containing REST enabled CFCs then you can specify the same in the variable this.restsettings.cfclocation. At the time of registration, the specified directories and its subdirectories will be scanned for REST enabled CFCs and then deployed. If any of these CFCs contain compilation errors then an error is thrown and the registration would fail. To tackle this another variable this.restsettings.skipCFCWithError is provided. When set to true, the CFCs with compilation errors would be skipped. Only those without any compilation errors would be deployed successfully.

Consider this directory structure containing REST CFCs:

REST_ApplicationSettings

Here the directories cfcdir1 and cfcdir2 contain REST enabled CFCs. The CFC - Service2.cfc contains compilation errors. The Application.cfc directory under appcfc contains these settings:

<cfcomponent> <cfset this.name="restappcfc"> <cfset this.restsettings.cfclocation = "./cfcdir1,./cfcdir2"> <cfset this.restsettings.skipcfcwitherror = true> </cfcomponent>

The setting this.restsettings.cfclocation contains a list of directories separated by a comma. The directory path can be either absolute or relative path. When the setting this.restsettings.skipcfcwitherror is set to true, the CFC containing compilation errors would be ignored. In this case the CFC – Service2.cfc would be ignored. When the same is set to false, the application wouldn’t be registered and an error message would be displayed. By default it is set to false and hence an error would be thrown while registering the application.

One more thing to note is that, only the directories specified in this.restsettings.cfclocation will be made available as REST services i.e. if there is a CFC in the same directory as Application.cfc then it would not be considered. The current directory needs to be specified explicitly in this setting (this.restsettings.cfclocation = “./cfcdir1,./cfcdir2,.”).

You can download the sample code here.

Comments

Popular posts from this blog

De-obfuscating javascript code in Chrome Developer Tools

I had blogged about JavaScript debugging with Chrome Developer Tools  some time back, wherein I have explained how these developer tools can help in debugging javascript code. Today Google Chrome 12 was released and my Chrome browser was updated to this version. As with every release, there have been some improvements made on performance, usability etc,. One feature that stood out for me is the ability to De-obfuscate the javascript code. What is Minification? Minification is the process of removing unnecessary characters such as white spaces, comments, new lines from the source code. These otherwise would be added to make the code more readable. Minifying the source code helps in reducing the file size and thereby reducing the time taken to download the file. This is the reason why most of the popular javascript libraries such as jQuery are minified. A minified jQuery file is of 31 KB in size where as an uncompressed one is about 229 KB. Unfortunately, debugging minified javascript f

Adding beforeRender and afterRender functions to a Backbone View

I was working on a Backbone application that updated the DOM when a response was received from the server. In a Backbone View, the initialize method would perform some operations and then call the render method to update the view. This worked fine, however there was scenario where in I wanted to perform some tasks before and after rendering the view. This can be considered as firing an event before and after the function had completed its execution. I found a very simple way to do this with Underscore's wrap method.

On GraphQL and building an application using React Apollo

When I visualize building an application, I would think of using React and Redux on the front-end which talks to a set of RESTful services built with Node and Hapi (or Express). However, over a period of time, I've realized that this approach does not scale well when you add new features to the front-end. For example, consider a page that displays user information along with courses that a user has enrolled in. At a later point, you decide to add a section that displays popular book titles that one can view and purchase. If every entity is considered as a microservice then to get data from three different microservices would require three http  requests to be sent by the front-end app. The performance of the app would degrade with the increase in the number of http requests. I read about GraphQL and knew that it is an ideal way of building an app and I need not look forward to anything else. The GraphQL layer can be viewed as a facade which sits on top of your RESTful services o