application/hub/main/handler/message-types/self-connect/class_NodeMessageSelfConnectHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageSelfConnect handler
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 NodeMessageSelfConnectHandler 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_self_connect');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @return      $handlerInstance        An instance of a HandleableMessage class
  42          */
  43         public final static function createNodeMessageSelfConnectHandler () {
  44                 // Get new instance
  45                 $handlerInstance = new NodeMessageSelfConnectHandler();
  46
  47                 // Return the prepared instance
  48                 return $handlerInstance;
  49         }
  50
  51         /**
  52          * Handles data array of the message
  53          *
  54          * @param       $messageData            An array with message data to handle
  55          * @param       $packageInstance        An instance of a Receivable class
  56          * @return      void
  57          */
  58         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  59                 // Get node instance
  60                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  61
  62                 // Are node id and session id the same?
  63                 if (($messageData[XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_NODE_ID] == $nodeInstance->getNodeId()) && ($messageData[XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_SESSION_ID] == $nodeInstance->getSessionId())) {
  64                         // Both are equal
  65                         self::createDebugInstance(__CLASS__)->debugOutput('SELF-CONNECT[' . __METHOD__ . ':' . __LINE__ . ']: Have connected to myself, both node and session id are equal!');
  66
  67                         // ... and change state
  68                         $nodeInstance->getStateInstance()->nodeHasSelfConnected();
  69                 } else {
  70                         // Something really horrible happened
  71                         // @TODO Throw an exception here instead of dying
  72                         $this->debugInstance(__METHOD__ . ': ids mismatching! messageData=' . print_r($messageData, TRUE));
  73                 }
  74         }
  75
  76         /**
  77          * Adds all required elements from given array into data set instance
  78          *
  79          * @param       $dataSetInstance        An instance of a StoreableCriteria class
  80          * @param       $messageData            An array with all message data
  81          * @return      void
  82          * @throws      UnsupportedOperationException   If this method is called
  83          */
  84         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
  85                 // Add generic first
  86                 parent::addArrayToDataSet($dataSetInstance, $messageData);
  87
  88                 // Please don't call this method!
  89                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  90         }
  91
  92         /**
  93          * Initializes configuration data from given message data array
  94          *
  95          * @param       $messageData    An array with all message data
  96          * @return      void
  97          * @throws      UnsupportedOperationException   If this method is called
  98          */
  99         protected function initMessageConfigurationData (array $messageData) {
 100                 // Please don't call this method!
 101                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 102         }
 103
 104         /**
 105          * Removes configuration data with given message data array from global configuration
 106          *
 107          * @param       $messageData    An array with all message data
 108          * @return      void
 109          * @throws      UnsupportedOperationException   If this method is called
 110          */
 111         protected function removeMessageConfigurationData (array $messageData) {
 112                 // Please don't call this method!
 113                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 114         }
 115 }
 116
 117 // [EOF]
 118 ?>