Accessing Request Variables in Sightly

Published on by Dan KlcoPicture of Me Dan Klco

You can implement some interesting stuff in Sightly, the newest templating language for Adobe Experience Manager, including Tower of Hanoi.  At the same time, there are a few practical applications which are not available in Sightly, including accessing request scoped variables in Sightly.  While Gabriel's suggested approaches in the Stack Overflow post are absolutely correct in this situation, there are still certain situations where request variables can be very useful.  

A good example is for sharing a variable across multiple components which is expensive to retrieve.  This could be the results of a database query or web service call, pretty much anything you'd need on multiple components, but don't want to keep fetching.  Using the naive approach of re-retrieving the value for each component using the same data on a page, can drastically increase the amount of time required to serve a request.

Currently, your options for accessing request variables in Sightly are:

Pass Data Through Selectors / Suffix

This is one the appraches described by Gabriel and is a good approach for small string properties, however it assumes that you will not be using selectors for rendering purposes and is not useful for any more complicated data structure.  Generally, the use of selectors should be defined at a project level.  In fact, it is a common requirement to only allow specific selectors, as selectors could potentially be used as a form of DDOS attack for generating server load or causing a server to fill up due to a large number of requests with unique selectors.

Store Data in the JCR

Another approach again suggested by Gabriel is to just access variables from other JCR nodes.  This is a very good approach for data which can be persisted into the JCR, but isn't practical for complex data structures or transactional results.  Additionally, there are some limitations around resource traversal in Sightly which can make this option difficult.

Build a Use-API Class

Sightly provides the Use-API for injecting custom beans into the Sightly template.  This is a valid option, but requires custom development for any variable access.

A Better Solution

Instead of the options above, it would be better to create a general purpose solution.  The solution below uses a Sling Adapter to adapt SlingHttpServletRequests into an instance of a map with the keys and values being request attributes.  This implementation should work in nearly any environment, but if you are using Sling Models in your project, you can make it a model instead to not require a separate AdapterFactory class.

Once you have this in place, you can use the the RequestAttr map to retrieve the request attribute values as such:

<div data-sly-use.requestAttr="com.sixd.sly.RequestAttr"></div>
<h1>Inner Sightly ${requestAttr.key}</h1>

Hopefully, this post helps show you the different options for sharing data between components in Sightly and how with some clever use of Adapters or Models you can really unlock the potential of Sightly.  If you have any questions or corrections, please leave a comment below!


comments powered by Disqus