net.croz.nrich.notification.api.service.BaseNotificationResponseService Maven / Gradle / Ivy
/*
* Copyright 2020-2023 CROZ d.o.o, 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
*
* https://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 net.croz.nrich.notification.api.service;
import net.croz.nrich.notification.api.model.AdditionalNotificationData;
import net.croz.nrich.notification.api.response.NotificationDataResponse;
import org.springframework.validation.Errors;
import jakarta.validation.ConstraintViolationException;
/**
* Helper service for creation of response with notification.
*
* @param Type of response with notification i.e. {@link NotificationDataResponse}
*/
public interface BaseNotificationResponseService {
/**
* Returns response with {@link net.croz.nrich.notification.api.model.ValidationFailureNotification} instance.
*
* @param errors Spring's {@link Errors} that will be used to resolve validation notification messages.
* @param validationFailedOwningType class on which validation errors were found
* @param additionalNotificationData additional notification data to add to notification
* @return response with validation failure notification
*/
T responseWithValidationFailureNotification(Errors errors, Class validationFailedOwningType, AdditionalNotificationData additionalNotificationData);
/**
* Returns response with {@link net.croz.nrich.notification.api.model.ValidationFailureNotification} instance.
*
* @param exception validation exception that will be used to resolve validation notification messages.
* @param additionalNotificationData additional notification data to add to notification
* @return response with validation failure notification
*/
T responseWithValidationFailureNotification(ConstraintViolationException exception, AdditionalNotificationData additionalNotificationData);
/**
* Returns response with {@link net.croz.nrich.notification.api.model.Notification} instance.
*
* @param throwable exception for which to resolve notification
* @param additionalNotificationData additional notification data to add to notification
* @return response with notification
*/
T responseWithExceptionNotification(Throwable throwable, AdditionalNotificationData additionalNotificationData);
/**
* Returns response with {@link net.croz.nrich.notification.api.model.Notification} instance.
*
* @param actionName name of the action for which to resolve notification
* @param additionalNotificationData additional notification data to add to notification
* @return response with notification
*/
T responseWithNotification(String actionName, AdditionalNotificationData additionalNotificationData);
/**
* Returns response with {@link net.croz.nrich.notification.api.model.Notification} instance.
*
* @param additionalNotificationData additional notification data to add to notification
* @return response with notification
*/
T responseWithNotificationActionResolvedFromRequest(AdditionalNotificationData additionalNotificationData);
NotificationResolverService notificationResolverService();
default T responseWithValidationFailureNotification(Errors errors, Class validationFailedOwningType) {
return responseWithValidationFailureNotification(errors, validationFailedOwningType, AdditionalNotificationData.empty());
}
default T responseWithValidationFailureNotification(ConstraintViolationException exception) {
return responseWithValidationFailureNotification(exception, AdditionalNotificationData.empty());
}
default T responseWithExceptionNotification(Throwable throwable) {
return responseWithExceptionNotification(throwable, AdditionalNotificationData.empty());
}
default T responseWithNotificationActionResolvedFromRequest() {
return responseWithNotificationActionResolvedFromRequest(AdditionalNotificationData.empty());
}
default T responseWithNotification(String actionName) {
return responseWithNotification(actionName, AdditionalNotificationData.empty());
}
}