net.croz.nrich.notification.api.service

Interface BaseNotificationResponseService<T>

Type Parameters:

T - Type of response with notification i.e. NotificationDataResponse

All Known Subinterfaces:

NotificationResponseService

public interface BaseNotificationResponseService<T>

Helper service for creation of response with notification.

Method Summary

Modifier and Type	Method and Description
NotificationResolverService	notificationResolverService()
T	responseWithExceptionNotification(java.lang.Throwable throwable, AdditionalNotificationData additionalNotificationData, java.lang.Object... exceptionMessageArgumentList) Returns response with Notification instance.
default T	responseWithExceptionNotification(java.lang.Throwable throwable, java.lang.Object... additionalMessageArgumentList)
default T	responseWithNotification(java.lang.String actionName)
T	responseWithNotification(java.lang.String actionName, AdditionalNotificationData additionalNotificationData) Returns response with Notification instance.
default T	responseWithNotificationActionResolvedFromRequest()
T	responseWithNotificationActionResolvedFromRequest(AdditionalNotificationData additionalNotificationData) Returns response with Notification instance.
default T	responseWithValidationFailureNotification(javax.validation.ConstraintViolationException exception)
T	responseWithValidationFailureNotification(javax.validation.ConstraintViolationException exception, AdditionalNotificationData additionalNotificationData) Returns response with ValidationFailureNotification instance.
default T	responseWithValidationFailureNotification(org.springframework.validation.Errors errors, java.lang.Class<?> validationFailedOwningType)
T	responseWithValidationFailureNotification(org.springframework.validation.Errors errors, java.lang.Class<?> validationFailedOwningType, AdditionalNotificationData additionalNotificationData) Returns response with ValidationFailureNotification instance.

Method Detail

responseWithValidationFailureNotification

T responseWithValidationFailureNotification(org.springframework.validation.Errors errors,
                                            java.lang.Class<?> validationFailedOwningType,
                                            AdditionalNotificationData additionalNotificationData)

Returns response with ValidationFailureNotification instance.

Parameters:

errors - Spring's Errors that will be used to resolve validation notification messages.

validationFailedOwningType - class on which validation errors were found

additionalNotificationData - additional notification data to add to notification

Returns:

response with validation failure notification

responseWithValidationFailureNotification

T responseWithValidationFailureNotification(javax.validation.ConstraintViolationException exception,
                                            AdditionalNotificationData additionalNotificationData)

Returns response with ValidationFailureNotification instance.

Parameters:

exception - validation exception that will be used to resolve validation notification messages.

additionalNotificationData - additional notification data to add to notification

Returns:

response with validation failure notification

responseWithExceptionNotification

T responseWithExceptionNotification(java.lang.Throwable throwable,
                                    AdditionalNotificationData additionalNotificationData,
                                    java.lang.Object... exceptionMessageArgumentList)

Returns response with Notification instance.

Parameters:

throwable - exception for which to resolve notification

additionalNotificationData - additional notification data to add to notification

exceptionMessageArgumentList - optional exception argument list, will be used when resolving exception message

Returns:

response with notification

responseWithNotification

T responseWithNotification(java.lang.String actionName,
                           AdditionalNotificationData additionalNotificationData)

Returns response with Notification instance.

Parameters:

actionName - name of the action for which to resolve notification

additionalNotificationData - additional notification data to add to notification

Returns:

response with notification

responseWithNotificationActionResolvedFromRequest

T responseWithNotificationActionResolvedFromRequest(AdditionalNotificationData additionalNotificationData)

Returns response with Notification instance.

Parameters:

additionalNotificationData - additional notification data to add to notification

Returns:

response with notification

notificationResolverService

NotificationResolverService notificationResolverService()

responseWithValidationFailureNotification

default T responseWithValidationFailureNotification(org.springframework.validation.Errors errors,
                                                    java.lang.Class<?> validationFailedOwningType)

responseWithValidationFailureNotification

default T responseWithValidationFailureNotification(javax.validation.ConstraintViolationException exception)

responseWithExceptionNotification

default T responseWithExceptionNotification(java.lang.Throwable throwable,
                                            java.lang.Object... additionalMessageArgumentList)

responseWithNotificationActionResolvedFromRequest

default T responseWithNotificationActionResolvedFromRequest()

responseWithNotification

default T responseWithNotification(java.lang.String actionName)