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