net.croz.nrich.notification.api.service

Interface NotificationResolverService

public interface NotificationResolverService

Creates notifications for exceptions, validation failures and actions.

Method Summary

Modifier and Type	Method and Description
default Notification	createNotificationForAction(java.lang.String actionName)
Notification	createNotificationForAction(java.lang.String actionName, AdditionalNotificationData additionalNotificationData) Returns Notification instance for action.
Notification	createNotificationForException(java.lang.Throwable throwable, AdditionalNotificationData additionalNotificationData, java.lang.Object... exceptionMessageArgumentList) Returns Notification instance for exception.
default Notification	createNotificationForException(java.lang.Throwable throwable, java.lang.Object... exceptionMessageArgumentList)
default ValidationFailureNotification	createNotificationForValidationFailure(javax.validation.ConstraintViolationException exception)
ValidationFailureNotification	createNotificationForValidationFailure(javax.validation.ConstraintViolationException exception, AdditionalNotificationData additionalNotificationData) Returns ValidationFailureNotification instance.
default ValidationFailureNotification	createNotificationForValidationFailure(org.springframework.validation.Errors errors, java.lang.Class<?> validationFailedOwningType)
ValidationFailureNotification	createNotificationForValidationFailure(org.springframework.validation.Errors errors, java.lang.Class<?> validationFailedOwningType, AdditionalNotificationData additionalNotificationData) Returns ValidationFailureNotification instance.

Method Detail

createNotificationForValidationFailure

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

Returns ValidationFailureNotification instance. Default severity is

WARNING

. Resolved validation failure messages are added to notification messageList. Title of notification is resolved from code

notification.validation-failed.title

and content of notification is resolved from code:

notification.validation-failed.content

.

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:

ValidationFailureNotification instance

createNotificationForValidationFailure

ValidationFailureNotification createNotificationForValidationFailure(javax.validation.ConstraintViolationException exception,
                                                                     AdditionalNotificationData additionalNotificationData)

Returns ValidationFailureNotification instance. Default severity is

WARNING

. Resolved validation failure messages are added to notification messageList. Title of notification is resolved from code

notification.validation-failed.title

and content of notification is resolved from code:

notification.validation-failed.content

.

Parameters:

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

additionalNotificationData - additional notification data to add to notification

Returns:

ValidationFailureNotification instance

createNotificationForException

Notification createNotificationForException(java.lang.Throwable throwable,
                                            AdditionalNotificationData additionalNotificationData,
                                            java.lang.Object... exceptionMessageArgumentList)

Returns Notification instance for exception. Default severity is

ERROR

. Resolved error message is added as notification content. Title of notification is resolved from code

fullyQualifiedExceptionClass.title

and content of notification is resolved from code:

fullyQualifiedExceptionClass.code

.

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:

Notification instance

createNotificationForAction

Notification createNotificationForAction(java.lang.String actionName,
                                         AdditionalNotificationData additionalNotificationData)

Returns Notification instance for action. Default severity is

INFO

. Resolved action message is added as notification content. Title of notification is resolved from code

actionName.title

and content of notification is resolved from code:

actionName.code

.

Parameters:

actionName - name of the action for which to resolve notification

additionalNotificationData - additional notification data to add to notification

Returns:

Notification instance

createNotificationForValidationFailure

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

createNotificationForValidationFailure

default ValidationFailureNotification createNotificationForValidationFailure(javax.validation.ConstraintViolationException exception)

createNotificationForException

default Notification createNotificationForException(java.lang.Throwable throwable,
                                                    java.lang.Object... exceptionMessageArgumentList)

createNotificationForAction

default Notification createNotificationForAction(java.lang.String actionName)