3 * An interface for ProtocolResolvers
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 interface ProtocolResolver extends FrameworkInterface {
26 * Returns an instance of a LocateableNode class for a given NodeHelper
27 * instance or null if it was not found.
29 * @param $nodeInstance An instance of a NodeHelper class
30 * @return $unlInstance An instance of a LocateableNode class
32 function resolveUniversalNodeLocatorFromNodeHelper (NodeHelper $nodeInstance);
35 * Returns the UNL as string from given configuration key.
37 * @param $configKey Configuration key for UNL address (valid: internal,external)
38 * @return $unl Universal node locator
40 function resolveUniversalNodeLocatorFromConfigKey ($configKey);