[SLING-4275] Review of the Sightly API

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: Scripting Sightly Engine 1.0.0
• Component/s: Scripting
• Assignee: Felix Meschberger
• Reporter: Carsten Ziegeler
• Created: 02/Jan/15 12:43
• Updated: 30/Mar/15 12:19
• Resolved: 19/Jan/15 16:12

Description

I have some comments about the public Sightly API:

1. There are several exceptions, like SightlyException, RuntimeExtensionException, SightlyUseException - are these really required? The API does not mention any method/interface throwing such an exception

2. RuntimeExtension and ExtensionInstance - I think we can get rid of the RuntimeExtension interface and simply pass the RenderContext in ExtensionInstance#call.

3. The purpose of the Record interface is a little bit unclear to me. In addition it has a T get(String) method while properties returns a Set<String>. I guess the engine supports a Map, so maybe we can get rid of this interface?

4. ResourceResolution seems to contain methods for getting scripts. Isn't this some functionalty the existing ServletResolver component provides? Or if not, shouldn't we move this to the Sling API?

5. Many of the methods in the RenderContext are Object traversal and value conversion methods. I think this needs to go into a separate service (and maybe package)

Sub-Tasks

• Refactor the ResourceResolution class and improve its JavaDoc: Closed
• Refactor the Record interface: Closed
• Remove redundant RuntimeExtensionException and SightlyUseException from Sightly's API: Closed
• Merge RuntimeExtension and ExtensionInstance to remove unneeded abstraction level: Closed
• Refactor the RenderContext interface to remove object traversal and object conversion methods: Closed