application/hub/main/handler/message-types/answer/class_NodeMessageAnnouncementAnswerHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageAnnouncementAnswer handler
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class NodeMessageAnnouncementAnswerHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set handler name
  35                 $this->setHandlerName('message_announcement_answer');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
  40                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS,
  41                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS,
  42                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
  43                         BaseXmlAnswerTemplateEngine::ANSWER_STATUS,
  44                 );
  45
  46                 // Init message-data->configuration translation array
  47                 $this->messageToConfig = array(
  48                 /*
  49                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => 'your_external_address',
  50                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => 'your_internal_address',
  51                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID       => 'your_session_id'
  52                 */
  53                 );
  54
  55                 // Init config-copy array
  56                 $this->configCopy = array(
  57                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => 'external_address',
  58                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => 'internal_address',
  59                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS      => 'node_status',
  60                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID       => 'session_id',
  61                 );
  62
  63                 // Init array
  64                 $this->searchData = array(
  65                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
  66                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
  67                 );
  68         }
  69
  70         /**
  71          * Creates an instance of this class
  72          *
  73          * @return      $handlerInstance        An instance of a HandleableMessage class
  74          */
  75         public final static function createNodeMessageAnnouncementAnswerHandler () {
  76                 // Get new instance
  77                 $handlerInstance = new NodeMessageAnnouncementAnswerHandler();
  78
  79                 // Return the prepared instance
  80                 return $handlerInstance;
  81         }
  82
  83         /**
  84          * Handles data array of the message
  85          *
  86          * @param       $messageData            An array with message data to handle
  87          * @param       $packageInstance        An instance of a Receivable class
  88          * @return      void
  89          * @throws      NoAnnouncementAttemptedException        If this node has not attempted to announce itself
  90          */
  91         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  92                 // Get node instance
  93                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  94
  95                 // Has this node attempted to announce itself?
  96                 if (!$nodeInstance->ifNodeIsAnnouncing()) {
  97                         /*
  98                          * This node has never announced itself, so it doesn't expect
  99                          * announcement answer messages.
 100                          */
 101                         throw new NoAnnouncementAttemptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED);
 102                 } // END - if
 103
 104                 // Register the announcing node with this node
 105                 $this->registerNodeByMessageData($messageData);
 106
 107                 // Handle the answer status element
 108                 $nodeInstance->handleAnswerStatusByMessageData($messageData, $packageInstance);
 109         }
 110
 111         /**
 112          * Adds all required elements from given array into data set instance
 113          *
 114          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 115          * @param       $messageData            An array with all message data
 116          * @return      void
 117          */
 118         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 119                 // Add generic first
 120                 parent::addArrayToDataSet($dataSetInstance, $messageData);
 121
 122                 // Add all ements
 123                 foreach ($this->messageDataElements as $key) {
 124                         // Is it there?
 125                         assert(isset($messageData[$key]));
 126
 127                         /*
 128                          * Add it, but remove any 'my-' prefixes as they are not used in
 129                          * database layer.
 130                          */
 131                         $dataSetInstance->addCriteria(str_replace('my-', '', $key), $messageData[$key]);
 132                 } // END - foreach
 133         }
 134
 135         /**
 136          * Initializes configuration data from given message data array
 137          *
 138          * @param       $messageData    An array with all message data
 139          * @return      void
 140          * @throws      UnsupportedOperationException   If this method is called
 141          */
 142         protected function initMessageConfigurationData (array $messageData) {
 143                 // Please don't call this method
 144                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 145         }
 146
 147         /**
 148          * Removes configuration data with given message data array from global
 149          * configuration
 150          *
 151          * @param       $messageData    An array with all message data
 152          * @return      void
 153          * @throws      UnsupportedOperationException   If this method is called
 154          */
 155         protected function removeMessageConfigurationData (array $messageData) {
 156                 // Please don't call this method
 157                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 158         }
 159 }
 160
 161 // [EOF]
 162 ?>