3 * A NodeMessageRequestNodeListAnswer 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 NodeMessageRequestNodeListAnswerHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setHandlerName('message_request_node_list_answer');
37 // Init message data array
38 $this->messageDataElements = array(
39 XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID,
40 XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_NODE_LIST,
41 BaseXmlAnswerTemplateEngine::ANSWER_STATUS,
44 // Init message-data->configuration translation array
45 $this->messageToConfig = array(
47 XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID => 'your_session_id'
51 // Init search data array
52 $this->searchData = array(
53 XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID,
58 * Creates an instance of this class
60 * @return $handlerInstance An instance of a HandleableMessage class
62 public final static function createNodeMessageRequestNodeListAnswerHandler () {
64 $handlerInstance = new NodeMessageRequestNodeListAnswerHandler();
66 // Return the prepared instance
67 return $handlerInstance;
71 * Handles data array of the message
73 * @param $messageData An array with message data to handle
74 * @param $packageInstance An instance of a Receivable class
76 * @throws NoRequestNodeListAttemptedException If this node has not attempted to announce itself
78 public function handleMessageData (array $messageData, Receivable $packageInstance) {
80 $nodeInstance = Registry::getRegistry()->getInstance('node');
82 // Has this node attempted to announce itself?
83 if (!$nodeInstance->ifNodeHasAnnouncementCompleted()) {
85 * This node has never announced itself, so it doesn't expect
86 * request-node-list answer messages.
88 throw new NoRequestNodeListAttemptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED);
91 // Register the announcing node with this node
92 $this->registerNodeByMessageData($messageData);
94 // Handle the answer status element
95 $nodeInstance->handleAnswerStatusByMessageData($messageData, $packageInstance);
99 * Adds all required elements from given array into data set instance
101 * @param $dataSetInstance An instance of a StoreableCriteria class
102 * @param $messageData An array with all message data
105 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
107 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANSWER-HANDLER: messageData=' . print_r($messageData, true));
110 foreach ($this->messageDataElements as $key) {
112 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANSWER-HANDLER: messageData[' . $key . ']=' . $messageData[$key]);
115 assert(isset($messageData[$key]));
118 * Add it, but remove any 'my-' prefixes as they are not used in
121 $dataSetInstance->addCriteria('node_' . str_replace('my-', '', $key), $messageData[$key]);
126 * Initializes configuration data from given message data array
128 * @param $messageData An array with all message data
130 * @throws UnsupportedOperationException If this method is called
132 protected function initMessageConfigurationData (array $messageData) {
133 // Please don't call this method
134 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
138 * Removes configuration data with given message data array from global
141 * @param $messageData An array with all message data
143 * @throws UnsupportedOperationException If this method is called
145 protected function removeMessageConfigurationData (array $messageData) {
146 // Please don't call this method
147 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);