############################################################# # Copyright (C) 2005 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 are default command "templates"- they may be edited to suit your test criteria. 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 "Quit" (logout) command to the server before disconnecting. Alternately, you can select Session->Logout to disconnect. 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. The Protocol Tool includes a default set of untokenized files with settings for OT&E. 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 core.properties - Untokenized properties file for COM NET Registry namestore.properties - Untokenized properties file for Name Store dotname.properties - Untokenized 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) and the RRP (*.txt) 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, *.txt=RRP) should be * made available in the directory. Running the Tool: ----------------------------------------- There are two methods of running the Protocol Tool: 1. Ant run-[core|dotname|namestore] targets from top-level directory. Ant 1.6.0 is included in the distribution along with Ant launch scripts for Unix (build.sh) and Windows (build.bat). The "system" property defines what the target system is. The "system" property default value is in build.properties and it can be overridden on the command line. The following command line will run each to the Protocol Tool configurations against Production. build.[bat|sh] -Dsystem=prod run-core run-namestore run-dotname The properties in -filter.properties can be modified for each system which will be applied to the .token files under the config directory tree. For example, the tokenized Core properties file core.properties.token has the properties applied to create core.properties. 2. Run scripts under the bin directory can be used to launch each Protocol Tool configuratioin using the untokenized config files. By default, the config files are setup for the OT&E environment, so without modification, the run scripts will include the names and ports of the OT&E servers. The properties files under config can be manually changed before running the Protocol Tool. The following scripts are provided: core.[bat|sh] - Run the COM NET Registry Protocol Tool configuration namestore.[bat|sh] - Run the Name Store Protocol Tool configuration dotname.[bat|sh] - Run the NAME Protocol Tool configuration run.[bat|sh] - Run Protocol Tool with referenced properties file.