DATAJDBC-99 - Eventsupport.

The repository publishes events before and after inserting, updating and deleting entities, as well as after instantiation of entities.

JdbcEvent ist the common super class of all events and makes the id
and the entity available (if possible).

Added issue id comments to tests from previous issues.

Author: schauder

src/main/java/org/springframework/data/jdbc/mapping/event/AfterCreationEvent.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+/**
+ * gets published after instantiation and setting of all the properties of an entity. This allows to do some
+ * postprocessing of entities.
+ *
+ * @author Jens Schauder
+ */
+public class AfterCreationEvent extends JdbcEvent{
+
+	/**
+	 * @param instance the newly instantiated entity.
+	 * @param idProvider a function providing the id, for the instance.
+	 * @param <T> type of the entity and the argument of the {@code idProvider}
+	 */
+	public <T> AfterCreationEvent(T instance, Function<T, Object> idProvider) {
+		super(instance, idProvider);
+	}
+}

src/main/java/org/springframework/data/jdbc/mapping/event/AfterDeleteEvent.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+/**
+ * get published after deletion of an entity. The source might contain the Id or the actual entity, depending on the
+ * {@code delete(...)} method used.
+ *
+ * @author Jens Schauder
+ */
+public class AfterDeleteEvent extends JdbcEvent{
+
+	/**
+	 * @param instance the deleted entity.
+	 * @param idProvider a function providing the id, for the instance.
+	 * @param <T> type of the entity and the argument of the {@code idProvider}
+	 */
+	public <T> AfterDeleteEvent(T instance, Function<T, Object> idProvider) {
+		super(instance, idProvider);
+	}
+}

src/main/java/org/springframework/data/jdbc/mapping/event/AfterInsertEvent.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+/**
+ * gets published after an entity got inserted into the database.
+ *
+ * @author Jens Schauder
+ */
+public class AfterInsertEvent extends AfterSaveEvent {
+
+	/**
+	 * @param instance the newly inserted entity.
+	 * @param idProvider a function providing the id, for the instance.
+	 * @param <T> type of the entity and the argument of the {@code idProvider}
+	 */
+	public <T> AfterInsertEvent(T instance, Function<T, Object> idProvider) {
+		super(instance, idProvider);
+	}
+}

src/main/java/org/springframework/data/jdbc/mapping/event/AfterSaveEvent.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+/**
+ * subclasses of this get published after a new instance or a changed instance was saved in the database
+ * @author Jens Schauder
+ */
+public class AfterSaveEvent extends JdbcEvent{
+
+	/**
+	 * @param instance the newly saved entity.
+	 * @param idProvider a function providing the id, for the instance.
+	 * @param <T> type of the entity and the argument of the {@code idProvider}
+	 */
+	<T> AfterSaveEvent(T instance, Function<T, Object> idProvider) {
+		super(instance, idProvider);
+	}
+}

src/main/java/org/springframework/data/jdbc/mapping/event/AfterUpdateEvent.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+/**
+ * gets published after an entity was updated in the database.
+ *
+ * @author Jens Schauder
+ */
+public class AfterUpdateEvent extends AfterSaveEvent {
+
+	/**
+	 * @param instance the updated entity.
+	 * @param idProvider a function providing the id, for the instance.
+	 * @param <T> type of the entity and the argument of the {@code idProvider}
+	 */
+	public <T> AfterUpdateEvent(T instance, Function<T, Object> idProvider) {
+		super(instance, idProvider);
+	}
+}

src/main/java/org/springframework/data/jdbc/mapping/event/BeforeDeleteEvent.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+import org.springframework.context.ApplicationEvent;
+
+/**
+ * gets published when an entity is about to get deleted. {@link ApplicationEvent#getSource()} might contain either the
+ * entity or the id of the entity, depending on which delete method was used.
+ *
+ * @author Jens Schauder
+ */
+public class BeforeDeleteEvent extends JdbcEvent {
+
+	/**
+	 * @param instance the entity about to get deleted. Might be {@literal NULL}
+	 * @param idProvider a function providing the id, for the instance. Must provide a not {@literal NULL} id, when called with {@link #instance}
+	 * @param <T> type of the entity and the argument of the {@code idProvider}
+	 */
+	public <T> BeforeDeleteEvent(T instance, Function<T, Object> idProvider) {
+		super(instance, idProvider);
+	}
+}

src/main/java/org/springframework/data/jdbc/mapping/event/BeforeInsertEvent.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+/**
+ * gets published before an entity gets inserted into the database.
+ *
+ * When the id-property of the entity must get set manually, an event listener for this event may do so.
+ *
+ * @author Jens Schauder
+ */
+public class BeforeInsertEvent extends BeforeSaveEvent {
+
+	/**
+	 * @param instance the entity about to get inserted.
+	 * @param idProvider a function providing the id, for the instance.
+	 * @param <T> type of the entity and the argument of the {@code idProvider}
+	 */
+	public <T> BeforeInsertEvent(T instance, Function<T, Object> idProvider) {
+		super(instance, idProvider);
+	}
+}

src/main/java/org/springframework/data/jdbc/mapping/event/BeforeSaveEvent.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+import org.springframework.context.ApplicationEvent;
+
+/**
+ * subclasses of this get published before an entity gets saved to the database.
+ *
+ * @author Jens Schauder
+ */
+public class BeforeSaveEvent extends JdbcEvent {
+
+	/**
+	 * @param instance the entity about to get saved.
+	 * @param idProvider a function providing the id, for the instance.
+	 * @param <T> type of the entity and the argument of the {@code idProvider}
+	 */
+	<T> BeforeSaveEvent(T instance, Function<T, Object> idProvider) {
+		super(instance, idProvider);
+	}
+}

src/main/java/org/springframework/data/jdbc/mapping/event/BeforeUpdateEvent.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+/**
+ * gets published before an entity gets updated in the database.
+ *
+ * @author Jens Schauder
+ */
+public class BeforeUpdateEvent extends BeforeSaveEvent {
+
+	/**
+	 * @param instance the entity about to get saved.
+	 * @param idProvider a function providing the id, for the instance.
+	 * @param <T> type of the entity and the argument of the {@code idProvider}
+	 */
+	public <T> BeforeUpdateEvent(T instance, Function<T, Object> idProvider) {
+		super(instance, idProvider);
+	}
+}

src/main/java/org/springframework/data/jdbc/mapping/event/JdbcEvent.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.mapping.event;
+
+import java.util.function.Function;
+
+import org.springframework.context.ApplicationEvent;
+
+/**
+ * is the common superclass for all events published by JDBC repositories.
+ *
+ * It is recommendet not to use the {@link #getSource()} since it may contain the entity if it was available, when the
+ * event was published, or in case of delete events only the Id.
+ *
+ * Use the dedicated methods {@link #getId()} or {@link #getInstance()} instead. Note that the later might be
+ * {@literal NULL} in the cases mentioned above.
+ *
+ * @author Jens Schauder
+ */
+public class JdbcEvent extends ApplicationEvent {
+
+	private final Object id;
+	private final Object instance;
+
+	<T> JdbcEvent(T instance, Function<T, Object> idProvider) {
+
+		super(instance == null ? idProvider.apply(instance) : instance);
+		this.instance = instance;
+		this.id = idProvider.apply(instance);
+	}
+
+	/**
+	 * the entity for which this event was publish. Might be {@literal NULL} in cases of delete events where only the id
+	 * was provided to the delete method.
+	 *
+	 * @return instance of the entity triggering this event.
+	 */
+	public Object getInstance() {
+		return instance;
+	}
+
+	/**
+	 * the id of the entity, triggering this event. Guaranteed not to be {@literal NULL}.
+	 * @return
+	 */
+	public Object getId() {
+		return id;
+	}
+}