Add custom tags to Logon message. (#285)

Adds possibility to specify tags via setting `LogonTag` or `LogonTag<n>`.

Example:
```
LogonTag=553=user
LogonTag1=554=password 
```

It is checked whether a data dictionary is present to determine whether the specified tag is a header field. Otherwise it is put into the body of the message.

Author: chrjohn

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

@@ -1192,7 +1192,29 @@ <H3>QuickFIX Settings</H3>
 
     <TD COLSPAN="4" class="subsection"><A NAME="Miscellaneous">Miscellaneous</A></TD>
   </TR>
-<TR ALIGN="left" VALIGN="middle">
+  <TR ALIGN="left" VALIGN="middle">
+    <TD> <I>LogonTag</I> </TD>
+    <TD> Tag/value pair which will be set on sent or received Logon message. </TD>
+    <TD> &lt;tag&gt;=&lt;value&gt;, where "tag" has to be a positive integer and "value" a String <br>
+        Example: <br>
+                 LogonTag=553=foo
+                 </TD>
+    <TD> </TD>
+  </TR>
+  <TR ALIGN="left" VALIGN="middle">
+    <TD> <I>LogonTag&lt;n&gt;</I> </TD>
+    <TD> Additional tag/value pairs which will be set on sent or received Logon message,<br>
+         where <b>n</b> is a positive integer, i.e. LogonTag1, LogonTag2, etc.
+         Must be consecutive.
+    </TD>
+    <TD> &lt;tag&gt;=&lt;value&gt;, where "tag" has to be a positive integer and "value" a String <br>
+        Example: <br>
+                 LogonTag=553=user<br>
+                 LogonTag1=554=password
+                 </TD>
+    <TD> </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>
     <TD> Y<br>N</TD>
@@ -1202,13 +1224,11 @@ <H3>QuickFIX Settings</H3>
     <TD> <I>ResetOnLogout</I> </TD>
     <TD> Determines if sequence numbers should be reset to 1 after a normal logout termination. </TD>
     <TD> Y<br>N</TD>
-
     <TD> N </TD>
   </TR>
   <TR ALIGN="left" VALIGN="middle">
     <TD> <I>ResetOnDisconnect</I> </TD>
     <TD> Determines if sequence numbers should be reset to 1 after an abnormal termination. </TD>
-
     <TD> Y<br>N</TD>
     <TD> N </TD>
   </TR>

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

@@ -25,8 +25,10 @@
 import quickfix.field.DefaultApplVerID;
 
 import java.net.InetAddress;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Enumeration;
+import java.util.List;
 import java.util.Properties;
 import java.util.Set;
 
@@ -214,6 +216,8 @@ public Session create(SessionID sessionID, SessionSettings settings) throws Conf
 
             final SessionSchedule sessionSchedule = sessionScheduleFactory.create(sessionID, settings);
 
+            final List<StringField> logonTags = getLogonTags(settings, sessionID);
+
             final Session session = new Session(application, messageStoreFactory, sessionID,
                     dataDictionaryProvider, sessionSchedule, logFactory,
                     messageFactory, heartbeatInterval, checkLatency, maxLatency, timestampPrecision,
@@ -224,7 +228,7 @@ public Session create(SessionID sessionID, SessionSettings settings) throws Conf
                     rejectInvalidMessage, rejectMessageOnUnhandledException, requiresOrigSendingTime,
                     forceResendWhenCorruptedStore, allowedRemoteAddresses, validateIncomingMessage,
                     resendRequestChunkSize, enableNextExpectedMsgSeqNum, enableLastMsgSeqNumProcessed,
-                    validateChecksum);
+                    validateChecksum, logonTags);
 
             session.setLogonTimeout(logonTimeout);
             session.setLogoutTimeout(logoutTimeout);
@@ -427,4 +431,21 @@ private UtcTimestampPrecision getTimestampPrecision(SessionSettings settings, Se
         }
     }
 
+    private List<StringField> getLogonTags(SessionSettings settings, SessionID sessionID) throws ConfigError, FieldConvertError {
+        List<StringField> logonTags = new ArrayList<>();
+        for (int index = 0;; index++) {
+            final String logonTagSetting = Session.SETTING_LOGON_TAG
+                    + (index == 0 ? "" : NumbersCache.get(index));
+            if (settings.isSetting(sessionID, logonTagSetting)) {
+                String tag = settings.getString(sessionID, logonTagSetting);
+                String[] split = tag.split("=", 2);
+                StringField stringField = new StringField(Integer.valueOf(split[0]), split[1]);
+                logonTags.add(stringField);
+            } else {
+                break;
+            }
+        }
+        return logonTags;
+    }
+
 }

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

@@ -80,10 +80,11 @@ public T getObject() {
     }
 
     /**
-     * Return's the formatted field (tag=value<SOH>)
+     * Returns the formatted field (tag=value<SOH>)
      *
      * @return the formatted field
      */
+    @Override
     public String toString() {
         calculate();
         return data;

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

@@ -224,6 +224,12 @@ public class Session implements Closeable {
      */
     public static final String SETTING_LOGOUT_TIMEOUT = "LogoutTimeout";
 
+    /**
+     * Session setting for custom logon tags. Single entry or consecutive list of
+     * tag=value pairs, e.g. LogonTag=553=user and LogonTag1=554=password.
+     */
+    public static final String SETTING_LOGON_TAG = "LogonTag";
+
     /**
      * Session setting for doing an automatic sequence number reset on logout.
      * Valid values are "Y" or "N". Default is "N".
@@ -437,6 +443,8 @@ public class Session implements Closeable {
     private static final String BAD_ORIG_TIME_TEXT = new FieldException(BAD_TIME_REJ_REASON, OrigSendingTime.FIELD).getMessage();
     private static final String BAD_TIME_TEXT = new FieldException(BAD_TIME_REJ_REASON, SendingTime.FIELD).getMessage();
 
+    private final List<StringField> logonTags;
+
     protected static final Logger LOG = LoggerFactory.getLogger(Session.class);
 
 
@@ -446,8 +454,8 @@ public class Session implements Closeable {
         this(application, messageStoreFactory, sessionID, dataDictionaryProvider, sessionSchedule,
                 logFactory, messageFactory, heartbeatInterval, true, DEFAULT_MAX_LATENCY, UtcTimestampPrecision.MILLIS,
                 false, false, false, false, true, false, true, false,
-                DEFAULT_TEST_REQUEST_DELAY_MULTIPLIER, null, true, new int[] { 5 }, false, false,
-                false, false, true, false, true, false, null, true, DEFAULT_RESEND_RANGE_CHUNK_SIZE, false, false, false);
+                DEFAULT_TEST_REQUEST_DELAY_MULTIPLIER, null, true, new int[]{5}, false, false,
+                false, false, true, false, true, false, null, true, DEFAULT_RESEND_RANGE_CHUNK_SIZE, false, false, false, new ArrayList<StringField>());
     }
 
     Session(Application application, MessageStoreFactory messageStoreFactory, SessionID sessionID,
@@ -465,7 +473,7 @@ public class Session implements Closeable {
             boolean forceResendWhenCorruptedStore, Set<InetAddress> allowedRemoteAddresses,
             boolean validateIncomingMessage, int resendRequestChunkSize,
             boolean enableNextExpectedMsgSeqNum, boolean enableLastMsgSeqNumProcessed,
-            boolean validateChecksum) {
+            boolean validateChecksum, List<StringField> logonTags) {
         this.application = application;
         this.sessionID = sessionID;
         this.sessionSchedule = sessionSchedule;
@@ -499,6 +507,7 @@ public class Session implements Closeable {
         this.enableNextExpectedMsgSeqNum = enableNextExpectedMsgSeqNum;
         this.enableLastMsgSeqNumProcessed = enableLastMsgSeqNumProcessed;
         this.validateChecksum = validateChecksum;
+        this.logonTags = logonTags;
 
         final Log engineLog = (logFactory != null) ? logFactory.create(sessionID) : null;
         if (engineLog instanceof SessionStateListener) {
@@ -2020,6 +2029,8 @@ private boolean generateLogon() throws IOException {
             logon.setInt(NextExpectedMsgSeqNum.FIELD, nextExpectedMsgNum);
             state.setLastExpectedLogonNextSeqNum(nextExpectedMsgNum);
         }
+        
+        setLogonTags(logon);
         return sendRaw(logon, 0);
     }
 
@@ -2534,6 +2545,8 @@ private void generateLogon(Message otherLogon, int expectedTargetNum) throws Fie
         } else {
             getLog().onEvent("Responding to Logon request");
         }
+        
+        setLogonTags(logon);
         sendRaw(logon, 0);
         state.setLogonSent(true);
     }
@@ -3004,4 +3017,15 @@ private String getMessageToLog(final Message message) {
         return (message.toRawString() != null ? message.toRawString() : message.toString());
     }
 
+    private void setLogonTags(final Message logon) {
+        for (StringField field : logonTags) {
+            if (dataDictionaryProvider != null
+                    && dataDictionaryProvider.getSessionDataDictionary(sessionID.getBeginString()).isHeaderField(field.getTag())) {
+                logon.getHeader().setField(field);
+                continue;
+            }
+            logon.setField(field);
+        }
+    }
+
 }

quickfixj-core/src/test/java/quickfix/SessionFactoryTestSupport.java

@@ -3,6 +3,8 @@
 import quickfix.field.DefaultApplVerID;
 
 import java.net.InetAddress;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Set;
 import java.util.function.Supplier;
 
@@ -108,6 +110,7 @@ public static final class Builder {
         private boolean enableNextExpectedMsgSeqNum = false;
         private final boolean enableLastMsgSeqNumProcessed = false;
         private final boolean validateChecksum = true;
+        private List<StringField> logonTags = new ArrayList<>();
 
         public Session build() {
             return new Session(applicationSupplier.get(), messageStoreFactorySupplier.get(), sessionIDSupplier.get(),
@@ -119,7 +122,7 @@ public Session build() {
                     resetOnError, disconnectOnError, disableHeartBeatCheck, false, rejectInvalidMessage,
                     rejectMessageOnUnhandledException, requiresOrigSendingTime, forceResendWhenCorruptedStore,
                     allowedRemoteAddresses, validateIncomingMessage, resendRequestChunkSize, enableNextExpectedMsgSeqNum,
-                    enableLastMsgSeqNumProcessed, validateChecksum);
+                    enableLastMsgSeqNumProcessed, validateChecksum, logonTags);
         }
 
         public Builder setBeginString(final String beginString) {
@@ -169,6 +172,11 @@ public Builder setLogFactory(final LogFactory logFactory) {
             return this;
         }
 
+        public Builder setLogonTags(final List<StringField> logonTags) {
+            this.logonTags = logonTags;
+            return this;
+        }
+
         public Builder setMessageFactory(final MessageFactory messageFactory) {
             this.messageFactorySupplier = () -> messageFactory;
             return this;