############################################################# # Copyright (C) 2005-2008 VeriSign, Inc. # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # # This library is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.? See the GNU # Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA? 02111-1307? USA ############################################################# Tool Description: ----------------- There are two large panes in the GUI. The top one shows the client side of the conversation (you), the bottom shows the server side. The bottom pane is also used to display application error messages when a command fails. You can populate desired commands in the top pane by selecting them in the top menubar. These commands have default command templates, located in templates directories under the config directory, which can be customized . You need to specify an IP (or hostname) and port and click the "Connect" button to establish a connection. If you connect successfully, you should receive a server greeting. The next expected command is a "login" command. You should click the "Session->Login" command from the menu bar. Then click the "Send" button to send this command to the server. You should receive an affirmative response from the server. To send other commands, select them from the menubar and click "Send". If you click the "Disconnect" button in mid-session, the application will send a "Logout" command to the server before disconnecting. Tool Properties Files: ---------------------- These properties files specify the server addresses and ports to connect to, as well as the dynamic menu bar configuration file and the command templates directory. Ant tokenized files are included that have a .token extension, where the Ant properties defined in the referenced -filter.properties is applied to the tokenized files to produce the untokenized files. In the config directory: core.properties.token - Tokenized properties file for COM NET Registry namestore.properties.token - Tokenized properties file for Name Store dotname.properties.token - Tokenized properties file for NAME Registry SSL Certificates: ---------------------- See the certs/README.txt file for information on configuring the SSL certificates. Menu Bar Config Files: ---------------------- These config files specify the dynamic menu bar. config\Core\config.xml config\NameStore\config.xml config\dotName\config.xml See also: config\config.xsd Command Templates: ------------------ These files contain the EPP (*.xml) commands. config\Core\templates\* config\NameStore\templates\* config\dotName\templates\* How to change/create a "config.xml" to create new options in the tool: ---------------------------------------------------------------------- * The tag specifies a menu to be displayed in the menubar. * has attribute "name" which defines the menu label. * The tag specifies a subMenu to be displayed in the menu. * has attribute "name" which defines the subMenu label. * The tag specifies a command to be displayed in the menu/subMenu. * has attributes: "name" which defines the menuItem label, * and "file" which defines the command template file to be used for input. * All the input command template files (*.xml=EPP) should be * made available in the directory. Running the Tool: ----------------------------------------- The Protocol Tool is run via Apache Ant (http://ant.apache.org/) which is included in the distribution with a script for Unix (build.sh) and for Windows (build.bat). The file build.xml defines the supported set of targets that can be invoked via Ant, which can be displayed by invoking Ant with the '-p' option. For example: Unix: build.sh -p Windows: build.bat -p The targets listed include: all runs all tools run-core Run the Core Protocol Tool run-dotname Run the DotName Protocol Tool run-namestore Run the Name Store Protocol Tool One or more targets can be used at once, so with one command multiple versions of the tool can be launched at once. For example, to run the Core and NameStore versions of the tool, the following command can be used: build.[bat|sh] run-core run-namestore The Protocol Tool can connect to multiple environments as defined by the "system" property value. The "system" property defines what the target system is. The "system" property default value is defined in build.properties and it can be overridden on the command line. The following command line wil run each of the Protocol Tool versions against Production (prod): build.[bat|sh] -Dsystem=prod run-core run-namestore run-dotname The "system" property defines which properties file will be loaded when running the tool. The properties files have the naming convention "system"-filter.properties. The Protocol Tool is configured by setting the properties in "system"-filter.properties which will be applied to the .token files under the config directory.