dk.heick.properties.collections.validationhandlers

Class SendMessagePropertyValidationHandler

java.lang.Object

dk.heick.properties.collections.validationhandlers.LoggingPropertyValidationHandler

dk.heick.properties.collections.validationhandlers.SendMessagePropertyValidationHandler

All Implemented Interfaces:

PropertyValidationHandler, Serializable

public class SendMessagePropertyValidationHandler
extends LoggingPropertyValidationHandler

Sends a message via the ValidationMessager if either the PropertyIO and any of the Property's is invalid.

Since:

1.3

Author:

Frederik Heick

See Also:

ValidationMessenger, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendMessagePropertyValidationHandler(Property<List<String>> sendToList, Property<String> validationFailedSubject, ValidationMessenger messenger) Constructor.
SendMessagePropertyValidationHandler(Property<List<String>> sendToList, Property<String> validationFailedSubject, ValidationMessenger messenger, boolean doSystemExitIfAnythingNotInvalid) Constructor.
SendMessagePropertyValidationHandler(String[] sendToArray, String validationFailedSubject, ValidationMessenger messenger) Constructor.
SendMessagePropertyValidationHandler(String[] sendToArray, String validationFailedSubject, ValidationMessenger messenger, boolean doSystemExitIfAnythingNotInvalid) Constructor.
SendMessagePropertyValidationHandler(String sendTo, String validationFailedSubject, ValidationMessenger messenger) Constructor.
SendMessagePropertyValidationHandler(String sendTo, String validationFailedSubject, ValidationMessenger messenger, boolean doSystemExitIfAnythingNotInvalid) Constructor.

Method Summary

Modifier and Type	Method and Description
void	afterValidation(org.apache.commons.logging.Log logger, boolean isAllValid) Method called after validation of the PropertyIO and all the Property's.
ValidationMessenger	getMessenger() The validation messager.
String[]	getSendTo() Who shall the message be sent to.
String	getValidationFailedSubject() What subject will there be for the message, use something easily recognizable so a filter easily will pick it up.
void	invalidProperty(org.apache.commons.logging.Log logger, Property<?> property, Exception exception) A handle of a property which is INVALID.
void	invalidPropertyIO(org.apache.commons.logging.Log logger, PropertyIO io, Exception exception) If the propertyIO was INVALID (aka it could NOT find the property file etc.)
boolean	isLazyLoad()
protected void	sendMessage(org.apache.commons.logging.Log logger)

Methods inherited from class dk.heick.properties.collections.validationhandlers.LoggingPropertyValidationHandler

isDoSystemExitIfAnythingIsInvalid, logError, logInfo, validProperty, validPropertyIO

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SendMessagePropertyValidationHandler

public SendMessagePropertyValidationHandler(String[] sendToArray,
                                            String validationFailedSubject,
                                            ValidationMessenger messenger,
                                            boolean doSystemExitIfAnythingNotInvalid)

Constructor.

Parameters:

sendToArray - who shall the message be sent to as an array.

validationFailedSubject - what subject will there be for the message, use something easily recognizable so a filter easily will pick it up.

messenger - the validationMessager instance.

doSystemExitIfAnythingNotInvalid - if true an System.exit(42); will be performed if either the PropertyIO or any Property is invalid.

SendMessagePropertyValidationHandler

public SendMessagePropertyValidationHandler(String[] sendToArray,
                                            String validationFailedSubject,
                                            ValidationMessenger messenger)

Constructor. Where doSystemExitIfAnythingNotInvalid is false.

Parameters:

sendToArray - who shall the message be sent to as an array.

validationFailedSubject - what subject will there be for the message, use something easily recognizable so a filter easily will pick it up.

messenger - the validationMessager instance.

SendMessagePropertyValidationHandler

public SendMessagePropertyValidationHandler(String sendTo,
                                            String validationFailedSubject,
                                            ValidationMessenger messenger,
                                            boolean doSystemExitIfAnythingNotInvalid)

Constructor.

Parameters:

sendTo - who shall the message be sent to.

validationFailedSubject - what subject will there be for the message, use something easily recognizable so a filter easily will pick it up.

messenger - the validationMessager instance.

doSystemExitIfAnythingNotInvalid - if true an System.exit(42); will be performed if either the PropertyIO or any Property is invalid.

SendMessagePropertyValidationHandler

public SendMessagePropertyValidationHandler(String sendTo,
                                            String validationFailedSubject,
                                            ValidationMessenger messenger)

Constructor. Where doSystemExitIfAnythingNotInvalid is false.

Parameters:

sendTo - who shall the message be sent to.

validationFailedSubject - what subject will there be for the message, use something easily recognizable so a filter easily will pick it up.

messenger - the validationMessager instance.

SendMessagePropertyValidationHandler

public SendMessagePropertyValidationHandler(Property<List<String>> sendToList,
                                            Property<String> validationFailedSubject,
                                            ValidationMessenger messenger,
                                            boolean doSystemExitIfAnythingNotInvalid)

Constructor. The values will first be loaded when the sendMessage method is executed.

Parameters:

sendToList - who shall the message be sent to as a Property as List of String.

validationFailedSubject - what subject will there be for the message, use something easily recognizable so a filter easily will pick it up.

messenger - the validationMessager instance.

doSystemExitIfAnythingNotInvalid - if true an System.exit(42); will be performed if either the PropertyIO or any Property is invalid.

SendMessagePropertyValidationHandler

public SendMessagePropertyValidationHandler(Property<List<String>> sendToList,
                                            Property<String> validationFailedSubject,
                                            ValidationMessenger messenger)

Constructor. The values will first be loaded when the sendMessage method is executed. Where doSystemExitIfAnythingNotInvalid is false.

Parameters:

sendToList - who shall the message be sent to as a Property as List of String.

validationFailedSubject - what subject will there be for the message, use something easily recognizable so a filter easily will pick it up.

messenger - the validationMessager instance.

Method Detail

invalidProperty

public void invalidProperty(org.apache.commons.logging.Log logger,
                            Property<?> property,
                            Exception exception)

Description copied from interface: PropertyValidationHandler

A handle of a property which is INVALID.

Specified by:

invalidProperty in interface PropertyValidationHandler

Overrides:

invalidProperty in class LoggingPropertyValidationHandler

Parameters:

logger - the logger, if null than System.err is used.

property - the property which is INVALID, can be null.

exception - the exception

invalidPropertyIO

public void invalidPropertyIO(org.apache.commons.logging.Log logger,
                              PropertyIO io,
                              Exception exception)

Description copied from interface: PropertyValidationHandler

If the propertyIO was INVALID (aka it could NOT find the property file etc.)

Specified by:

invalidPropertyIO in interface PropertyValidationHandler

Overrides:

invalidPropertyIO in class LoggingPropertyValidationHandler

Parameters:

logger - the logger, if null than System.err is used.

io - the IO used

exception - the exception

afterValidation

public void afterValidation(org.apache.commons.logging.Log logger,
                            boolean isAllValid)

Description copied from interface: PropertyValidationHandler

Method called after validation of the PropertyIO and all the Property's.

Specified by:

afterValidation in interface PropertyValidationHandler

Overrides:

afterValidation in class LoggingPropertyValidationHandler

Parameters:

logger - the logger, if null than System.err or System.out is used

isAllValid - true if PropertyIO and all Property's is valid, otherwise false.

sendMessage

protected void sendMessage(org.apache.commons.logging.Log logger)

getMessenger

public ValidationMessenger getMessenger()

The validation messager.

Returns:

The validation messager.

getSendTo

public String[] getSendTo()

Who shall the message be sent to.

Returns:

Who shall the message be sent to.

isLazyLoad

public boolean isLazyLoad()

getValidationFailedSubject

public String getValidationFailedSubject()

What subject will there be for the message, use something easily recognizable so a filter easily will pick it up.

Returns:

the mesage subject