Merge branch 'develop' of https://github.com/mifosio/command into develop
diff --git a/src/main/java/io/mifos/core/command/annotation/CommandHandler.java b/src/main/java/io/mifos/core/command/annotation/CommandHandler.java
index e1db3e3..44c069d 100644
--- a/src/main/java/io/mifos/core/command/annotation/CommandHandler.java
+++ b/src/main/java/io/mifos/core/command/annotation/CommandHandler.java
@@ -21,6 +21,26 @@
@Target(ElementType.METHOD)
@Documented
public @interface CommandHandler {
+ /**
+ *
+ * @return the log level with which to log a command which will be sent to a command handler. By default this is
+ * NONE. The level should be left at NONE for sensitive data which do not belong in the log file, such as
+ * passwords, financial transactions, and customer names and addresses. The logfile contents will include what
+ * is output by "toString" of the command, so any fine-tuning of the contents of the logfile can be performed there.
+ * For commands which happen frequently this can produce a lot of output. Consider using a log level of DEBUG or
+ * TRACE if you decide to log a command of that sort. No log level of ERROR, or WARNING is offered here, because
+ * a command is not an error.
+ */
CommandLogLevel logStart() default CommandLogLevel.NONE;
+
+ /**
+ *
+ * @return the log level with which to log the result of a command which emits an event. Leave this as it's default
+ * NONE, if the command is not event-emitting. The level should also be left at NONE for sensitive data which do
+ * not belong in the log file, however you should consider not putting such data in the event queue in the first
+ * place. The logfile contents will include the output of the events "toString". For commands which happen frequently,
+ * this can produce a lot of output. Consider not using INFO as a log level for a command of that sort. If a command
+ * handler is exited via an exception, no event is logged, but the exception may be logged regardless of this setting.
+ */
CommandLogLevel logFinish() default CommandLogLevel.NONE;
}
