Extensions

Lucee Extensions add additional functionality, such as tags or functions, JDBC support or admin plugins

Guides

  • Extension Provider ### Creating an extension for Lucee 3.1 ### For this exercise in building a Lucee Extension, we're going to be building one for MangoBlog. [Mango Blog](http://www.mangoblog.org/) is a cool open source blog application written by [Laura Arguello](http://www.asfusion.com/). This tutorial is a series of several entries since it covers a lot of ground
  • Lucee Extensions In this section, you'll find information about Lucee extensions, which provide additional functions, tags, JDBC/Cache drivers and admin plugins for Lucee Extensions can be installed via the Web or Server Admin, under Extensions, Applications. Extensions in Lucee 5 How to build Lucee 5 extensions. Admin Plugins How to build admin plugins Extension Provider Extension Provider Tutorial [Available extensions](https://download

Functions

Guides

  • Admin Plugins # Admin Plugins Lucee extensions can contribute pages to the web-based administrator that allow you to interact with the user, collection licensing details or display data. To bundle a plugin with your Lucee extension, create a directory called `plugins` in your extension. Any folders inside the plugins directory will be a plugin named after the folder name they are contained in
  • Couchdb ## CouchDB Cache Provider Extension ## The Lucee Server CouchDB Cache Provider Extension allows you to use CouchDB as a key/value cache for your Objects (components), Templates, Queries and Resources (such as files etc). CouchDB is a free and open source document-oriented database written in the Erlang programming language
  • Creating an extension (2/5) ### Creating an extension - Part 2 ### In the first part of the tutorial entry we created an extension provider for a local context which we can use in order to create our extension of choice Mango Blog. This entry will cover the collection of the necessary data in the config.xml file which is part of the installation repository
  • Creating an extension for Lucee (1/5) ``` ### Adding the extension provider to a local context ### Now you need to add the newly created ExtensionProvider.cfc to one of your local web contexts. Just go to the Lucee web admin and click on Extensions/providers and add for instance the following extension provider: ([http://localcontext/ext/ExtensionProvider.cfc](http://localcontext/ext/ExtensionProvider
  • Creating an Extension Installer (4/5) ### Writing an extension - Part 4 - The installer ### After we have created and validated the configuration data, we should now finally install the software. The install method gives you the possibility to do nearly whatever you like within the Lucee boundaries. In order to have some support methods available you can extend some existing helper CFC's
  • Extension Installation Applications** ![Extension](assets/images/screenImages/Extension.png) Here we you can see the extension which is installed and not installed. For installed extension if we have a update for the extension it simply showing with the label update, while clicking the extension it redirect to detail page of the extension ![Extension Details](assets/images/screenImages/Extension_Detail
  • Extensions in Lucee 5 Application` section. If you add the file to the `/lucee-server/deploy/` folder, you might need to wait a little bit, it can take Lucee up to a minute to recognize and install the extension. After the extension disappears from the 'deploy' directory it is installed. If you now go to the Lucee Server Admin and to the `Extension -> Application` section, you should see it there as installed
  • Membase ### Membase Cache Provider Extension ### The Lucee Server Membase Cache Provider Extension allows you to use Membase as a key/value cache for your Objects (components), Templates, Queries and Resources (such as files etc). NorthScale Membase Server is an elastic key-value database that stores web application data far more efficiently and cost effectively than it can be stored in a relational database
  • Mongodb ## MongoDB Cache Provider Extension ## The Lucee Server Mongo Cache Provider Extension allows you to use MongoDB as a key/value cache for your Objects (components), Templates, Queries and Resources (such as files etc). MongoDB is an open source, scalable, high-performance, schema-free, document-oriented database written in the C++ programming language
  • Websocket gateway ### WebSockets Gateway Extension ### This extension enables you to launch a server that is capable to manage messaging from HTML WebSockets. The server runs on a dedicated port. Lucee will receive notifications when a connection is opened, closed and any time a message is sent invoking a cfc listener class. The gateway can also being invoked via SendGatewayMessage so to allow your app to push message to all the connected clients
  • Writing an extension (3/5) ### Writing a Lucee extension - Part 3 ### After we have created the provider and created the form, we now want to validate the form so that one can check for different circumstances in the form editing. So whether combinations of fields are allowed only or similar other checks. For this you can use the method called validate of the install
  • Writing an extension (5/5) ### Writing an extension - Part IV - Tips and tricks ### We have completely built an extension from scratch and created the form to enter the data and validate it with the help of the install.cfc methods. The install method in there finally installs the application. In order to work quite fast when creating an extension there are a couple of things that might help