#############################################################
# Copyright (C) 2013 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
#############################################################

Basic Installation
==================
The EPP Launch SDK is provided in Java.  The minimum requirement is 
JDK 1.6.  See the sections below for specific configuration instructions.  The 
EPP Launch SDK includes the EPP Gen SDK files along with the files 
associated with a set of the EPP Command Mappings and Extensions including 
domain, host, contact, and the launch phase extension.  

The distribution is pre-built in the lib directory.  The pre-built 
EPP Launch library is lib/epp/epp-launch-bundle-<version>.jar, where <version> 
is the version of the release..
		
Test code files with a Tst.java postfix are used to test the SDK 
and used as sample code.  Ant 1.7.1 is included in the SDK under 
the lib/ant directory
and is used to build the SDK, running the Server Stub, and 
running the client tests.  Running either a build.sh for UNIX or 
build.bat for Windows will launch the included Ant 1.7.1.  The 
version of Ant can be overridden by defining the ANT_HOME environment 
variable.  The JAVA_HOME environment variable must be set.  The 
Ant targets included with each build.xml include the following:

	clean               Clean compiled files
	compile             Compile source files
	dist                Creates the distributions (-Dbuild.version required)
	dist-bin            Creates the binary distribution 
                            (-Dbuild.version required)
	dist-src            Creates the source distribution 
                            (-Dbuild.version required)
	doc                 Creates the HTML API documentation
 	jar                 Generates JAR file
 	start-server        Starts the TCP server stub
 	test                Runs all tests (CODEC and Client / Server)
 	test-client         Runs tests over TCP / SSL against TCP server stub
 	test-client-server  Runs full client / server test over TCP / SSL
 	test-codec          Runs CODEC unit tests
   
Each directory including launch contain the following files:

    build.xml 	     - Ant 1.7.1 build description file. 	
    common-targets.xml - Common targets for the source and binary distributions	
    build.sh         - UNIX build script using Ant 1.7.1 and build.xml.  
                     The same tasks defined in build.xml can be used as 
                     arguments to build.sh
    build.bat        - Windows build script using Ant 1.7.1 and build.xml.  
                     The same tasks defined in build.xml can be used as 
                     arguments to build.bat
    build.properties - Ant properties that include directory path properties
    epp.config       - Configuration file used by the EPP Server Stub
                     and the test programs.  See the comments for 
                     each configuration parameter in epp.config for 
                     more detail.
    logconfig.xml    - Log4J configuration file

	    
Running non-SSL Mode
==============================

To build and run the EPP SDK sample programs (default configuration), 
do the following:
    
    cd bundles/launch 
    build.sh test-client-server

non-SSL is the default configuration for the SDK.  The start-server target can 
be used to start the Stub Server for running an independent client test.


Running SSL Mode
==============================

bundles/launch/epp.config must be changed to run in SSL mode.  Comment
out the following lines in bundles/launch/epp.config:

EPP.ClientSocketName = com.verisign.epp.transport.client.EPPPlainClientSocket
EPP.ServerSocketName = com.verisign.epp.transport.server.EPPPlainServer

Un-comment the following lines in bundles/launch/epp.config:

EPP.ClientSocketName = com.verisign.epp.transport.client.EPPSSLClientSocket
EPP.ServerSocketName = com.verisign.epp.transport.server.EPPSSLServer

Follow the same instructions as "Running non-SSL Mode" 
after making the above configuration changes. 

SSL Certificate Configuration
==============================
The EPP SDK includes a self-signed certificate 
in the eppsdk/lib/keystore/testkeys 
file which is referenced for both the client code and the Server Stub.  For 
interfacing with a OT&E or Production Server, an official keystore needs 
to be referenced.  The following epp.config properties should be modified:

EPP.SSLKeyFileName         - Path to the keystore file
EPP.SSLPassPhrase          - Keystore passphrase
EPP.SSLKeyPassPhrase       - Optional private key passphrase.  
                             If undefined, it defaults to the  
                             EPP.SSLPassPhrase value
EPP.SSLTrustStoreFileName  - Optional path to trust keystore.  
                             If undefined the JDK trust 
                             keystore will be used
EPP.SSLTrustStorePassPhrase- Optional trust keystore passphrase