com.google.api.client.googleapis.extensions.servlet.notifications

Class NotificationServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.api.client.googleapis.extensions.servlet.notifications.NotificationServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

@Beta
public class NotificationServlet
extends javax.servlet.http.HttpServlet

Beta
Thread-safe Webhook Servlet to receive notifications.

In order to use this servlet you should create a class inheriting from NotificationServlet and register the servlet in your web.xml.

It is a simple wrapper around WebhookUtils.processWebhookNotification(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.google.api.client.util.store.DataStoreFactory), so if you you may alternatively call that method instead from your HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) with no loss of functionality. Example usage:

 public class MyNotificationServlet extends NotificationServlet {

   private static final long serialVersionUID = 1L;

   public MyNotificationServlet() throws IOException {
     super(new SomeDataStoreFactory());
   }
 }
 

Sample web.xml setup:

 {@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 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:

 {@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:

1.16

Author:

Yaniv Inbar

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	NotificationServlet() Constructor to be used for testing and demo purposes that uses 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.
protected	NotificationServlet(DataStore<StoredChannel> channelDataStore) Constructor that allows a specific notification data store to be specified.
protected	NotificationServlet(DataStoreFactory dataStoreFactory) Constructor which uses StoredChannel.getDefaultDataStore(DataStoreFactory) on the given data store factory, which is the normal use case.

Method Summary

Modifier and Type	Method and Description
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationServlet

public NotificationServlet()
                    throws IOException

Constructor to be used for testing and demo purposes that uses 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.

Throws:

IOException

NotificationServlet

protected NotificationServlet(DataStoreFactory dataStoreFactory)
                       throws IOException

Constructor which uses StoredChannel.getDefaultDataStore(DataStoreFactory) on the given data store factory, which is the normal use case.

Parameters:

dataStoreFactory - data store factory

Throws:

IOException

NotificationServlet

protected NotificationServlet(DataStore<StoredChannel> channelDataStore)

Constructor that allows a specific notification data store to be specified.

Parameters:

channelDataStore - notification channel data store

Method Detail

doPost

protected void doPost(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse resp)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException