APACHE SLING & FRIENDS TECH MEETUP

BERLIN, 22-24 SEPTEMBER 2014

Lazy AEM developer

Feike Visser, Adobe, @heervisscher
 Sling Models & Sightly in Action

adaptTo() 2014 2
 Introduction to Sling Models / Sightly

adaptTo() 2014 3
 What is Sling Models

 Creating an adaptable class from a POJO by annotations

Resource r = getResource();
return r.adaptTo(YourCustom.class);

@Model(adaptables = Resource.class)
public class YourCustom {
...
}

adaptTo() 2014 4
 What is Sling Models

 The ‘old-days’….
@Component
@Service
@Properties({
@Property(name = "adaptables", value = {"Resource" }),
@Property(name = "adapters", value = {"YourCustom" })
})
public class MyAdapterFactory implements AdapterFactory{
public <AdapterType> AdapterType
getAdapter(final Object adaptable, Class<AdapterType> type){
return new MyClassAdapter(adaptable);
}
}
adaptTo() 2014 5
 What is Sling Models

 Injecting
@Model(adaptables = Resource.class)
public class YourCustom {
@Inject // we expected always an email-property
private String email;

@Inject @Optional // firstname can be empty

private String firstName;

// read property ‘surname‘ if empty, use ‘empty‘

@Inject @Named(“surname“) @Default(values=“empty“)
private String lastName;
}
adaptTo() 2014 6
 What is Sling Models

@Model(adaptables = Resource.class)
public class YourCustom {
@Inject // OSGi Service
private Externalizer externalizer;

@PostConstruct
protected void init() {
// gets executed after the class is created
// set to protected, so it can be unit-tested
}
}

adaptTo() 2014 7
 What is Sling Models

@Model(adaptables = Resource.class)
public class YourCustom {

@Self //(available in 1.1.10)

private Resource resource;

public YourCustom(Resource resource) {

// to get access to the adaptor
this.resource = resource;
}
}

adaptTo() 2014 8
 Sling Models

Before After

adaptTo() 2014 9
 What is Sling Models

 Available in AEM6
 Can be installed in CQ5.6.1
 http://sling.apache.org/documentation/bundles
/models.html
 Updates: http://bit.ly/sling-models-package

adaptTo() 2014 10
 What is Sightly

 Use HTML5-attributes to implement basic logic

<div data-sly-test=“${wcmmode.edit}“>
Show this in edit mode...
</div>

adaptTo() 2014 11
 What is Sightly

 Standard bindings are available

<h2>${currentPage.title}</h2>
<h3>${pageProperties.jcr:title || ‘No title‘}</h3>
<h4>${properties[‘address/officeName‘]}</h4>
<ul data-sly-list=“${currentPage.listChildren}“>
<li>Page title: ${item.title}</li>
</ul>

adaptTo() 2014 12
 What is Sightly

 Basic comparisons are available

<h2>${currentPage.title}</h2>

<div data-sly-test=“${ (currentPage.title == ‘test‘) }“>

// show the parsys when the title is test
<div data-sly-resource=“${ ‘par‘
@ resourceType=‘foundation/components/parsys‘“>
</div>
</div>

adaptTo() 2014 13
 What is Sightly

 What about non-basic logic?

<div data-sly-use.sample=“com.yourproject.YourComponent“>
// display the value from the Java-class
${ sample.myCustomValue }
</div>

1. Class extends WCMUse-class

2. Class implements Use-interface
3. Class is adaptable from Resource
4. Class is adaptable from Request

adaptTo() 2014 14
 What is Sightly

JSP Sightly

adaptTo() 2014 15
 What is Sightly

 Available since AEM6

 Name your component file .html
 No need to include anything like ‘global.jsp’
 No taglibs
 Compiled code is in /var/classes/sightly
 http://docs.adobe.com/docs/en/aem/6-
0/develop/sightly.html

adaptTo() 2014 16
 How Sling Models and Sightly meet?

adaptTo() 2014 17
 How Sightly and Sling Models meet?

 data-sly-use does the trick with a class adaptable from

Resource or Request
<div data-sly-use.myClass=”mysite.myproject.HeaderComponent”>

${ myClass.fullName }

</div>

adaptTo() 2014 18
 How Sightly and Sling Models meet?

@Model(adaptables = Resource.class)
public class HeaderComponent {

@Inject @Default(values=“Feike“)
public String firstName; // maps to property firstName

public String fullName;

@PostConstruct
protected void init() {
fullname += firstName + “ Visser“;
}

adaptTo() 2014 19
 How Sightly and Sling Models meet?

 Can we pass in parameters?

<div data-sly-use.myClass=”${ ‘mysite.myproject.HeaderComponent‘ @
param1=currentPage, param2=‘advanced‘ }”>

${ myClass.fullName }

</div>

Only works if class is adaptable from Request

adaptTo() 2014 20
 How Sightly and Sling Models meet?

@Model(adaptables = SlingHttpServletRequest.class)
public class HeaderComponent {

@Inject
public Page param1; // maps to param1 parameter

@Inject
public String param2; // maps to param2 parameter

adaptTo() 2014 21
 How Sightly and Sling Models meet?

 Can we re-use the bindings?

${ currentPage.title }
${ pageProperties.jcr:title }

@Model(adaptables = SlingHttpServletRequest.class)
public class HeaderComponent {

@Inject
public Page currentPage; // maps to currentPage binding

adaptTo() 2014 22
 How Sightly and Sling Models meet?

 Common sense still applies, only write code if needed

<div data-sly-use.person=“project.Person“>
${person.firstName}
</div>

<div>
${properties.firstName}
</div>

adaptTo() 2014 23
 Example: Lat-Long component

adaptTo() 2014 24
 Lat-long component

 User enters address, lat+long is displayed

<div class="address" data-sly-use.geocode="components.LatLongComponent">

<div class="latlong">
Lat : ${geocode.coordinates.lat},
Long : ${geocode.coordinates.lng}
</div>
</div>

adaptTo() 2014 25
 Lat-long component
@Model(adaptables=Resource.class)
public class LatLongComponent {
@Inject @Named("address") @Default(values=DEFAULT)
protected String addressDescription;

@Inject // Injecting Service here

private GeocodeProvider geocode;

@PostConstruct
protected void init() throws AddressException {
coordinates = geocode.geocode(addressDescription);
}
}

adaptTo() 2014 26
 Lat-long component

 Sightly supports different ways to access props

<div class="address" data-sly-use.geocode="components.LatLongComponent">
<div class="latlong">
Lat : ${geocode.coordinates.lat},
Long : ${geocode.coordinates.getLng}
</div>
<div class="addressDescrption"
data-sly-text="${properties.address || geocode.DEFAULT}">
</div>
</div>

adaptTo() 2014 27
 Example: Absolute URL

adaptTo() 2014 28
 Absolute URL

 Render the absolute url of the current-page

<meta
data-sly-use.externalizer="components.ExternalUrl"
property="og:url"
content="${externalizer.absoluteUrl @ context='uri'}.html" />

adaptTo() 2014 29
 Absolute URL
@Model(adaptables = SlingHttpServletRequest.class)
public class ExternalUrl {
@Inject
private Externalizer externalizer;

@Inject // To get the currentPage

private PageManagerFactory pageMan;

private SlingHttpServletRequest request;

public ExternalUrl(SlingHttpServletRequest request) {

// needed for the Externalizer
this.request = request;
}
}
adaptTo() 2014 30
 Absolute URL
@Model(adaptables = SlingHttpServletRequest.class)
public class ExternalUrl {
@PostConstruct
protected void init() {
String path = getCurrentPage().getPath();
absoluteUrl = externalizer.absoluteLink(request, "http", path);
}

private Page getCurrentPage() {

PageManager pm = pageMan.getPageManager(request.getResourceResolver());
return pm.getContainingPage(request.getResource());
}
}

adaptTo() 2014 31
 This is not lazy enough

 Have to code the getCurrentPage()

 Fixed to currentPage
 Not reusable enough

adaptTo() 2014 32
 Absolute URL
@Model(adaptables = SlingHttpServletRequest.class)
public class ExternalUrl {
@Inject
private Externalizer externalizer;

@Inject // Using the bindings from Sightly (${currentPage.path}

protected Page currentPage;

@Inject @Optional // parameter from data-sly-use

protected String path;

adaptTo() 2014 33
 Absolute URL
@Model(adaptables = SlingHttpServletRequest.class)
public class ExternalUrl {
@PostConstruct
protected void init() {
String relPath = currentPage.getPath();
if ( path != null) { // check if there is a parameter
relPath = path;
}
absoluteUrl = externalize(relPath);
}

protected String externalize(String path) {

return externalizer.absoluteLink(request, "http", path);
}
}
adaptTo() 2014 34
 Absolute URL

 Parameters can be specified after the @

<meta
data-sly-use.externalizer="${'components.ExternalUrl'
@ path=resourcePage.path}"
property="og:url"
content="${externalizer.absoluteUrl @ context='uri'}.html" />

adaptTo() 2014 35
 Absolute URL (unit-testing?)
@Spy
private ExternalUrl externalUrl = new ExternalUrl(null);
@Before
public void setup() {
String path = "/content/adaptTo/example";
String extPath = "http://localhost:4502/adaptTo";
doReturn(extPath).when(externalUrl).externalize(path);
}
@Test
public void testWhenNoPathParameterIsSpecified() {
externalUrl.init();
Assert.assertNotNull(externalUrl.absoluteUrl);
}

adaptTo() 2014 36
 Bindings, Bindings, Bindings

adaptTo() 2014 37
 Bindings example

 Page-oriented functionality
 Reuse the Sightly bindings
 Expose this via a custom bindings
 Use the binding in your Sling model class

adaptTo() 2014 38
 Bindings

 Custom Page-class
@Model(adaptables=Page.class)
public class MyCustomPage {

private Page page;

public String getTitle() {

return "MyProject : " + page.getTitle();
}
}

adaptTo() 2014 39
 Bindings

 Re-use Sightly binding, adding new binding

public class CustomBindingProvider implements BindingsValuesProvider {

@Override
public void addBindings(Bindings bindings) {

if ( bindings.containsKey(WCMBindings.CURRENT_PAGE)) {
Page current = (Page) bindings.get(WCMBindings.CURRENT_PAGE);
bindings.put("customPage", current.adaptTo(MyCustomPage.class));
}
}

adaptTo() 2014 40
 Bindings

 Make sure your BVP is *after* the Sightly-BVP

@Service
@Component(immediate = true)
@Properties({
@Property(name = "javax.script.name", value = "sightly"),
@Property(name = "service.ranking", intValue = 100)
})
public class CustomBindingProvider implements BindingsValuesProvider {
...
}

adaptTo() 2014 41
 Bindings

 New binding available in your components

<div>
<h1>${customPage.title}</h1>
</div>

adaptTo() 2014 42
 Bindings

 And Injectable in your Sling Model class

@Model(adaptables=SlingHttpServletRequest.class)
public class ContentComponent {

@Inject
private MyCustomPage customPage;
}

adaptTo() 2014 43
 data-sly-template example

adaptTo() 2014 44
 data-sly-template example

 Multiple page layouts

 Can be chosen by the author
 Shows the power for data-sly-template

adaptTo() 2014 45
 data-sly-template

 Can take parameters, can be in a separate file

<template data-sly-template.page="${ withParsys }">

<div class="content">
<div
data-sly-test="${ withParsys != 'false' }"
data-sly-resource="${'par' @
resourceType='foundation/components/parsys'}">
</div>
</div>
</template>

adaptTo() 2014 46
 data-sly-template

 data-sly-call invokes the template

<div
data-sly-test.layoutFile="${ properties.layout || ‘layout1.html'}"
data-sly-use.layout="${layoutFile}"
data-sly-call="${layout.page @ withParsys = 'true'}">
</div>

adaptTo() 2014 47
 (bonus) Sightly questions from the field

adaptTo() 2014 48
 If-then-else?

 Can we do an if-then-else?
<div data-sly-test.authorMode=“${wcmmode.edit || wcmmode.preview}“></div>
<div data-sly-test=“${!authorMode}“></div>

adaptTo() 2014 49
 String-concat?

 String concatenation can be done via @ format

<div
data-sly-test.concat="${ 'This is page {0}, with title {1}' @
format=[currentPage.name,currentPage.title]}">
${concat}
</div>

adaptTo() 2014 50
 data-sly-unwrap, friend or enemy?

 data-sly-unwrap *can* be used for declaration

<sightly data-sly-use.section="components.YourComponent" data-sly-unwrap/>

<sightly
data-sly-test.localVar=“${wcmmode.edit || wcmmode.preview}“
data-sly-unwrap/>

adaptTo() 2014 51
 variables

 Can I increment a counter? No…, via data-sly-use

data-sly-list offers quite a range a helper values

<div data-sly-list=“${currentPage.listChildren}“>
${itemList.index}
${itemList.count}
${itemList.first}
${itemList.last}
${itemList.odd}
${itemList.even}
</div>

adaptTo() 2014 52
 formatting

 Is there (date)-formatting? No, via data-sly-use

<div data-sly-use.dateFormat=“${‘yourClass‘ @ date=dateValue}“>
${dateFormat.formattedValue}
</div>

adaptTo() 2014 53
 Questions?

adaptTo() 2014 54