get context to async methods using optional mappers

Author: Gerald Unterrainer

pom.xml

@@ -17,7 +17,7 @@
 
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>http-server</artifactId>
-	<version>0.2.17</version>
+	<version>0.2.18</version>
 	<name>HttpServer</name>
 	<packaging>jar</packaging>
 

src/main/java/info/unterrainer/commons/httpserver/GenericHandlerGroup.java

@@ -13,6 +13,9 @@
 import info.unterrainer.commons.httpserver.enums.Endpoint;
 import info.unterrainer.commons.httpserver.enums.QueryField;
 import info.unterrainer.commons.httpserver.exceptions.BadRequestException;
+import info.unterrainer.commons.httpserver.extensions.AsyncExtensionContext;
+import info.unterrainer.commons.httpserver.extensions.AsyncExtensionContextBaseMapper;
+import info.unterrainer.commons.httpserver.extensions.AsyncExtensionContextMapper;
 import info.unterrainer.commons.httpserver.interceptors.InterceptorData;
 import info.unterrainer.commons.httpserver.interceptors.delegates.GetListInterceptor;
 import info.unterrainer.commons.httpserver.jsons.ListJson;
@@ -41,6 +44,7 @@ public class GenericHandlerGroup<P extends BasicJpa, J extends BasicJson, E> imp
 	private final List<Endpoint> endpoints;
 	private final List<GetListInterceptor> getListInterceptors;
 	private final HandlerExtensions<P, J, E> extensions;
+	private final List<AsyncExtensionContextMapper> asyncExtensionContextMappers;
 	private final LinkedHashMap<Endpoint, Role[]> accessRoles;
 	private final ExecutorService executorService;
 	private final HandlerUtils hu = new HandlerUtils();
@@ -81,6 +85,15 @@ private boolean endpointsToCreate(final List<Endpoint> endpointList) {
 		return false;
 	}
 
+	private AsyncExtensionContext makeAsyncExtensionContextFor(final Context ctx) {
+		AsyncExtensionContext asyncCtx = new AsyncExtensionContext();
+		for (AsyncExtensionContextMapper e : asyncExtensionContextMappers)
+			e.map(ctx, asyncCtx);
+		AsyncExtensionContextBaseMapper m = new AsyncExtensionContextBaseMapper();
+		m.map(ctx, asyncCtx);
+		return asyncCtx;
+	}
+
 	private Role[] rolesFor(final List<Endpoint> endpointList) {
 		List<Role> roles = new ArrayList<>();
 		for (Entry<Endpoint, Role[]> entry : accessRoles.entrySet())
@@ -90,11 +103,12 @@ private Role[] rolesFor(final List<Endpoint> endpointList) {
 	}
 
 	private void getEntry(final Context ctx) {
-		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction();
+		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction(ctx);
 
 		P jpa = hu.getJpaById(ctx, transaction.getManager(), dao);
 		J json = orikaMapper.map(jpa, jsonType);
-		json = extensions.runPostGetSingle(ctx, transaction.getManager(), jpa.getId(), jpa, json, executorService);
+		json = extensions.runPostGetSingle(ctx, makeAsyncExtensionContextFor(ctx), transaction.getManager(),
+				jpa.getId(), jpa, json, executorService);
 
 		transaction.end();
 		ctx.attribute(Attribute.RESPONSE_OBJECT, json);
@@ -123,7 +137,7 @@ private void getList(final Context ctx) {
 						e.getMessage());
 			}
 
-		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction();
+		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction(ctx);
 
 		ListJson<P> bList = dao.getList(transaction.getManager(), offset, size, interceptorResult.getSelectClause(),
 				interceptorResult.getJoinClause(), interceptorResult.getWhereClause(), interceptorResult.getParams(),
@@ -134,7 +148,8 @@ private void getList(final Context ctx) {
 
 		hu.setPaginationParamsFor(jList, offset, size, bList.getCount(), interceptorResult.getPartOfQueryString(), ctx);
 
-		jList = extensions.runPostGetList(ctx, transaction.getManager(), size, offset, bList, jList, executorService);
+		jList = extensions.runPostGetList(ctx, makeAsyncExtensionContextFor(ctx), transaction.getManager(), size,
+				offset, bList, jList, executorService);
 
 		transaction.end();
 		ctx.attribute(Attribute.RESPONSE_OBJECT, jList);
@@ -145,14 +160,15 @@ private void create(final Context ctx) throws IOException {
 		try {
 			J json = jsonMapper.fromStringTo(jsonType, b);
 			P mappedJpa = orikaMapper.map(json, jpaType);
-			DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction();
+			DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction(ctx);
 
-			mappedJpa = extensions.runPreInsert(ctx, transaction.getManager(), json, mappedJpa, executorService);
+			mappedJpa = extensions.runPreInsert(ctx, makeAsyncExtensionContextFor(ctx), transaction.getManager(), json,
+					mappedJpa, executorService);
 			P createdJpa = dao.create(transaction.getManager(), mappedJpa, hu.getWriteTenantIdsFrom(ctx));
 			J r = orikaMapper.map(createdJpa, jsonType);
 
-			r = extensions.runPostInsert(ctx, transaction.getManager(), json, mappedJpa, createdJpa, r,
-					executorService);
+			r = extensions.runPostInsert(ctx, makeAsyncExtensionContextFor(ctx), transaction.getManager(), json,
+					mappedJpa, createdJpa, r, executorService);
 
 			transaction.end();
 			ctx.attribute(Attribute.RESPONSE_OBJECT, r);
@@ -163,7 +179,7 @@ private void create(final Context ctx) throws IOException {
 	}
 
 	private void fullUpdate(final Context ctx) throws IOException {
-		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction();
+		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction(ctx);
 		P jpa = hu.getJpaById(ctx, transaction.getManager(), dao);
 		try {
 			J json = jsonMapper.fromStringTo(jsonType, ctx.body());
@@ -172,13 +188,13 @@ private void fullUpdate(final Context ctx) throws IOException {
 			mappedJpa.setCreatedOn(jpa.getCreatedOn());
 			mappedJpa.setEditedOn(jpa.getEditedOn());
 
-			mappedJpa = extensions.runPreModify(ctx, transaction.getManager(), jpa.getId(), json, jpa, mappedJpa,
-					executorService);
+			mappedJpa = extensions.runPreModify(ctx, makeAsyncExtensionContextFor(ctx), transaction.getManager(),
+					jpa.getId(), json, jpa, mappedJpa, executorService);
 			P persistedJpa = dao.update(transaction.getManager(), mappedJpa, hu.getReadTenantIdsFrom(ctx));
 
 			J r = orikaMapper.map(persistedJpa, jsonType);
-			r = extensions.runPostModify(ctx, transaction.getManager(), jpa.getId(), json, jpa, mappedJpa, persistedJpa,
-					r, executorService);
+			r = extensions.runPostModify(ctx, makeAsyncExtensionContextFor(ctx), transaction.getManager(), jpa.getId(),
+					json, jpa, mappedJpa, persistedJpa, r, executorService);
 
 			ctx.attribute(Attribute.RESPONSE_OBJECT, r);
 
@@ -192,12 +208,13 @@ private void fullUpdate(final Context ctx) throws IOException {
 	private void delete(final Context ctx) {
 		ctx.attribute(Attribute.RESPONSE_OBJECT, null);
 		Long id = hu.checkAndGetId(ctx);
-		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction();
+		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction(ctx);
 
-		id = extensions.runPreDelete(ctx, transaction.getManager(), id, executorService);
+		id = extensions.runPreDelete(ctx, makeAsyncExtensionContextFor(ctx), transaction.getManager(), id,
+				executorService);
 		dao.delete(transaction.getManager(), id, hu.getReadTenantIdsFrom(ctx));
 		ctx.status(204);
-		extensions.runPostDelete(ctx, transaction.getManager(), id, executorService);
+		extensions.runPostDelete(ctx, makeAsyncExtensionContextFor(ctx), transaction.getManager(), id, executorService);
 
 		transaction.end();
 	}

src/main/java/info/unterrainer/commons/httpserver/GenericHandlerGroupBuilder.java

@@ -9,6 +9,7 @@
 import info.unterrainer.commons.httpserver.daos.CoreDao;
 import info.unterrainer.commons.httpserver.daos.ParamMap;
 import info.unterrainer.commons.httpserver.enums.Endpoint;
+import info.unterrainer.commons.httpserver.extensions.AsyncExtensionContextMapper;
 import info.unterrainer.commons.httpserver.interceptors.InterceptorData;
 import info.unterrainer.commons.httpserver.interceptors.InterceptorParamBuilder;
 import info.unterrainer.commons.httpserver.interceptors.delegates.GetListInterceptor;
@@ -35,6 +36,7 @@ public class GenericHandlerGroupBuilder<P extends BasicJpa, J extends BasicJson,
 	private String path;
 	private List<Endpoint> endpoints = new ArrayList<>();
 	private List<GetListInterceptor> getListInterceptors = new ArrayList<>();
+	private List<AsyncExtensionContextMapper> asyncExtensionContextMappers = new ArrayList<>();
 	private ExecutorService executorService;
 
 	HandlerExtensions<P, J, E> extensions = new HandlerExtensions<>();
@@ -49,7 +51,7 @@ public HttpServer add() {
 			executorService = server.executorService;
 		GenericHandlerGroup<P, J, E> handlerGroupInstance = new GenericHandlerGroup<>(dao, jpaType, jsonType,
 				jsonMapper, orikaFactory.getMapperFacade(), path, endpoints, getListInterceptors, extensions,
-				accessRoles, executorService);
+				asyncExtensionContextMappers, accessRoles, executorService);
 		server.addHandlerGroup(handlerGroupInstance);
 		return server;
 	}
@@ -93,6 +95,20 @@ public GenericHandlerGroupBuilder<P, J, E> getListInterceptor(final GetListInter
 		return this;
 	}
 
+	/**
+	 * Here you may register {@link AsyncExtensionContextMapper}s that allow you to
+	 * map attributes located in the {@link Context} to an offline, asynchronous one
+	 * which you can address within asynchronous extension methods.
+	 *
+	 * @param asyncExtensionContextMapper
+	 * @return an instance of this object to asure a fluent interface
+	 */
+	public GenericHandlerGroupBuilder<P, J, E> asyncExtensionContextMapper(
+			final AsyncExtensionContextMapper asyncExtensionContextMapper) {
+		asyncExtensionContextMappers.add(asyncExtensionContextMapper);
+		return this;
+	}
+
 	/**
 	 * Gives you a {@link InterceptorParamBuilder} object that allows you to declare
 	 * an interceptor with minimal code.<br>

src/main/java/info/unterrainer/commons/httpserver/HandlerExtensions.java

@@ -5,6 +5,7 @@
 import java.util.concurrent.ExecutorService;
 
 import info.unterrainer.commons.httpserver.exceptions.GracefulCancelationException;
+import info.unterrainer.commons.httpserver.extensions.AsyncExtensionContext;
 import info.unterrainer.commons.httpserver.extensions.delegates.PostDeleteAsync;
 import info.unterrainer.commons.httpserver.extensions.delegates.PostDeleteSync;
 import info.unterrainer.commons.httpserver.extensions.delegates.PostGetListAsync;
@@ -52,10 +53,10 @@ public class HandlerExtensions<P extends BasicJpa, J extends BasicJson, E> {
 	private final List<PreModifyAsync<P, J>> preModifyAsync = new ArrayList<>();
 	private final List<PreModifySync<P, J, E>> preModifySync = new ArrayList<>();
 
-	public J runPostGetSingle(final Context ctx, final E entityManager, final Long receivedId, final P readJpa,
-			final J response, final ExecutorService executorService) {
+	public J runPostGetSingle(final Context ctx, final AsyncExtensionContext asyncCtx, final E entityManager,
+			final Long receivedId, final P readJpa, final J response, final ExecutorService executorService) {
 		for (PostGetSingleAsync<P, J> h : postGetSingleAsync())
-			executorService.execute(() -> h.handle(receivedId, readJpa, response));
+			executorService.execute(() -> h.handle(asyncCtx, receivedId, readJpa, response));
 
 		J result = response;
 		for (PostGetSingleSync<P, J, E> h : postGetSingleSync()) {
@@ -66,10 +67,11 @@ public J runPostGetSingle(final Context ctx, final E entityManager, final Long r
 		return result;
 	}
 
-	public ListJson<J> runPostGetList(final Context ctx, final E entityManager, final Long size, final Long offset,
-			final ListJson<P> readList, final ListJson<J> response, final ExecutorService executorService) {
+	public ListJson<J> runPostGetList(final Context ctx, final AsyncExtensionContext asyncCtx, final E entityManager,
+			final Long size, final Long offset, final ListJson<P> readList, final ListJson<J> response,
+			final ExecutorService executorService) {
 		for (PostGetListAsync<P, J> h : postGetListAsync())
-			executorService.execute(() -> h.handle(size, offset, readList, response));
+			executorService.execute(() -> h.handle(asyncCtx, size, offset, readList, response));
 
 		ListJson<J> result = response;
 		for (PostGetListSync<P, J, E> h : postGetListSync()) {
@@ -80,10 +82,10 @@ public ListJson<J> runPostGetList(final Context ctx, final E entityManager, fina
 		return result;
 	}
 
-	public P runPreInsert(final Context ctx, final E entityManager, final J receivedJson, final P resultJpa,
-			final ExecutorService executorService) {
+	public P runPreInsert(final Context ctx, final AsyncExtensionContext asyncCtx, final E entityManager,
+			final J receivedJson, final P resultJpa, final ExecutorService executorService) {
 		for (PreInsertAsync<P, J> h : preInsertAsync())
-			executorService.execute(() -> h.handle(receivedJson, resultJpa));
+			executorService.execute(() -> h.handle(asyncCtx, receivedJson, resultJpa));
 
 		P result = resultJpa;
 		for (PreInsertSync<P, J, E> h : preInsertSync()) {
@@ -94,10 +96,11 @@ public P runPreInsert(final Context ctx, final E entityManager, final J received
 		return result;
 	}
 
-	public J runPostInsert(final Context ctx, final E entityManager, final J receivedJson, final P mappedJpa,
-			final P createdJpa, final J response, final ExecutorService executorService) {
+	public J runPostInsert(final Context ctx, final AsyncExtensionContext asyncCtx, final E entityManager,
+			final J receivedJson, final P mappedJpa, final P createdJpa, final J response,
+			final ExecutorService executorService) {
 		for (PostInsertAsync<P, J> h : postInsertAsync())
-			executorService.execute(() -> h.handle(receivedJson, mappedJpa, createdJpa, response));
+			executorService.execute(() -> h.handle(asyncCtx, receivedJson, mappedJpa, createdJpa, response));
 
 		J result = response;
 		for (PostInsertSync<P, J, E> h : postInsertSync()) {
@@ -108,10 +111,11 @@ public J runPostInsert(final Context ctx, final E entityManager, final J receive
 		return result;
 	}
 
-	public P runPreModify(final Context ctx, final E entityManager, final Long receivedId, final J receivedJson,
-			final P readJpa, final P resultJpa, final ExecutorService executorService) {
+	public P runPreModify(final Context ctx, final AsyncExtensionContext asyncCtx, final E entityManager,
+			final Long receivedId, final J receivedJson, final P readJpa, final P resultJpa,
+			final ExecutorService executorService) {
 		for (PreModifyAsync<P, J> h : preModifyAsync())
-			executorService.execute(() -> h.handle(receivedId, receivedJson, readJpa, resultJpa));
+			executorService.execute(() -> h.handle(asyncCtx, receivedId, receivedJson, readJpa, resultJpa));
 
 		P result = resultJpa;
 		for (PreModifySync<P, J, E> h : preModifySync()) {
@@ -122,12 +126,12 @@ public P runPreModify(final Context ctx, final E entityManager, final Long recei
 		return result;
 	}
 
-	public J runPostModify(final Context ctx, final E entityManager, final Long receivedId, final J receivedJson,
-			final P readJpa, final P mappedJpa, final P persistedJpa, final J response,
-			final ExecutorService executorService) {
+	public J runPostModify(final Context ctx, final AsyncExtensionContext asyncCtx, final E entityManager,
+			final Long receivedId, final J receivedJson, final P readJpa, final P mappedJpa, final P persistedJpa,
+			final J response, final ExecutorService executorService) {
 		for (PostModifyAsync<P, J> h : postModifyAsync())
-			executorService
-					.execute(() -> h.handle(receivedId, receivedJson, readJpa, mappedJpa, persistedJpa, response));
+			executorService.execute(
+					() -> h.handle(asyncCtx, receivedId, receivedJson, readJpa, mappedJpa, persistedJpa, response));
 
 		J result = response;
 		for (PostModifySync<P, J, E> h : postModifySync()) {
@@ -138,10 +142,10 @@ public J runPostModify(final Context ctx, final E entityManager, final Long rece
 		return result;
 	}
 
-	public Long runPreDelete(final Context ctx, final E entityManager, final Long receivedId,
-			final ExecutorService executorService) {
+	public Long runPreDelete(final Context ctx, final AsyncExtensionContext asyncCtx, final E entityManager,
+			final Long receivedId, final ExecutorService executorService) {
 		for (PreDeleteAsync h : preDeleteAsync())
-			executorService.execute(() -> h.handle(receivedId));
+			executorService.execute(() -> h.handle(asyncCtx, receivedId));
 
 		Long result = receivedId;
 		for (PreDeleteSync<E> h : preDeleteSync()) {
@@ -152,10 +156,10 @@ public Long runPreDelete(final Context ctx, final E entityManager, final Long re
 		return result;
 	}
 
-	public void runPostDelete(final Context ctx, final E entityManager, final Long receivedId,
-			final ExecutorService executorService) {
+	public void runPostDelete(final Context ctx, final AsyncExtensionContext asyncCtx, final E entityManager,
+			final Long receivedId, final ExecutorService executorService) {
 		for (PostDeleteAsync h : postDeleteAsync())
-			executorService.execute(() -> h.handle(receivedId));
+			executorService.execute(() -> h.handle(asyncCtx, receivedId));
 
 		for (PostDeleteSync<E> h : postDeleteSync())
 			if (!h.handle(ctx, entityManager, receivedId))

src/main/java/info/unterrainer/commons/httpserver/HandlerUtils.java

@@ -40,7 +40,7 @@ public Set<Long> getWriteTenantIdsFrom(final Context ctx) {
 
 	public <P extends BasicJpa, E> P getJpaById(final Context ctx, final CoreDao<P, E> dao) {
 		Long id = checkAndGetId(ctx);
-		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction();
+		DaoTransaction<E> transaction = dao.getTransactionManager().beginTransaction(ctx);
 		try {
 			P jpa = dao.getById(transaction.getManager(), id, getReadTenantIdsFrom(ctx));
 			if (jpa == null)

src/main/java/info/unterrainer/commons/httpserver/daos/BasicJpqlDao.java

@@ -2,12 +2,14 @@
 
 import java.util.List;
 import java.util.Set;
+import java.util.function.Function;
 
 import javax.persistence.EntityManager;
 import javax.persistence.EntityManagerFactory;
 import javax.persistence.TypedQuery;
 
 import info.unterrainer.commons.rdbutils.entities.BasicJpa;
+import io.javalin.http.Context;
 import lombok.Getter;
 
 public class BasicJpqlDao<P extends BasicJpa> implements CoreDaoProvider<P, EntityManager> {
@@ -24,6 +26,14 @@ public BasicJpqlDao(final EntityManagerFactory emf, final Class<P> type) {
 		coreDao = new JpqlCoreDao<>(emf, type);
 	}
 
+	public BasicJpqlDao(final Function<Context, EntityManagerFactory> entityManagerFactorySupplier,
+			final Class<P> type) {
+		super();
+		this.emf = null;
+		this.type = type;
+		coreDao = new JpqlCoreDao<>(entityManagerFactorySupplier, type);
+	}
+
 	<T> List<T> getList(final EntityManager em, final TypedQuery<T> query, final long offset, final long size) {
 		int s = Integer.MAX_VALUE;
 		if (size < s)

src/main/java/info/unterrainer/commons/httpserver/daos/DaoTransactionManager.java

@@ -1,11 +1,13 @@
 package info.unterrainer.commons.httpserver.daos;
 
+import io.javalin.http.Context;
+
 public interface DaoTransactionManager<E> {
 
 	/**
 	 * Gets you a new transaction and starts it.
 	 *
 	 * @return a {@link JpqlTransaction}
 	 */
-	DaoTransaction<E> beginTransaction();
+	DaoTransaction<E> beginTransaction(Context ctx);
 }