Support setting RefreshOnLogon for Initiators (#286)

* unify naming refreshAtLogon -> refreshOnLogon
* unify naming refreshMessageStoreOnLogon -> refreshOnLogon
* - removed method `isStateRefreshNeeded()`: passed `msgType` was always `MsgType.LOGON` and check for acceptor could be removed anyway
 - extracted common code to method `refreshState()`
* Moved RefreshOnLogon to Misc section in documentation.

Author: chrjohn

quickfixj-core/src/main/doc/usermanual/usage/configuration.html

@@ -601,16 +601,6 @@ <H3>QuickFIX Settings</H3>
     </TD>
     <TD> empty, ie all remote addresses are allowed </TD>
   </TR>
-  <TR ALIGN="left" VALIGN="middle">
-    <TD> <I>RefreshOnLogon</I></TD>
-
-    <TD>Refresh the session state when a logon is received. This allows a simple form of failover
-    when the message store data is persistent. The
-    option will be ignored for message stores that are not persistent
-    (e.g., MemoryStore).</TD>
-    <TD> Y<br/>N</TD>
-    <TD>N</TD>
-  </TR>
 
   <TR ALIGN="center" VALIGN="middle">
     <TD COLSPAN="4" class="subsection"><A NAME="Security">Secure Communication Options</A></TD>
@@ -1207,6 +1197,15 @@ <H3>QuickFIX Settings</H3>
                  </TD>
     <TD> </TD>
   </TR>
+  <TR ALIGN="left" VALIGN="middle">
+    <TD> <I>RefreshOnLogon</I></TD>
+    <TD>Refresh the session state when a Logon is received. This allows a simple form of failover
+    when the message store data is persistent. The
+    option will be ignored for message stores that are not persistent
+    (e.g., MemoryStore).</TD>
+    <TD> Y<br/>N</TD>
+    <TD>N</TD>
+  </TR>
   <TR ALIGN="left" VALIGN="middle">
     <TD> <I>ResetOnLogon</I> </TD>
     <TD> Determines if sequence numbers should be reset before sending/receiving a logon request. </TD>

quickfixj-core/src/main/java/quickfix/DefaultSessionFactory.java

@@ -186,7 +186,7 @@ public Session create(SessionID sessionID, SessionSettings settings) throws Conf
             final boolean resetOnLogon = getSetting(settings, sessionID, Session.SETTING_RESET_ON_LOGON,
                     false);
 
-            final boolean refreshAtLogon = getSetting(settings, sessionID,
+            final boolean refreshOnLogon = getSetting(settings, sessionID,
                     Session.SETTING_REFRESH_ON_LOGON, false);
 
             final boolean checkCompID = getSetting(settings, sessionID, Session.SETTING_CHECK_COMP_ID,
@@ -224,7 +224,7 @@ public Session create(SessionID sessionID, SessionSettings settings) throws Conf
             final Session session = new Session(application, messageStoreFactory, sessionID,
                     dataDictionaryProvider, sessionSchedule, logFactory,
                     messageFactory, heartbeatInterval, checkLatency, maxLatency, timestampPrecision,
-                    resetOnLogon, resetOnLogout, resetOnDisconnect, refreshAtLogon, checkCompID,
+                    resetOnLogon, resetOnLogout, resetOnDisconnect, refreshOnLogon, checkCompID,
                     redundantResentRequestAllowed, persistMessages, useClosedIntervalForResend,
                     testRequestDelayMultiplier, senderDefaultApplVerID, validateSequenceNumbers,
                     logonIntervals, resetOnError, disconnectOnError, disableHeartBeatCheck, rejectGarbledMessage,

quickfixj-core/src/main/java/quickfix/Session.java

@@ -294,7 +294,7 @@ public class Session implements Closeable {
 
     /**
      * Requests that state and message data be refreshed from the message store at
-     * logon, if possible. This supports simple failover behavior for acceptors
+     * logon, if possible. This supports simple failover behavior for acceptors.
      */
     public static final String SETTING_REFRESH_ON_LOGON = "RefreshOnLogon";
 
@@ -405,7 +405,7 @@ public class Session implements Closeable {
     private final boolean resetOnError;
     private final boolean disconnectOnError;
     private final UtcTimestampPrecision timestampPrecision;
-    private final boolean refreshMessageStoreAtLogon;
+    private final boolean refreshOnLogon;
     private final boolean redundantResentRequestsAllowed;
     private final boolean persistMessages;
     private final boolean checkCompID;
@@ -468,7 +468,7 @@ public class Session implements Closeable {
             LogFactory logFactory, MessageFactory messageFactory, int heartbeatInterval,
             boolean checkLatency, int maxLatency, UtcTimestampPrecision timestampPrecision,
             boolean resetOnLogon, boolean resetOnLogout, boolean resetOnDisconnect,
-            boolean refreshMessageStoreAtLogon, boolean checkCompID,
+            boolean refreshOnLogon, boolean checkCompID,
             boolean redundantResentRequestsAllowed, boolean persistMessages,
             boolean useClosedRangeForResend, double testRequestDelayMultiplier,
             DefaultApplVerID senderDefaultApplVerID, boolean validateSequenceNumbers,
@@ -488,7 +488,7 @@ public class Session implements Closeable {
         this.resetOnLogout = resetOnLogout;
         this.resetOnDisconnect = resetOnDisconnect;
         this.timestampPrecision = timestampPrecision;
-        this.refreshMessageStoreAtLogon = refreshMessageStoreAtLogon;
+        this.refreshOnLogon = refreshOnLogon;
         this.dataDictionaryProvider = dataDictionaryProvider;
         this.messageFactory = messageFactory;
         this.checkCompID = checkCompID;
@@ -1254,10 +1254,6 @@ private boolean resetOrDisconnectIfRequired(Message msg) {
         return false;
     }
 
-    private boolean isStateRefreshNeeded(String msgType) {
-        return refreshMessageStoreAtLogon && !state.isInitiator() && MsgType.LOGON.equals(msgType);
-    }
-
     private void nextReject(Message reject) throws FieldNotFound, RejectLogon, IncorrectDataFormat,
             IncorrectTagValue, UnsupportedMessageType, IOException, InvalidMessage {
         if (!verify(reject, false, validateSequenceNumbers)) {
@@ -2013,10 +2009,8 @@ private boolean generateLogon() throws IOException {
         if (sessionID.isFIXT()) {
             logon.setField(DefaultApplVerID.FIELD, senderDefaultApplVerID);
         }
-        if (isStateRefreshNeeded(MsgType.LOGON)) {
-            getLog().onEvent("Refreshing message/state store at logon");
-            getStore().refresh();
-            stateListener.onRefresh();
+        if (refreshOnLogon) {
+            refreshState();
         }
         if (resetOnLogon) {
             resetState();
@@ -2117,10 +2111,8 @@ private void nextLogon(Message logon) throws FieldNotFound, RejectLogon, Incorre
         // QFJ-926 - reset session before accepting Logon
         resetIfSessionNotCurrent(sessionID, SystemTime.currentTimeMillis());
 
-        if (isStateRefreshNeeded(MsgType.LOGON)) {
-            getLog().onEvent("Refreshing message/state store at logon");
-            getStore().refresh();
-            stateListener.onRefresh();
+        if (refreshOnLogon) {
+            refreshState();
         }
 
         if (logon.isSetField(ResetSeqNumFlag.FIELD)) {
@@ -2803,7 +2795,7 @@ public boolean getRedundantResentRequestsAllowed() {
     }
 
     public boolean getRefreshOnLogon() {
-        return refreshMessageStoreAtLogon;
+        return refreshOnLogon;
     }
 
     public boolean getResetOnDisconnect() {
@@ -3033,4 +3025,10 @@ private void setLogonTags(final Message logon) {
         }
     }
 
+    private void refreshState() throws IOException {
+        getLog().onEvent("Refreshing message/state store on Logon");
+        getStore().refresh();
+        stateListener.onRefresh();
+    }
+
 }