Writing extensions

When you want your application to be easily installable you have to write an installer for it. So why aren't you writing a Railo extension for it. The Railo Extension API explains how Railo extensions are structured and how you can build your own extension.

Why should I write an extension for my application?

If you write an extension for your existing application, or convert your installer to be Railo Extension compatible, you gain several benefits:

 

  • Easy to share applications/extensions
    Depending whether you want Railo to check the application, the extensions you have uploaded, will be instantly available to all Railo users.
  • No advertising necessary
    Just write your ad text, record a video set up some advertising pages and you're done. All Railo users can/will see your ad text as soon as they hit the detail link of your extension in the Railo administrator.
  • All Railo users see your applications
    The applications listed in the Extension Manager are downloaded online. So as soon as a new application is available online, all user see it instantaneously.
  • Update easy to maintain
    Since the Railo Extension API offers you an update method you can control how your application is updated.
  • One global resource
    All installed Railo Extension Providers are queried, when the list of available applications is generated.
  • No installation manual necessary
    Since the API generates an easy to understand installation wizard, no installation manual is necessary

If you have several customers that perhaps have bought your product, you can easily provide updates for them with the help of the Railo Extension Manager. Every customer instantly sees whether there is an update available for your product or not. All installed applications and extensions are visible on the top of the Extension Manager.

How do I write an extension?

  • Follow the API
  • Test your extension on your local Railo installation
    You can write your own local Railo Extension Provider and hardcode the local path to the extension you are writing. In this way you can easily test your extension by simulating a live resource.
  • Upload it to the official Railo Provider
    Use the Extension application on this site in order to upload it to our Extension Provider. You can select whether you want us to check your applications extension implementation or not. Depending on the check you will eiter receive a "Railo checked" icon or not.
  • Add it to any Extension Provider
    If you know any other Railo extension provider, just use their upload frontend in order to upload it there. Please note that these providers are not listed in the Railo admin by default.
  • Or create your own provider
    You can always create your own provider and advertize it in order for Railo users to add it in their Railo administrators.

You can find the complete documentation of the Extension manager API in the Railo Wiki. It will explain:

  • Extension Manager
  • Extension Provider (web service)
  • Extension consumer
  • install.cfc
  • config.xml
  • Dynamic content
  • Extension CFCs Matrix
  • Support components
  • Tips and tricks

 Just write your own extension, upload it to the Railo extension repository and start making some money!