application/hub/main/handler/message-types/requests/class_NodeMessageRequestNodeListHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageRequestNodeList 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 NodeMessageRequestNodeListHandler 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');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                 );
  40         }
  41
  42         /**
  43          * Creates an instance of this class
  44          *
  45          * @return      $handlerInstance        An instance of a HandleableMessage class
  46          */
  47         public final static function createNodeMessageRequestNodeListHandler () {
  48                 // Get new instance
  49                 $handlerInstance = new NodeMessageRequestNodeListHandler();
  50
  51                 // Return the prepared instance
  52                 return $handlerInstance;
  53         }
  54
  55         /**
  56          * Handles data array of the message
  57          *
  58          * @param       $messageData            An array with message data to handle
  59          * @param       $packageInstance        An instance of a Receivable class
  60          * @return      void
  61          * @throws      RequestNotAcceptedException             If this node does not accept this request
  62          */
  63         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  64                 // Get node instance
  65                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  66
  67                 // Is this node accepting announcements?
  68                 if (!$nodeInstance->isAcceptingNodeListRequests()) {
  69                         /*
  70                          * This node is not accepting node list requests. Throw an
  71                          * exception to abort any further processing.
  72                          */
  73                         throw new RequestNotAcceptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_REQUEST_NOT_ACCEPTED);
  74                 } // END - if
  75
  76                 // Register the announcing node with this node
  77                 $this->registerNodeByMessageData($messageData);
  78
  79                 // Prepare answer message to be delivered back to the other node
  80                 $this->prepareAnswerMessage($messageData, $packageInstance);
  81         }
  82
  83         /**
  84          * Adds all required elements from given array into data set instance
  85          *
  86          * @param       $dataSetInstance        An instance of a StoreableCriteria class
  87          * @param       $messageData            An array with all message data
  88          * @return      void
  89          */
  90         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
  91                 // Add all ements
  92                 foreach ($this->messageDataElements as $key) {
  93                         // Is it there?
  94                         assert(isset($messageData[$key]));
  95
  96                         // Add it
  97                         $dataSetInstance->addCriteria('node_' . $key, $messageData[$key]);
  98                 } // END - foreach
  99         }
 100
 101         /**
 102          * Initializes configuration data from given message data array
 103          *
 104          * @param       $messageData    An array with all message data
 105          * @return      void
 106          */
 107         protected function initMessageConfigurationData (array $messageData) {
 108                 $this->partialStub('Please implement this method.');
 109         }
 110
 111         /**
 112          * Removes configuration data with given message data array from global
 113          * configuration
 114          *
 115          * @param       $messageData    An array with all message data
 116          * @return      void
 117          */
 118         protected function removeMessageConfigurationData (array $messageData) {
 119                 $this->partialStub('Please implement this method.');
 120         }
 121 }
 122
 123 // [EOF]
 124 ?>