LDAP integration with AEM6 (OSGi Config way)

In AEM 6, LDAP support comes with a new implementation that requires a different type of configuration than with previous versions.

All LDAP configurations are now available as OSGi configurations. They can be configured via the Web Management console at:

http://serveraddress:4502/system/console/configMgr

The required config classes are listed below.

1. org.apache.jackrabbit.oak.security.authentication.ldap.impl.LdapIdentityProvider
2. org.apache.jackrabbit.oak.spi.security.authentication.external.impl.DefaultSyncHandler
3. org.apache.jackrabbit.oak.spi.security.authentication.external.impl.ExternalLoginModuleFactory. 

The configs can be updated manually via OSGi console or via deployment. We can use the follow steps & config files to add/update an LDAP provider.

Create OSGi config file of type  "sling:OsgiConfig" & name it to 
"org.apache.jackrabbit.oak.security.authentication.ldap.impl.LdapIdentityProvider.xml". 

See here for reference.

	<?xml version="1.0" encoding="UTF-8"?>
	<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"
	jcr:primaryType="sling:OsgiConfig"
	bind.dn = "cn=Directory Manager" bind.password = "******" group.baseDN = "ou=groups,dc=example,dc=com"
	group.memberAttribute = "uniquemember" group.nameAttribute = "cn" group.objectclass = "[groupOfUniqueNames]"
	host.name = "localhost" host.port = "389" host.ssl = "false" host.tls = "false" provider.name = "ldap"
	user.baseDN = "ou=users,dc=example,dc=com" user.idAttribute = "uid" user.objectclass = "[inetorgPerson]" />

view raw org.apache.jackrabbit.oak.security.authentication.ldap.impl.LdapIdentityProvider.xml hosted with ❤ by GitHub

Similarly create two more config files & name them as below.

org.apache.jackrabbit.oak.spi.security.authentication.external.impl.DefaultSyncHandler.xml

	<?xml version="1.0" encoding="UTF-8"?>
	<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"
	jcr:primaryType="sling:OsgiConfig"
	user.autoMembership = "[contributor]" user.expirationTime = "1h" user.membershipExpTime = "1h"
	user.membershipNestingDepth = "0" user.propertyMapping = "[rep:fullname=cn]" />

view raw org.apache.jackrabbit.oak.spi.security.authentication.external.impl.DefaultSyncHandler.xml hosted with ❤ by GitHub

org.apache.jackrabbit.oak.spi.security.authentication.external.impl.ExternalLoginModuleFactory.xml

	<?xml version="1.0" encoding="UTF-8"?>
	<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"
	jcr:primaryType="sling:OsgiConfig"
	idp.name = "ldap" jaas.controlFlag = "SUFFICIENT" jaas.ranking = "50" jaas.realmName = "ldap" sync.handlerName = "default" />

view raw org.apache.jackrabbit.oak.spi.security.authentication.external.impl.ExternalLoginModuleFactory.xml hosted with ❤ by GitHub

Now with this config files in place, do a config/content deployment & upon successful deployment your AEM instance is configured with the provided LDAP server.

Tested with OpenDS 2.2 & AEM 6

Please Note: You may need to restart your AEM instance once the configs are applied.

Inject OSGi services in Sling models (Pojos) - Sling model way

Create the injection point in the sling model class with @Source annotation & assign "osgi-services" as a value to the source annotation. 

	@Model(adaptables = Resource.class)
	public class Banners {
	@Inject @Source("osgi-services") GreetService greetService;

view raw Banners.java hosted with ❤ by GitHub

By this we can inject the below OSGi service in the Sling Model class.

	@Service(value = GreetService.class)
	@Component( metatype = true, immediate = true )
	public class GreetServiceImpl implements GreetService {
	@Override
	public String greet(String greeter) {
	return String.format( "Hallo %s, Wel Come to Sling Model", greeter );
	}
	}

view raw GreetServiceImpl.java hosted with ❤ by GitHub

JCR content mapping with Sling Model

follow the easy steps to use sling model for JCR content mapping.

1. Add sling model bundle dependency information in pom.xml

   	<dependency>
   	<groupId>org.apache.sling</groupId>
   	<artifactId>org.apache.sling.models.api</artifactId>
   	<version>1.0.0</version>
   	</dependency>

   view raw pom.xml hosted with ❤ by GitHub
    
2. Add Sling-Model-Packages declaration in the instruction 

   	<plugin>
   	<groupId>org.apache.felix</groupId>
   	<artifactId>maven-bundle-plugin</artifactId>
   	<extensions>true</extensions>
   	<configuration>
   	<instructions>
   	<Sling-Model-Packages>
   	edu.saral.models
   	</Sling-Model-Packages>
   	<Bundle-SymbolicName>edu.saral.slingmodel-bundle</Bundle-SymbolicName>
   	</instructions>
   	</configuration>
   	</plugin>

   view raw declaration.xml hosted with ❤ by GitHub
3. Annotate pojo class with @Model annotation and use @Inject against the fields (with getters)

   	package edu.saral.models;
   	import org.apache.sling.api.resource.Resource;
   	import org.apache.sling.models.annotations.Model;
   	import javax.inject.Inject;
   	/**
   	* Created by behera on 07-07-2014.
   	*/
   	@Model( adaptables = Resource.class )
   	public class Person {
   	@Inject private String firstName;
   	@Inject private String lastName;
   	@Inject private String email;
   	@Inject private String mobile;

   view raw Person.java hosted with ❤ by GitHub
    
4. Now adapt this pojo with resource.adaptTo() 

   	person = getResource().adaptTo( Person.class );
   	LOGGER.info( "person {} ", person );

   view raw PersonBean.java hosted with ❤ by GitHub
5. This Will map the below content structure easily without the bulgy or cluttered code.  

   	<?xml version="1.0" encoding="UTF-8"?>
   	<jcr:root xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"
   	jcr:primaryType="cq:Dialog"
   	helpPath="en/cq/current/wcm/default_components.html#Title"
   	title="Person"
   	xtype="panel">
   	<items jcr:primaryType="cq:WidgetCollection">
   	<title
   	jcr:primaryType="cq:Widget"
   	fieldLabel="First Name"
   	name="./firstName"
   	xtype="textfield"/>
   	<link
   	jcr:primaryType="cq:Widget"
   	fieldLabel="Last Name"
   	name="./lastName"
   	xtype="textfield"/>
   	<email
   	jcr:primaryType="cq:Widget"
   	fieldLabel="Email"
   	name="./email"
   	xtype="textfield"/>
   	<mobile
   	jcr:primaryType="cq:Widget"
   	fieldLabel="Mobile"
   	name="./mobile"
   	xtype="numberfield"/>
   	</items>
   	</jcr:root>

   view raw dialog.xml hosted with ❤ by GitHub

Remote access of JCR repository in CQ5 | AEM

Follow the below steps to access the CQ5 JCR repository (CRX) remotely.

1. Construct the remote URL of your CQ instance.
1. e.g. http://localhost:4502/crx/server
2. Where localhost  is the host where CQ is running & 4502 is port where CQ is listening to the requests.
3. Get the repository by using the JCRUtils class which is available in the jackrabbit-jcr-commons.jar library.
1. repository = JcrUtils.getRepository("http://localhost:4502/crx/server");
4. Create a SimpleCredential object by passing username, password entries.
1. SimpleCredentials creds = new SimpleCredentials("admin", "admin".toCharArray());
5. Invoke the login method of repository object by passing the credential object & the workspace name.
1. Session session = repository.login(creds, "crx.default");

A code snippet for the above can be found below

	public class RemoteAccess {
	public static void main(String x[]){
	String remoteURL = "http://localhost:4502/crx/server";
	Repository repository;
	Session session = null;
	try {
	repository = JcrUtils.getRepository(remoteURL);
	if( null != repository ){
	SimpleCredentials creds = new SimpleCredentials("admin", "admin".toCharArray());
	session = repository.login(creds, "crx.default");
	if(session.isLive()){
	System.out.println("You are connected to the Remote CQ instance");
	session.logout();
	}
	}
	} catch (RepositoryException e) {
	e.printStackTrace();
	}
	}
	}

view raw RemoteAccess.java hosted with ❤ by GitHub

Access different widgets inside the widget event listeners | CQ5 / AEM

To access widgets inside the event listeners of any widget, follow the below step.

1. Get the "dialog" object first.  
1. var dailogObject = this.findParentByType('dialog');
2. This will return the dialog object associated with your compoent dialog. Then look for the corresponding widget by invoking 
1. var titleField = dailogObject .getField('./jcr:title'); 
3. The above function looks for a widget by name './jcr:title' and returns the widget object associated.

Use case scenario.

Let's create a component dialog with 2 widgets (Pathfield, TextField). 

use case 1: if author selects any link URL then the corresponding title of the page should be set into the TextField widget.

Below steps can be followed to achieve this.

1. create a component dialog with two widgets.
1. One path field with name "./path" and xtype is  "pathfield"
2. Text field with name "./title" and xtype is "textfield" 
2. Attach a listener to the path field. And add "dialogclose" event to the listener. 
3. The javascript function for the above event can be written as below.

4. 	function(){
   	var componentDialog = this.findParentByType('dialog'); // returns the dialog object
   	var titleWidget = componentDialog.getField("./title");
   	var selectedPath = this.value;// returns the selected path from the path field
   	//Can write a remote service which returns the title of any path selected
   	$.get("/someRemoteService",{'path':selectedPath}).done(function(data){
   	titleWidget.setValue( data );
   	});
   	}

   view raw demo.js hosted with ❤ by GitHub
5. Sample screen shot
6. 

Attach listeners to widgets in CQ5 / AEM

Follow the below steps to create or attach listeners (javascript event listeners) to any widget in CQ5 / AEM.

1. Create a node by name "listeners" of type "nt:unstructured"
2. Find out the events which can be attached to a widget. You can find the list of events from the CQ Widget API documentation. Click here to visit.
3. e.g. The "pathfield" widget has got one event called "dialogclose". This event is fired when user selects any link from the browse field & clicks OK.
4. To attach this add one property by name "dialogclose" to the listeners node. The value should be any javascript function call. 
1. e.g. function(){ console.log("You have selected a link in path field"); }
5. Please see below  image for reference.

	<linkURL
	jcr:primaryType="cq:Widget"
	fieldLabel="Link to"
	name="./bannerTwo/linkURL"
	xtype="pathfield">
	<listeners
	jcr:primaryType="nt:unstructured"
	change="function(){if(this.value.slice(0,1) === '/' &amp;&amp; this.value.indexOf('.html') === -1 ){ this.setValue(this.value+'.html'); }}"
	dialogclose="function(){if(this.value.slice(0,1) === '/'){ this.setValue(this.value+'.html'); } }"/>
	</linkURL>

view raw dialog.xml hosted with ❤ by GitHub

Edit the Bottom tool bar of SmartImage widget in CQ5 / AEM

Modify the below properties to remove/edit the tool bar (appears on the bottom) of the HTML5 smart image widget. (xtype: html5smartimage)

disableZoom="{Boolean}true" This will disable the zoom functionality
mapParameter="0" This will disable the Map feature
rotateParameter="0" This will disable the image rotation capability
cropParameter="" This will disable the image crop capability

	<img
	jcr:primaryType="cq:Widget"
	allowUpload="{Boolean}false"
	ddGroups="[s7media]"
	fallbackRenditionSuffix=""
	fieldLabel="Scene7 Image"
	fileNameParameter="./banner2/fileName"
	fileReferenceParameter="./banner2/fileReference"
	height="200"
	name="./banner2/file"
	renditionSuffix=""
	requestSuffix=""
	rotateParameter=""
	cropParameter=""
	mapParameter=""
	disableZoom="{Boolean}true"
	sizeLimit="100"
	title="Image"
	xtype="html5smartimage"/>

view raw dialog.xml hosted with ❤ by GitHub