Clean rewrite

SallyConnect/DotNetSallyClient.cs

@@ -15,42 +15,86 @@ namespace ConnectToSally
     /// </summary>
     class DotNetSallyClient
     {
-        protected static TimeSpan receiveTimeout = TimeSpan.FromSeconds(10);
+
+        #region Class Variables
+        /*
+        * Connection Properties
+        */
 
         /// <summary>
-        /// A logger so that we can write things to the console. 
+        /// Address this DotNetSallyClient connects to. 
         /// </summary>
-        private static readonly ILog logger = LogManager.GetLogger(typeof(DotNetSallyClient));
+        public string address { get; private set; }
 
         /// <summary>
-        /// Username for the connection. 
+        /// Username used to connect to Sally.  
         /// </summary>
         public string user { get; private set; }
 
         /// <summary>
-        /// Password for the connection. 
+        /// Password used to connect to Sally. 
         /// </summary>
         public string password { get; private set; }
 
-        /// <summary>
-        /// Address for the connection. 
-        /// </summary>
-        public string address { get; private set; }
+        /*
+        * Connection State
+        */
 
         /// <summary>
         /// Connection session variable
         /// </summary>
-        public ISession session { get; private set; }
+        private ISession session { get; set; }
 
         /// <summary>
         /// Connection variable
         /// </summary>
-        public IConnection connection { get; private set; }
+        private IConnection connection { get; set; }
+
+        /*
+        * Logger
+        */
+
+        /// <summary>
+        /// A logger so that we can write things to the console. 
+        /// </summary>
+        private static readonly ILog logger = LogManager.GetLogger(typeof(DotNetSallyClient));
+
+
+
+        #endregion
+
+        #region Connection Start
+        /// <summary>
+        /// Constructs a new DotNetSallyClient and establishes a connection. 
+        /// </summary>
+        /// <param name="address">Adress to connect to. </param>
+        /// <param name="user">Username to connect with. </param>
+        /// <param name="password">Password to connect with. </param>
+        public DotNetSallyClient(string address= "activemq:tcp://localhost:61616", string user="karaf", string password="karaf")
+        {
+
+            // store connection params
+            this.address = address;
+            this.user = user;
+            this.password = password;
+
+            BasicConfigurator.Configure(); // ???
+
+            // try to connect
+            if (!connect())
+            {
+                logFatal("Could not start connection");
+                return; 
+            }
+
+            logInfo("Started connection");
+        }
 
         /// <summary>
         /// Starts the connection to Sally. 
         /// </summary>
-        protected bool startConnection()
+        /// <returns>If the connection was a success</returns>
+        protected bool connect()
         {
             // set up a URI and get ready for connecting
             Uri connecturi = new Uri(this.address);
@@ -84,60 +128,64 @@ namespace ConnectToSally
             //nope something went wrong. 
             return false;
         }
+        #endregion
 
+        #region Connection Getters
         /// <summary>
-        /// Starts a DotNetSallyClient object with a session and connection with Sally.
+        /// returns the session of this SallyClient. 
         /// </summary>
-        /// <param name="address">Adress to connect to. </param>
-        /// <param name="user">Username to connect with. </param>
-        /// <param name="password">Password to connect with. </param>
-        public DotNetSallyClient(string address= "activemq:tcp://localhost:61616", string user="karaf", string password="karaf")
-        {
-
-            // store connection params
-            this.address = address;
-            this.user = user;
-            this.password = password;
+        /// <returns></returns>
+        public ISession getSallySession(){
 
-            //set up the logger. 
-            BasicConfigurator.Configure();
-            if (!startConnection())
-            {
-                // if we could not start the connection, we should complain. 
-                Console.WriteLine("DotNetSallyClient <" + address + ">: Could not start connection");
-                logger.Fatal("DotNetSallyClient <" + address + ">: Could not start connection");
-                return; 
+            // if there is no connection, we can not return a session 
+            if (this.connection == null || !this.connection.IsStarted) {
+                throw new Exception(logFatal("No connection started yet. Start a connection and try again."));
             }
 
-            // we're done for now. 
-            Console.WriteLine("DotNetSallyClient <"+ address + ">: Started connection");
+            // we can now return it. 
+            return this.session;
         }
+        #endregion
 
-
+        #region Logging
         /// <summary>
-        /// returns the session of this SallyClient. 
+        /// Generates a log message
         /// </summary>
+        /// <param name="message">Message content</param>
         /// <returns></returns>
-        public ISession getSallySession(){
-
-            // if there is no connection, we can not return it. 
-            if (!this.connection.IsStarted) {
-                throw new Exception("DotNetSallyClient <" + address + ">: No connection started yet. Start a connection and try again.");
+        private string logMessage(string message)
+        {
+            return "DotNetSallyClient <" + address + ">: " + message;
         }
 
-            //and return it. 
-            return this.session;
+        /// <summary>
+        /// Logs an info message to console and to the log. 
+        /// </summary>
+        /// <param name="message"></param>
+        private string logInfo(string message)
+        {
+            string msg = logMessage(message);
+
+            logger.Info(msg);
+
+            return msg; 
         }
 
         /// <summary>
-        /// Registers a document with this Sally Client. 
+        /// Logs a fatal message to console and to the log. 
         /// </summary>
-        /// <param name="doc"></param>
-        public void registerDocument(SallyDocument doc)
+        /// <param name="message"></param>
+        private string logFatal(string message)
         {
-            //just call the document method to do this. 
-            doc.registerWith(this);
+            string msg = logMessage(message);
+
+            logger.Fatal(msg);
+
+            return msg;
         }
 
+        #endregion
+
+
     }
 }

SallyConnect/TestUnit.cs

@@ -16,20 +16,10 @@ namespace SallyConnect
 
             // we first create the sally client. 
             DotNetSallyClient dns = new DotNetSallyClient("activemq:tcp://localhost:61616");//neptune.eecs.jacobs-university.de:61616
+            SallyDocument doc = new SallyDocument(dns, docName, interfaces);
 
-            //and then register a document to it. 
-            SallyDocument sD = new SallyDocument(docName, interfaces);
-            dns.registerDocument(sD); // register the document. 
-
-            //now just wait
-            Console.Read();
-            /*
-            System.Threading.Thread.Sleep(1000);
-            if (sD.isRegistered()){
-                sD.sendToSally("some message");
-            }
+            doc.register();
             Console.Read();
-             */
         }
     }
 }