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

Class AbstractWebHookServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.api.client.googleapis.extensions.servlet.subscriptions.AbstractWebHookServlet

All Implemented Interfaces:

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

@Beta
public abstract class AbstractWebHookServlet
extends javax.servlet.http.HttpServlet

Beta
WebHook Servlet to receive UnparsedNotification.

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

Implementation is thread-safe.

Example usage:

    public class NotificationServlet extends AbstractWebHookServlet {

      private static final long serialVersionUID = 1L;

      @Override
      protected SubscriptionStore createSubscriptionStore() {
        return new CachedAppEngineSubscriptionStore();
      }
    }
 

web.xml setup:

      <servlet>
          <servlet-name>NotificationServlet</servlet-name>
          <servlet-class>com.mypackage.NotificationServlet</servlet-class>
      </servlet>
      <servlet-mapping>
          <servlet-name>NotificationServlet</servlet-name>
          <url-pattern>/notificiations</url-pattern>
      </servlet-mapping>
      <security-constraint>
        <!-- Lift any ACL imposed upon the servlet -->
        <web-resource-collection>
          <web-resource-name>any</web-resource-name>
          <url-pattern>/notifications</url-pattern>
        </web-resource-collection>
      </security-constraint>
 

Since:

1.14

Author:

Matthias Linder (mlinder)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNSUBSCRIBE_HEADER Name of header for the ID of the subscription for which you no longer wish to receive notifications (used in the response to a WebHook notification).

Constructor Summary

Constructors

Constructor and Description
AbstractWebHookServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract SubscriptionStore	createSubscriptionStore() Used to get access to the subscription store in order to handle incoming notifications.
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
SubscriptionStore	getSubscriptionStore() Returns the (cached) subscription store.
protected void	sendUnsubscribeResponse(javax.servlet.http.HttpServletResponse resp, UnparsedNotification notification) Responds to a notification with a 200 OK response with the X-Unsubscribe header which causes the subscription to be removed.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, 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

Field Detail

UNSUBSCRIBE_HEADER

public static final String UNSUBSCRIBE_HEADER

Name of header for the ID of the subscription for which you no longer wish to receive notifications (used in the response to a WebHook notification).

See Also:

Constant Field Values

Constructor Detail

AbstractWebHookServlet

public AbstractWebHookServlet()

Method Detail

createSubscriptionStore

protected abstract SubscriptionStore createSubscriptionStore()

Used to get access to the subscription store in order to handle incoming notifications.

getSubscriptionStore

public final SubscriptionStore getSubscriptionStore()

Returns the (cached) subscription store.

sendUnsubscribeResponse

protected void sendUnsubscribeResponse(javax.servlet.http.HttpServletResponse resp,
                           UnparsedNotification notification)

Responds to a notification with a 200 OK response with the X-Unsubscribe header which causes the subscription to be removed.

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

doGet

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

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException