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

Class WebhookUtils

java.lang.Object

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

@Beta
public final class WebhookUtils
extends Object

Beta
Utilities for Webhook notifications.

Since:

1.16

Author:

Yaniv Inbar

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE Webhook notification channel type to use in the watch request.

Method Summary

Methods

Modifier and Type	Method and Description
static void	processWebhookNotification(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, com.google.api.client.util.store.DataStore<StoredChannel> channelDataStore) Utility method to process the webhook notification from HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse).
static void	processWebhookNotification(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, com.google.api.client.util.store.DataStoreFactory dataStoreFactory) Utility method to process the webhook notification from HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) by finding the notification channel in the given data store factory.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

Webhook notification channel type to use in the watch request.

See Also:

Constant Field Values

Method Detail

processWebhookNotification

public static void processWebhookNotification(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp,
                              com.google.api.client.util.store.DataStoreFactory dataStoreFactory)
                                       throws javax.servlet.ServletException,
                                              IOException

Utility method to process the webhook notification from HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) by finding the notification channel in the given data store factory.

It is a wrapper around processWebhookNotification(HttpServletRequest, HttpServletResponse, DataStore) that uses the data store from StoredChannel.getDefaultDataStore(DataStoreFactory).

Parameters:

req - an HttpServletRequest object that contains the request the client has made of the servlet

resp - an HttpServletResponse object that contains the response the servlet sends to the client

dataStoreFactory - data store factory

Throws:

IOException - if an input or output error is detected when the servlet handles the request

javax.servlet.ServletException - if the request for the POST could not be handled

processWebhookNotification

public static void processWebhookNotification(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp,
                              com.google.api.client.util.store.DataStore<StoredChannel> channelDataStore)
                                       throws javax.servlet.ServletException,
                                              IOException

Utility method to process the webhook notification from HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse).

The ServletRequest.getInputStream() is closed in a finally block inside this method. If it is not detected to be a webhook notification, an HttpServletResponse.SC_BAD_REQUEST error will be displayed. If the notification channel is found in the given notification channel data store, it will call UnparsedNotificationCallback.onNotification(com.google.api.client.googleapis.notifications.StoredChannel, com.google.api.client.googleapis.notifications.UnparsedNotification) for the registered notification callback method.

Parameters:

req - an HttpServletRequest object that contains the request the client has made of the servlet

resp - an HttpServletResponse object that contains the response the servlet sends to the client

channelDataStore - notification channel data store

Throws:

IOException - if an input or output error is detected when the servlet handles the request

javax.servlet.ServletException - if the request for the POST could not be handled