add a create/update/changeId/delete posthook (#193)

pom.xml

@@ -872,6 +872,21 @@
 			<artifactId>xml-apis</artifactId>
 			<version>1.4.01</version>
 		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-core</artifactId>
+			<version>2.9.6</version>
+		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-annotations</artifactId>
+			<version>2.9.6</version>
+		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-databind</artifactId>
+			<version>2.9.6</version>
+		</dependency>
 	</dependencies>
 
 	<distributionManagement>

src/main/java/org/lsc/Hooks.java

@@ -0,0 +1,189 @@
+/*
+ ****************************************************************************
+ * Ldap Synchronization Connector provides tools to synchronize
+ * electronic identities from a list of data sources including
+ * any database with a JDBC connector, another LDAP directory,
+ * flat files...
+ *
+ *                  ==LICENSE NOTICE==
+ *
+ * Copyright (c) 2008 - 2011 LSC Project
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+
+ *    * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the LSC Project nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ *                  ==LICENSE NOTICE==
+ *
+ *               (c) 2008 - 2011 LSC Project
+ ****************************************************************************
+ */
+package org.lsc;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import java.lang.ProcessBuilder;
+import java.io.OutputStream;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.io.PrintWriter;
+import org.lsc.utils.output.LdifLayout;
+import com.fasterxml.jackson.databind.ObjectMapper; // For encoding object to JSON
+import com.fasterxml.jackson.databind.ObjectWriter;
+
+
+/**
+ * This object is managing posthook scripts
+ */
+public class Hooks {
+
+	static final Logger LOGGER = LoggerFactory.getLogger(AbstractSynchronize.class);
+	/**
+	 * Method calling a postSyncHook if necessary
+	 *
+	 * return nothing
+	 */
+	public final static void postSyncHook(final String hook, final String outputFormat, final LscModifications lm) {
+
+		if( hook != null && ! hook.equals("") )
+		{
+
+			String format = "";
+			if( outputFormat.equals("json") ) {
+				format = "json";
+			}
+			else
+			{
+				format = "ldif";
+			}
+
+			// Compute json/ldif modifications
+			String modifications = null;
+
+			switch (lm.getOperation()) {
+				case CREATE_OBJECT:
+					if( format.equals("json") ) {
+						modifications = getJsonModifications(lm);
+					}
+					else {
+						modifications = LdifLayout.format(lm);
+					}
+					callHook("create", hook, lm.getMainIdentifier(), format, modifications);
+					break;
+
+				case UPDATE_OBJECT:
+					if( format.equals("json") ) {
+						modifications = getJsonModifications(lm);
+					}
+					else {
+						modifications = LdifLayout.format(lm);
+					}
+					callHook("update", hook, lm.getMainIdentifier(), format, modifications);
+					break;
+
+				case CHANGE_ID:
+					if( format.equals("json") ) {
+						modifications = getJsonModifications(lm);
+					}
+					else {
+						modifications = LdifLayout.format(lm);
+					}
+					callHook("changeId", hook, lm.getMainIdentifier(), format, modifications);
+					break;
+
+				case DELETE_OBJECT:
+					callHook("delete", hook, lm.getMainIdentifier(), format, modifications);
+					break;
+
+				default:
+					LOGGER.info("Error: unknown operation for posthook {}", hook);
+			}
+		}
+	}
+
+	/**
+	* Method calling the hook
+	*
+	* return nothing
+	*/
+	public final static void callHook(	String operationType,
+						String hook,
+						String identifier,
+						String format,
+						String modifications) {
+
+		LOGGER.info("Calling {} posthook {} with format {} for {}", operationType, hook, format, identifier);
+		try {
+			if( modifications != null ) {
+				Process p = new ProcessBuilder(
+					hook,
+					identifier,
+					operationType)
+				.start();
+
+				// sends ldif modifications to stdin of hook script
+				OutputStream stdin = p.getOutputStream();
+				stdin.write(modifications.getBytes());
+				stdin.write("\n".getBytes());
+				stdin.flush();
+				stdin.close();
+			}
+			else {
+				Process p = new ProcessBuilder(
+					hook,
+					identifier,
+					operationType)
+				.start();
+			}
+		}
+		catch(IOException e) {
+			StringWriter sw = new StringWriter();
+			PrintWriter pw = new PrintWriter(sw);
+			e.printStackTrace(pw);
+			LOGGER.error("Error while calling {} posthook {} with format {} for {}: {}",
+					operationType, hook, format, identifier, sw.toString());
+		}
+	}
+
+	/**
+	* Method computing modifications as json
+	*
+	* @return modifications in a json String
+	*/
+	public final static String getJsonModifications(final LscModifications lm) {
+		ObjectWriter ow = new ObjectMapper().writer().withDefaultPrettyPrinter();
+		String json = "";
+		try {
+			json = ow.writeValueAsString(lm.getLscAttributeModifications());
+		}
+		catch(Exception e) {
+			StringWriter sw = new StringWriter();
+			PrintWriter pw = new PrintWriter(sw);
+			e.printStackTrace(pw);
+			LOGGER.error("Error while encoding LSC modifications to json", sw.toString());
+		}
+		return json;
+	}
+
+}

src/main/java/org/lsc/beans/syncoptions/ForceSyncOptions.java

@@ -128,6 +128,30 @@ public String getCondition(LscModificationType operation) {
 		return DEFAULT_CONDITION;
 	}
 
+	public String getPostHookOutputFormat() {
+		return "";
+	}
+
+	public String getCreatePostHook() {
+		return "";
+	}
+
+	public String getDeletePostHook() {
+		return "";
+	}
+
+	public String getUpdatePostHook() {
+		return "";
+	}
+
+	public String getChangeIdPostHook() {
+		return "";
+	}
+
+	public String getPostHook(LscModificationType operation) {
+		return "";
+	}
+
 	public String getDn() {
 		return null;//((Ldap)task.getDestinationService()).getDn();
 	}

src/main/java/org/lsc/beans/syncoptions/ISyncOptions.java

@@ -153,6 +153,44 @@ public interface ISyncOptions {
 
 	String getCondition(LscModificationType operation);
 
+	/**
+	 * Returns the posthook output format
+	 *
+	 * @return the posthook output format or "" if none is specified (default)
+	 */
+	String getPostHookOutputFormat();
+
+	/**
+	 * Returns the posthook for a creation
+	 *
+	 * @return the posthook or "" if none is specified (default)
+	 */
+	String getCreatePostHook();
+
+	/**
+	 * Returns the posthook for an update
+	 *
+	 * @return the posthook or "" if none is specified (default)
+	 */
+	String getUpdatePostHook();
+
+	/**
+	 * Returns the posthook for a delete
+	 *
+	 * @return the posthook or "" if none is specified (default)
+	 */
+	String getDeletePostHook();
+
+	/**
+	 * Returns the posthook for a id change
+	 *
+	 * @return the posthook or "" if none is specified (default)
+	 */
+	String getChangeIdPostHook();
+
+
+	String getPostHook(LscModificationType operation);
+
 	/**
 	 * Return the expression used to infer the new object DN
 	 * @return the new object dn pattern

src/main/java/org/lsc/beans/syncoptions/PropertiesBasedSyncOptions.java

@@ -196,6 +196,60 @@ public String getCondition(LscModificationType operation) {
 		}
 		return result;
 	}
+
+	public String getPostHookOutputFormat() {
+		if (conf.getHooks() == null || conf.getHooks().getOutputFormat() == null) {
+			return "";
+		}
+		return conf.getHooks().getOutputFormat();
+	}
+
+	public String getCreatePostHook() {
+		if (conf.getHooks() == null || conf.getHooks().getCreatePostHook() == null) {
+			return "";
+		}
+		return conf.getHooks().getCreatePostHook();
+	}
+
+	public String getDeletePostHook() {
+		if (conf.getHooks() == null || conf.getHooks().getDeletePostHook() == null) {
+			return "";
+		}
+		return conf.getHooks().getDeletePostHook();
+	}
+
+	public String getUpdatePostHook() {
+		if (conf.getHooks() == null || conf.getHooks().getUpdatePostHook() == null) {
+			return "";
+		}
+		return conf.getHooks().getUpdatePostHook();
+	}
+
+	public String getChangeIdPostHook() {
+		if (conf.getHooks() == null || conf.getHooks().getChangeIdPostHook() == null) {
+			return "";
+		}
+		return conf.getHooks().getChangeIdPostHook();
+	}
+
+	public String getPostHook(LscModificationType operation) {
+		String result = "";
+		switch (operation) {
+			case CREATE_OBJECT:
+				result = this.getCreatePostHook();
+				break;
+			case UPDATE_OBJECT:
+				result = this.getUpdatePostHook();
+				break;
+			case DELETE_OBJECT:
+				result = this.getDeletePostHook();
+				break;
+			case CHANGE_ID:
+				result = this.getChangeIdPostHook();
+				break;
+		}
+		return result;
+	}
 
 	public String getDelimiter(String name) {
         DatasetType dataset = LscConfiguration.getDataset(conf, name);

src/main/java/org/lsc/configuration/.gitignore

@@ -4,6 +4,7 @@
 /AuditType.java
 /AuditsType.java
 /ConditionsType.java
+/HooksType.java
 /ConnectionType.java
 /ConnectionsType.java
 /CsvAuditType.java

src/main/java/org/lsc/runnable/CleanEntryRunner.java

@@ -23,6 +23,7 @@
 import org.lsc.utils.ScriptingEvaluator;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.lsc.Hooks;
 
 /**
  * @author sfroger
@@ -108,6 +109,10 @@ public void run() {
 				// if we got here, we have a modification to apply - let's
 				// do it!
 				if (task.getDestinationService().apply(lm)) {
+					// Retrieve posthook for the current operation
+					String hook = syncOptions.getDeletePostHook();
+					String outputFormat = syncOptions.getPostHookOutputFormat();
+					Hooks.postSyncHook(hook, outputFormat, lm);
 					counter.incrementCountCompleted();
 					abstractSynchronize.logAction(lm, id, task.getName());
 				} else {