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

   1 <?php
   2 /**
   3  * A NodeMessageRequestNodeListAnswer handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 NodeMessageRequestNodeListAnswerHandler 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_request_node_list_answer');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID,
  40                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_NODE_LIST,
  41                 );
  42
  43                 // Init message-data->configuration translation array
  44                 $this->messageToConfig = array(
  45                 /*
  46                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID  => 'your_session_id'
  47                 */
  48                 );
  49
  50                 // Init config-copy array
  51                 $this->configCopy = array(
  52                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID  => 'session_id',
  53                 );
  54
  55                 // Init array
  56                 $this->searchData = array(
  57                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID,
  58                 );
  59         }
  60
  61         /**
  62          * Creates an instance of this class
  63          *
  64          * @return      $handlerInstance        An instance of a HandleableMessage class
  65          */
  66         public final static function createNodeMessageRequestNodeListAnswerHandler () {
  67                 // Get new instance
  68                 $handlerInstance = new NodeMessageRequestNodeListAnswerHandler();
  69
  70                 // Return the prepared instance
  71                 return $handlerInstance;
  72         }
  73
  74         /**
  75          * Handles data array of the message
  76          *
  77          * @param       $messageData            An array with message data to handle
  78          * @param       $packageInstance        An instance of a Receivable class
  79          * @return      void
  80          * @throws      NoRequestNodeListAttemptedException     If this node has not attempted to announce itself
  81          */
  82         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  83                 // Get node instance
  84                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  85
  86                 // Has this node attempted to announce itself?
  87                 if (!$nodeInstance->ifNodeHasAnnouncementCompleted()) {
  88                         /*
  89                          * This node has never announced itself, so it doesn't expect
  90                          * request-node-list answer messages.
  91                          */
  92                         throw new NoRequestNodeListAttemptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED);
  93                 } // END - if
  94
  95                 // Register the announcing node with this node
  96                 $this->registerNodeByMessageData($messageData);
  97
  98                 // Handle the answer status element
  99                 $nodeInstance->handleAnswerStatusByMessageData($messageData, $packageInstance);
 100         }
 101
 102         /**
 103          * Adds all required elements from given array into data set instance
 104          *
 105          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 106          * @param       $messageData            An array with all message data
 107          * @return      void
 108          */
 109         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 110                 // Debug message
 111                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANSWER-HANDLER: messageData=' . print_r($messageData, true));
 112
 113                 // Add all ements
 114                 foreach ($this->messageDataElements as $key) {
 115                         // Debug message
 116                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANSWER-HANDLER: messageData[' . $key . ']=' . $messageData[$key]);
 117
 118                         // Is it there?
 119                         assert(isset($messageData[$key]));
 120
 121                         /*
 122                          * Add it, but remove any 'my-' prefixes as they are not used in
 123                          * database layer.
 124                          */
 125                         $dataSetInstance->addCriteria('node_' . str_replace('my-', '', $key), $messageData[$key]);
 126                 } // END - foreach
 127         }
 128
 129         /**
 130          * Initializes configuration data from given message data array
 131          *
 132          * @param       $messageData    An array with all message data
 133          * @return      void
 134          * @throws      UnsupportedOperationException   If this method is called
 135          */
 136         protected function initMessageConfigurationData (array $messageData) {
 137                 // Please don't call this method
 138                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 139         }
 140
 141         /**
 142          * Removes configuration data with given message data array from global
 143          * configuration
 144          *
 145          * @param       $messageData    An array with all message data
 146          * @return      void
 147          * @throws      UnsupportedOperationException   If this method is called
 148          */
 149         protected function removeMessageConfigurationData (array $messageData) {
 150                 // Please don't call this method
 151                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 152         }
 153 }
 154
 155 // [EOF]
 156 ?>