3 * A NodeMessageAnnouncementAnswer handler
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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 NodeMessageAnnouncementAnswerHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setHandlerName('message_announcement_answer');
37 // Init message data array
38 $this->messageDataElements = array(
39 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
40 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS,
41 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS,
42 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_ID,
43 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
44 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH,
45 BaseXmlAnswerTemplateEngine::ANSWER_STATUS,
48 // Init message-data->configuration translation array
49 $this->messageToConfig = array(
51 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => 'your_external_address',
52 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => 'your_internal_address',
53 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID => 'your_session_id'
54 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH => 'your_private_key_hash'
58 // Init config-copy array
59 $this->configCopy = array(
60 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => 'external_address',
61 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => 'internal_address',
62 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS => 'node_status',
63 XmlAnnouncementAnswerTemplateEngine::OAANNOUNCEMENT_DATA_SESSION_ID => 'session_id',
64 XmlAnnouncementAnswerTemplateEngine::OAANNOUNCEMENT_DATA_PRIVATE_KEY_HASH => 'private_key_hash',
68 $this->searchData = array(
69 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
70 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
75 * Creates an instance of this class
77 * @return $handlerInstance An instance of a HandleableMessage class
79 public final static function createNodeMessageAnnouncementAnswerHandler () {
81 $handlerInstance = new NodeMessageAnnouncementAnswerHandler();
83 // Return the prepared instance
84 return $handlerInstance;
88 * Handles data array of the message
90 * @param $messageData An array with message data to handle
91 * @param $packageInstance An instance of a Receivable class
93 * @throws NoAnnouncementAttemptedException If this node has not attempted to announce itself
95 public function handleMessageData (array $messageData, Receivable $packageInstance) {
97 $nodeInstance = NodeObjectFactory::createNodeInstance();
99 // Has this node attempted to announce itself?
100 if (!$nodeInstance->ifNodeIsAnnouncing()) {
102 * This node has never announced itself, so it doesn't expect
103 * announcement answer messages.
105 throw new NoAnnouncementAttemptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED);
108 // Register the announcing node with this node
109 $this->registerNodeByMessageData($messageData);
111 // Handle the answer status element
112 $nodeInstance->handleAnswerStatusByMessageData($messageData, $packageInstance);
116 * Adds all required elements from given array into data set instance
118 * @param $dataSetInstance An instance of a StoreableCriteria class
119 * @param $messageData An array with all message data
122 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
124 parent::addArrayToDataSet($dataSetInstance, $messageData);
127 foreach ($this->messageDataElements as $key) {
129 assert(isset($messageData[$key]));
132 * Add it, but remove any 'my-' prefixes as they are not used in
135 $dataSetInstance->addCriteria(str_replace('my-', '', $key), $messageData[$key]);
140 * Initializes configuration data from given message data array
142 * @param $messageData An array with all message data
144 * @throws UnsupportedOperationException If this method is called
146 protected function initMessageConfigurationData (array $messageData) {
147 // Please don't call this method
148 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
152 * Removes configuration data with given message data array from global
155 * @param $messageData An array with all message data
157 * @throws UnsupportedOperationException If this method is called
159 protected function removeMessageConfigurationData (array $messageData) {
160 // Please don't call this method
161 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);