Add SessionStateListener.onConnectException() (#368)

* Add SessionStateListener.onConnectException()
* Added missing `@Test` annotation
* added some javadoc

Author: chrjohn

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

@@ -2885,6 +2885,10 @@ public void removeStateListener(SessionStateListener listener) {
         stateListeners.removeListener(listener);
     }
 
+    public SessionStateListener getStateListener() {
+        return stateListener;
+    }
+
     /**
      * @return the default application version ID for messages sent from this session
      */

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

@@ -16,42 +16,93 @@
  * Contact ask@quickfixengine.org if any conditions of this licensing
  * are not clear to you.
  ******************************************************************************/
-
 package quickfix;
 
 public interface SessionStateListener {
 
-    default void onConnect(){
+    /**
+     * Called when connection has been established.
+     */
+    default void onConnect() {
+    }
+
+    /**
+     * Called when Exception occurs during connection establishment.
+     *
+     * @param exception thrown Exception
+     */
+    default void onConnectException(Exception exception) {
     }
 
-    default void onDisconnect(){
+    /**
+     * Called when connection has been disconnected.
+     */
+    default void onDisconnect() {
     }
 
-    default void onLogon(){
+    /**
+     * Called when session has been logged on.
+     */
+    default void onLogon() {
     }
 
-    default void onLogout(){
+    /**
+     * Called when session has been logged out.
+     */
+    default void onLogout() {
     }
 
-    default void onReset(){
+    /**
+     * Called when message store gets reset.
+     */
+    default void onReset() {
     }
 
-    default void onRefresh(){
+    /**
+     * Called when message store gets refreshed on Logon.
+     */
+    default void onRefresh() {
     }
 
-    default void onMissedHeartBeat(){
+    /**
+     * Called when TestRequest is sent out due to missed Heartbeat.
+     */
+    default void onMissedHeartBeat() {
     }
 
-    default void onHeartBeatTimeout(){
+    /**
+     * Called when Heartbeat timeout has been detected.
+     */
+    default void onHeartBeatTimeout() {
     }
 
-    default void onResendRequestSent(int beginSeqNo, int endSeqNo, int currentEndSeqNo){
+    /**
+     * Called when ResendRequest has been sent out.
+     *
+     * @param beginSeqNo first seqnum that gets requested
+     * @param endSeqNo last seqnum that gets requested
+     * @param currentEndSeqNo last seqnum of range that gets requested on
+     * chunked ResendRequests
+     */
+    default void onResendRequestSent(int beginSeqNo, int endSeqNo, int currentEndSeqNo) {
     }
 
-    default void onSequenceResetReceived(int newSeqNo, boolean gapFillFlag){
+    /**
+     * Called when SequenceReset has been received.
+     *
+     * @param newSeqNo NewSeqNo from SequenceReset
+     * @param gapFillFlag GapFillFlag from SequenceReset
+     */
+    default void onSequenceResetReceived(int newSeqNo, boolean gapFillFlag) {
     }
 
-    default void onResendRequestSatisfied(int beginSeqNo, int endSeqNo){
+    /**
+     * Called when a received ResendRequest has been satisfied.
+     *
+     * @param beginSeqNo first seqnum that was requested
+     * @param endSeqNo last seqnum that was requested
+     */
+    default void onResendRequestSatisfied(int beginSeqNo, int endSeqNo) {
     }
 
 }

quickfixj-core/src/main/java/quickfix/mina/initiator/IoSessionInitiator.java

@@ -261,8 +261,10 @@ private void handleConnectException(Throwable e) {
             final String nextRetryMsg = " (Next retry in " + computeNextRetryConnectDelay() + " milliseconds)";
             if (e instanceof IOException) {
                 fixSession.getLog().onErrorEvent(e.getClass().getName() + " during connection to " + socketAddress + ": " + e + nextRetryMsg);
+                fixSession.getStateListener().onConnectException((IOException) e);
             } else {
                 LogUtil.logThrowable(fixSession.getLog(), "Exception during connection to " + socketAddress + nextRetryMsg, e);
+                fixSession.getStateListener().onConnectException(new Exception(e));
             }
             connectFuture = null;
         }

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

@@ -229,6 +229,45 @@ public void testDoubleStartOfInitiator() throws Exception {
         }
     }
 
+    @Test
+    public void testInitiatorConnectionException() throws Exception {
+        // use a free port to make sure nothing is listening
+        int freePort = AvailablePortFinder.getNextAvailable();
+        Initiator initiator = null;
+        AtomicBoolean onConnectExceptionWasCalled = new AtomicBoolean(false);
+        try {
+            SessionID clientSessionID = new SessionID(FixVersions.BEGINSTRING_FIX42, "TW", "ISLD");
+            SessionSettings settings = getClientSessionSettings(clientSessionID, freePort);
+            settings.setString(clientSessionID, "ReconnectInterval", "1");
+            settings.setString(clientSessionID, "SocketConnectHost", "0.0.0.0");
+            settings.setString(clientSessionID, "SocketConnectProtocol", ProtocolFactory.getTypeString(ProtocolFactory.SOCKET));
+
+            SessionStateListener sessionStateListener = new SessionStateListener() {
+                @Override
+                public void onConnectException(Exception e) {
+                    onConnectExceptionWasCalled.set(true);
+                }
+            };
+            // add state listener on creation of Session
+            Application clientApplication = new ApplicationAdapter() {
+                @Override
+                public void onCreate(SessionID sessionId) {
+                    Session.lookupSession(clientSessionID).addStateListener(sessionStateListener);
+                }
+            };
+            DefaultSessionFactory sessionFactory = new DefaultSessionFactory(clientApplication, new MemoryStoreFactory(), new ScreenLogFactory(settings), new DefaultMessageFactory());
+            initiator = new SocketInitiator(sessionFactory, settings, 10000);
+            initiator.start();
+            Thread.sleep(3000); // make sure we try to connect
+        } finally {
+            if (initiator != null) {
+                initiator.stop(true);
+            }
+            assertTrue(onConnectExceptionWasCalled.get());
+        }
+    }
+
+
     private interface LogSessionStateListener extends Log, SessionStateListener {}
 
     // QFJ-907