com.symphony.bdk.bot.sdk.notification.NotificationInterceptor Maven / Gradle / Ivy

Go to download
package com.symphony.bdk.bot.sdk.notification;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.symphony.bdk.bot.sdk.notification.model.NotificationRequest;
import com.symphony.bdk.bot.sdk.symphony.model.SymphonyMessage;

import lombok.Setter;

/**
 * Base class for intercepting and processing incoming requests from external sources. Provides
 * mechanisms to automatically register child classes to {@link InterceptorChain}.
 *
 * @author Marcus Secato
 */
@Setter
public abstract class NotificationInterceptor {
  private static final Logger LOGGER = LoggerFactory.getLogger(NotificationInterceptor.class);

  private InterceptorChain interceptorChain;

  private void register() {
    init();
    interceptorChain.register(this);
  }

  /**
   * Initializes the NotificationInterceptor dependencies. This method can be overridden by the
   * child classes if the developers want to implement initialization logic.
   */
  protected void init() {
  }

  /**
   * Intercepts an incoming request
   *
   * @param notificationRequest the notification request
   * @param notificationMessage the notification response to be sent to Symphony
   * @return true if request processing should proceed, false if request should be discarded
   */
  boolean intercept(NotificationRequest notificationRequest,
      SymphonyMessage notificationMessage) {
    LOGGER.debug("Processing notification request");

    try {
      return process(notificationRequest, notificationMessage);
    } catch (Exception e) {
      LOGGER.error("Error processing notification request\n{}", e);
      return false;
    }
  }

  /**
   * Processes the incoming request
   *
   * @param notificationRequest the notification request
   * @param notificationMessage the notification response to be sent to Symphony
   * @return true if request processing should proceed, false if request should
   *         be discarded
   */
  public abstract boolean process(NotificationRequest notificationRequest,
      SymphonyMessage notificationMessage);

}