3 * A NodeMessageSelfConnect handler
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class NodeMessageSelfConnectHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setHandlerName('message_self_connect');
39 * Creates an instance of this class
41 * @return $handlerInstance An instance of a HandleableMessage class
43 public final static function createNodeMessageSelfConnectHandler () {
45 $handlerInstance = new NodeMessageSelfConnectHandler();
47 // Return the prepared instance
48 return $handlerInstance;
52 * Handles data array of the message
54 * @param $messageData An array with message data to handle
55 * @param $packageInstance An instance of a Receivable class
58 public function handleMessageData (array $messageData, Receivable $packageInstance) {
59 // Are node id and session id the same?
60 if (($messageData[XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_NODE_ID] == $this->getNodeId()) && ($messageData[XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_SESSION_ID] == $this->getSessionId())) {
62 self::createDebugInstance(__CLASS__)->debugOutput('SELF-CONNECT: Have connected to myself, both node and session id are equal!');
64 // Get node instance ...
65 $nodeInstance = Registry::getRegistry()->getInstance('node');
67 // ... and change state
68 $nodeInstance->getStateInstance()->nodeHasSelfConnected();
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));
77 * Adds all required elements from given array into data set instance
79 * @param $dataSetInstance An instance of a StoreableCriteria class
80 * @param $messageData An array with all message data
82 * @throws UnsupportedOperationException If this method is called
84 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
85 // Please don't call this method!
86 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
90 * Initializes configuration data from given message data array
92 * @param $messageData An array with all message data
94 * @throws UnsupportedOperationException If this method is called
96 protected function initMessageConfigurationData (array $messageData) {
97 // Please don't call this method!
98 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
102 * Removes configuration data with given message data array from global configuration
104 * @param $messageData An array with all message data
106 * @throws UnsupportedOperationException If this method is called
108 protected function removeMessageConfigurationData (array $messageData) {
109 // Please don't call this method!
110 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);