3 * A NodeMessageDhtBootstrapAnswer handler
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 NodeMessageDhtBootstrapAnswerHandler 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 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_ADDRESS,
40 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_ADDRESS,
41 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_STATUS,
42 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID,
43 BaseXmlAnswerTemplateEngine::ANSWER_STATUS,
46 // Init message-data->configuration translation array
47 $this->messageToConfig = array(
49 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_ADDRESS => 'your_external_address',
50 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_ADDRESS => 'your_internal_address',
51 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID => 'your_session_id'
55 // Init config-copy array
56 $this->configCopy = array(
57 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_ADDRESS => 'external_address',
58 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_ADDRESS => 'internal_address',
59 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_STATUS => 'node_status',
60 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID => 'session_id',
64 $this->searchData = array(
65 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID,
66 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_ADDRESS,
71 * Creates an instance of this class
73 * @return $handlerInstance An instance of a HandleableMessage class
75 public final static function createNodeMessageDhtBootstrapAnswerHandler () {
77 $handlerInstance = new NodeMessageDhtBootstrapAnswerHandler();
79 // Return the prepared instance
80 return $handlerInstance;
84 * Handles data array of the message
86 * @param $messageData An array with message data to handle
87 * @param $packageInstance An instance of a Receivable class
89 * @throws NoDhtBootstrapAttemptedException If this DHT has not attempted to bootstrap
92 public function handleMessageData (array $messageData, Receivable $packageInstance) {
94 $dhtInstance = DhtObjectFactory::createDhtInstance('node');
96 // Has this DHT attempted to bootstrap?
97 if (!$dhtInstance->ifDhtIsBooting()) {
99 * This DHT has never bootstrapped, so it doesn't expect
100 * announcement answer messages.
102 throw new NoDhtBootstrapAttemptedException(array($this, $dhtInstance, $messageData), self::EXCEPTION_DHT_BOOTSTRAP_NOT_ATTEMPTED);
106 $this->partialStub('UNHANDLED: messageData=' . print_r($messageData, TRUE));
110 * Adds all required elements from given array into data set instance
112 * @param $dataSetInstance An instance of a StoreableCriteria class
113 * @param $messageData An array with all message data
116 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
118 parent::addArrayToDataSet($dataSetInstance, $messageData);
121 foreach ($this->messageDataElements as $key) {
123 assert(isset($messageData[$key]));
126 * Add it, but remove any 'my-' prefixes as they are not used in
129 $dataSetInstance->addCriteria(str_replace('my-', '', $key), $messageData[$key]);
134 * Initializes configuration data from given message data array
136 * @param $messageData An array with all message data
138 * @throws UnsupportedOperationException If this method is called
140 protected function initMessageConfigurationData (array $messageData) {
141 // Please don't call this method
142 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
146 * Removes configuration data with given message data array from global
149 * @param $messageData An array with all message data
151 * @throws UnsupportedOperationException If this method is called
153 protected function removeMessageConfigurationData (array $messageData) {
154 // Please don't call this method
155 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);