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.
Labels:

Comments

Post a Comment

Popular posts from this blog

File upload and Progress events with HTML5 XmlHttpRequest Level 2

The XmlHttpRequest Level 2 specification adds several enhancements to the XmlHttpRequest object. Last week I had blogged about cross-origin-requests and how it is different from Flash\Silverlight's approach .  With Level 2 specification one can upload the file to the server by passing the file object to the send method. In this post I'll try to explore uploading file using XmlHttpRequest 2 in conjunction with the progress events. I'll also provide a description on the new HTML5 tag -  progress which can be updated while the file is being uploaded to the server. And of course, some ColdFusion code that will show how the file is accepted and stored on the server directory.
18 comments
Read more

How to use the APP_INITIALIZER token to hook into the Angular bootstrap process

I've been building applications using Angular as a framework of choice for more than a year and this post is not about another React vs Angular or the quirks of each framework. Honestly, I like Angular and every day I discover something new which makes development easier and makes me look like a guy who built something very complex in a matter of hours which would've taken a long time to put the correct architecture in place if I had chosen a different framework. The first thing that I learned in Angular is the use of the APP_INITIALIZER token.
Post a Comment
Read more

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...
Post a Comment
Read more