Updated 'core' + renamed 'main' -> 'classes'.

[hub.git] / application / hub / main / handler / answer-status / announcement / class_AnnouncementAnswerOkayHandler.php

diff --git a/application/hub/main/handler/answer-status/announcement/class_AnnouncementAnswerOkayHandler.php b/application/hub/main/handler/answer-status/announcement/class_AnnouncementAnswerOkayHandler.php
deleted file mode 100644 (file)
index 64425d5..0000000
--- a/application/hub/main/handler/answer-status/announcement/class_AnnouncementAnswerOkayHandler.php
+++ /dev/null
@@ -1,134 +0,0 @@
-<?php
-/**
- * A AnnouncementAnswerOkay handler
- *
- * @author             Roland Haeder <webmaster@shipsimu.org>
- * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
- * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.shipsimu.org
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-class AnnouncementAnswerOkayHandler extends BaseAnserStatusHandler implements HandleableAnswerStatus, Registerable {
-       /**
-        * Protected constructor
-        *
-        * @return      void
-        */
-       protected function __construct () {
-               // Call parent constructor
-               parent::__construct(__CLASS__);
-
-               // Init array
-               $this->searchData = array(
-                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
-                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
-               );
-
-               // Set handler name
-               $this->setHandlerName('announcement_answer_okay');
-       }
-
-       /**
-        * Creates an instance of this class
-        *
-        * @return      $handlerInstance        An instance of a HandleableMessage class
-        */
-       public final static function createAnnouncementAnswerOkayHandler () {
-               // Get new instance
-               $handlerInstance = new AnnouncementAnswerOkayHandler();
-
-               // Return the prepared instance
-               return $handlerInstance;
-       }
-
-       /**
-        * Handles given message data array
-        *
-        * @param       $messageData            An array of message data
-        * @param       $packageInstance        An instance of a Receivable class
-        * @return      void
-        * @todo        Do some more here: Handle karma, et cetera?
-        */
-       public function handleAnswerMessageData (array $messageData, Receivable $packageInstance) {
-               /*
-                * Query DHT and force update (which will throw an exception if the
-                * node is not found).
-                */
-               $this->getDhtInstance()->registerNodeByMessageData($messageData, $this, TRUE);
-
-               // Get handler instance
-               $handlerInstance = Registry::getRegistry()->getInstance('task_handler');
-
-               // Generate DHT bootstrap task
-               $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_late_bootstrap_task_class');
-
-               // Register it as well
-               $handlerInstance->registerTask('dht_late_bootstrap', $taskInstance);
-
-               // Get the node instance
-               $nodeInstance = NodeObjectFactory::createNodeInstance();
-
-               // Change state
-               $nodeInstance->getStateInstance()->nodeAnnouncementSuccessful();
-
-               // Prepare next message
-               $this->prepareNextMessage($messageData, $packageInstance);
-       }
-
-       /**
-        * Initializes configuration data from given message data array
-        *
-        * The following array is being handled over:
-        *
-        *   my-external-address => 1.2.3.4
-        *   my-internal-address => 5.6.7.8
-        *   my-status           => reachable
-        *   my-node-id          => aaabbbcccdddeeefff123456789
-        *   my-session-id       => aaabbbcccdddeeefff123456789
-        *   my-tcp-port         => 9060
-        *   my-udp-port         => 9060
-        *   answer-status       => OKAY
-        *   message_type        => announcement_answer
-        *
-        * @param       $messageData    An array with all message data
-        * @return      void
-        */
-       protected function initMessageConfigurationData (array $messageData) {
-               // Get node instance
-               $nodeInstance = NodeObjectFactory::createNodeInstance();
-
-               // Get an array of all accepted object types
-               $objectList = $nodeInstance->getListFromAcceptedObjectTypes();
-
-               // Add missing (temporary) configuration 'accepted_object_types'
-               $this->getConfigInstance()->setConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ACCEPTED_OBJECTS, implode(BaseHubNode::OBJECT_LIST_SEPARATOR, $objectList));
-       }
-
-       /**
-        * Removes configuration data with given message data array from global
-        * configuration. For content of $messageData see method comment above.
-        *
-        * @param       $messageData    An array with all message data
-        * @return      void
-        */
-       protected function removeMessageConfigurationData (array $messageData) {
-               // Remove temporay configuration
-               $this->getConfigInstance()->unsetConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ACCEPTED_OBJECTS);
-       }
-}
-
-// [EOF]
-?>