com.github.marsbits.restfbmessenger.webhook.AbstractCallbackHandler Maven / Gradle / Ivy
/*
* Copyright 2015-2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.marsbits.restfbmessenger.webhook;
import static java.lang.String.format;
import static java.util.logging.Level.FINE;
import static java.util.logging.Level.WARNING;
import java.util.logging.Logger;
import com.github.marsbits.restfbmessenger.Messenger;
import com.restfb.types.webhook.WebhookEntry;
import com.restfb.types.webhook.WebhookObject;
import com.restfb.types.webhook.messaging.AccountLinkingItem;
import com.restfb.types.webhook.messaging.CheckoutUpdateItem;
import com.restfb.types.webhook.messaging.DeliveryItem;
import com.restfb.types.webhook.messaging.InnerMessagingItem;
import com.restfb.types.webhook.messaging.MessageItem;
import com.restfb.types.webhook.messaging.MessagingItem;
import com.restfb.types.webhook.messaging.OptinItem;
import com.restfb.types.webhook.messaging.PaymentItem;
import com.restfb.types.webhook.messaging.PostbackItem;
import com.restfb.types.webhook.messaging.ReadItem;
/**
* Abstract implementation of the {@link CallbackHandler} interface.
*
* This class processes the received webhook and delegates the actual callbacks to the appropriate
* methods like {@link #onMessage(Messenger, MessagingItem)},
* {@link #onPostback(Messenger, MessagingItem)} etc.
*
* Custom classes that extend this {@code AbstractCallbackHandler} should override the callback
* methods that they want to listen and interact to.
*
* A special case is the {@link #fallback(Messenger, MessagingItem)} methdod which is called when
* the received callback type is unknown. This could potentially happen when Facebook introduces new
* callback types.
*
* @author Marcel Overdijk
* @since 1.0.0
*/
public abstract class AbstractCallbackHandler implements CallbackHandler {
private static final Logger logger = Logger.getLogger(AbstractCallbackHandler.class.getName());
@Override
public final void onCallback(Messenger messenger, WebhookObject webhookObject) {
if (webhookObject != null) {
for (WebhookEntry entry : webhookObject.getEntryList()) {
if (logger.isLoggable(FINE)) {
logger.fine(format("Handling entry: %s", entry));
}
for (MessagingItem messaging : entry.getMessaging()) {
if (logger.isLoggable(FINE)) {
logger.fine(format("Handling messaging item: %s", messaging));
}
InnerMessagingItem innerMessagingItem = messaging.getItem();
if (innerMessagingItem instanceof MessageItem) {
if (((MessageItem) innerMessagingItem).isEcho()) {
onMessageEcho(messenger, messaging);
} else {
onMessage(messenger, messaging);
}
} else if (innerMessagingItem instanceof PostbackItem) {
onPostback(messenger, messaging);
} else if (innerMessagingItem instanceof OptinItem) {
onOptin(messenger, messaging);
} else if (innerMessagingItem instanceof AccountLinkingItem) {
onAccountLinking(messenger, messaging);
} else if (innerMessagingItem instanceof DeliveryItem) {
onMessageDelivered(messenger, messaging);
} else if (innerMessagingItem instanceof ReadItem) {
onMessageRead(messenger, messaging);
} else if (innerMessagingItem instanceof CheckoutUpdateItem) {
onCheckoutUpdate(messenger, messaging);
} else if (innerMessagingItem instanceof PaymentItem) {
onPayment(messenger, messaging);
} else {
if (logger.isLoggable(WARNING)) {
Class clazz = innerMessagingItem != null
? innerMessagingItem.getClass() : null;
logger.warning(format("Unknown inner messaging item: %s", clazz));
}
fallback(messenger, messaging);
}
}
}
}
}
/**
* Handles a message callback.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the message data
*/
public void onMessage(Messenger messenger, MessagingItem messaging) {
}
/**
* Handles a postback callback.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the postback data
*/
public void onPostback(Messenger messenger, MessagingItem messaging) {
}
/**
* Handles a optin callback.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the optin data
*/
public void onOptin(Messenger messenger, MessagingItem messaging) {
}
/**
* Handles an account linking callback.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the account linking data
*/
public void onAccountLinking(Messenger messenger, MessagingItem messaging) {
}
/**
* Handles a message delivered callback.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the message delivered data
*/
public void onMessageDelivered(Messenger messenger, MessagingItem messaging) {
}
/**
* Handles a message read callback.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the message read data
*/
public void onMessageRead(Messenger messenger, MessagingItem messaging) {
}
/**
* Handles a message echo callback.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the message echo data
*/
public void onMessageEcho(Messenger messenger, MessagingItem messaging) {
}
/**
* Handles a checkout update callback.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the checkout update data
*/
public void onCheckoutUpdate(Messenger messenger, MessagingItem messaging) {
}
/**
* Handles a payment callback.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the payment data
*/
public void onPayment(Messenger messenger, MessagingItem messaging) {
}
/**
* Handles fallback for unknown callback types.
*
* @param messenger the {@code Messenger} instance that retrieved the callback
* @param messaging the {@code MessagingItem} containing the callback data
*/
public void fallback(Messenger messenger, MessagingItem messaging) {
}
}