In order to use this servlet you should create a class inheriting from {@link + * NotificationServlet} and register the servlet in your web.xml. + * + *
It is a simple wrapper around {@link WebhookUtils#processWebhookNotification}, so if you you + * may alternatively call that method instead from your {@link HttpServlet#doPost} with no loss of + * functionality. Example usage: + * + *
{@code
+ * public class MyNotificationServlet extends NotificationServlet {
+ *
+ * private static final long serialVersionUID = 1L;
+ *
+ * public MyNotificationServlet() throws IOException {
+ * super(new SomeDataStoreFactory());
+ * }
+ * }
+ * }
+ *
+ * Sample web.xml setup:
+ *
+ * {@code
+ * {@literal <}servlet{@literal >}
+ * {@literal <}servlet-name{@literal >}MyNotificationServlet{@literal <}/servlet-name{@literal >}
+ * {@literal <}servlet-class{@literal >}
+ * com.mypackage.MyNotificationServlet
+ * {@literal <}/servlet-class{@literal >}
+ * {@literal <}/servlet{@literal >}
+ * {@literal <}servlet-mapping{@literal >}
+ * {@literal <}servlet-name{@literal >}MyNotificationServlet{@literal <}/servlet-name{@literal >}
+ * {@literal <}url-pattern{@literal >}/notifications{@literal <}/url-pattern{@literal >}
+ * {@literal <}/servlet-mapping{@literal >}
+ * }
+ *
+ * WARNING: by default it uses {@link MemoryDataStoreFactory#getDefaultInstance()} which means it + * will NOT persist the notification channels when the servlet process dies, so it is a BAD CHOICE + * for a production application. But it is a convenient choice when testing locally, in which case + * you don't need to override it, and can simply reference it directly in your web.xml file. For + * example: + * + *
{@code
+ * {@literal <}servlet{@literal >}
+ * {@literal <}servlet-name{@literal >}NotificationServlet{@literal <}/servlet-name{@literal >}
+ * {@literal <}servlet-class{@literal >}
+ * com.google.api.client.googleapis.extensions.servlet.notificationsNotificationServlet
+ * {@literal <}/servlet-class{@literal >}
+ * {@literal <}/servlet{@literal >}
+ * {@literal <}servlet-mapping{@literal >}
+ * {@literal <}servlet-name{@literal >}NotificationServlet{@literal <}/servlet-name{@literal >}
+ * {@literal <}url-pattern{@literal >}/notifications{@literal <}/url-pattern{@literal >}
+ * {@literal <}/servlet-mapping{@literal >}
+ * }
+ *
+ * @since 2.6.0
+ */
+@Beta
+public class NotificationServlet extends HttpServlet {
+
+ private static final long serialVersionUID = 1L;
+
+ /** Notification channel data store. */
+ private final transient DataStoreIt is a wrapper around {@link #processWebhookNotification(HttpServletRequest, + * HttpServletResponse, DataStore)} that uses the data store from {@link + * StoredChannel#getDefaultDataStore(DataStoreFactory)}. + * + * @param req an {@link HttpServletRequest} object that contains the request the client has made + * of the servlet + * @param resp an {@link HttpServletResponse} object that contains the response the servlet sends + * to the client + * @param dataStoreFactory data store factory + * @exception IOException if an input or output error is detected when the servlet handles the + * request + * @exception ServletException if the request for the POST could not be handled + */ + public static void processWebhookNotification( + HttpServletRequest req, HttpServletResponse resp, DataStoreFactory dataStoreFactory) + throws ServletException, IOException { + processWebhookNotification(req, resp, StoredChannel.getDefaultDataStore(dataStoreFactory)); + } + + /** + * Utility method to process the webhook notification from {@link HttpServlet#doPost}. + * + *
The {@link HttpServletRequest#getInputStream()} is closed in a finally block inside this
+ * method. If it is not detected to be a webhook notification, an {@link
+ * HttpServletResponse#SC_BAD_REQUEST} error will be displayed. If the notification channel is
+ * found in the given notification channel data store, it will call {@link
+ * UnparsedNotificationCallback#onNotification} for the registered notification callback method.
+ *
+ * @param req an {@link HttpServletRequest} object that contains the request the client has made
+ * of the servlet
+ * @param resp an {@link HttpServletResponse} object that contains the response the servlet sends
+ * to the client
+ * @param channelDataStore notification channel data store
+ * @exception IOException if an input or output error is detected when the servlet handles the
+ * request
+ * @exception ServletException if the request for the POST could not be handled
+ */
+ public static void processWebhookNotification(
+ HttpServletRequest req, HttpServletResponse resp, DataStore
+ * Support for subscribing to topics and receiving notifications on servlet-based platforms using
+ * {@code jakarta.servlet} namespace.
+ *
+ * @since 2.6.0
+ */
+@com.google.api.client.util.Beta
+package com.google.api.client.googleapis.extensions.servlet.notifications.jakarta;
diff --git a/pom.xml b/pom.xml
index 6918eba68..34bdf9f36 100644
--- a/pom.xml
+++ b/pom.xml
@@ -130,6 +130,11 @@