This is the Readme for the JAX-WS eBay SDK for Java.
Support for the Axis 1.1 eBay SDK for Java has been discontinued.
Before using a version of the SDK, please read the most recent version of this Readme file, available at
the Java Developer Center.
Upgrades to an SDK version should always be done in a test environment.
Testing for the SDK includes testing with IBM JDKSome
components may be incompatible with IBM JDK
Point releases contain bug fixes, updates to wrapper classes, and minor functionality updates, and must pass regression testing. Full releases tend to contain more significant functionality changes, and are fully tested before release.
For Trading API versions released after your current version, please read the Trading API Release Notes (which contain tables showing schema changes that occur every two weeks).
The eBay SDK for Java supports JDK5, JDK6 and JDK7
Important: Changes to the Trading API affect the SDK. For example, in schema version 499,
deprecated objects in the schema were deleted, creating backward incompatibility.
See the
Trading API Release Notes for ongoing updates to the schema (including occasional removals of schema elements).
Please also see Versioning Strategy and Deprecated Objects.
Please note that upgrades to an SDK should always be done in a test environment and fully tested before used in production.
Download the zip file for the version of the eBay SDK for Java that you are using.
Note the location of the zip file you downloaded, but before extracting the file, create the following folder: C:\eBayJavaSDK.
Within C:\eBayJavaSDK, create an "SDKInstallDir" folder
to contain the SDK files. You could name that folder according to the Trading API version of
the SDK you are installing. For example, for the SDK for Trading API version 575, you
could name the folder eBayJavaSDK575.
Go the location of the zip file you downloaded (noted in step 3), and extract the zip file
into the SDKInstallDir folder you created in step 4.
To build the SDK, see Building the SDK.(If you're using an Integrated
Development Environment (IDE), you do not need to build the SDK, you just need to set the
paths to point to the correct libraries and files.
See C:\eBayJavaSDK\SDKInstallDir\docs\DevEnvReadme.htm for more information for configuring an IDE)
Java SE 5 (JDK5), Java SE 6 (JDK6) or Java SE 7 (JDK7)
Apache ANT -- Download from https://ant.apache.org/; Ant version 1.6.x or higher is required for all JDKs used with this release.
JAX-WS RI (Reference Implementation) 2.1.4 -- The version downloaded to SDKInstallDir (the installation directory)
at ..\SDKInstallDir\lib\externalLib\ is the standard (non-customized) version available at the official
JAX-WS RI website. You must compile the beta release with this version of the JAX-WS RI. See
Installation Instructions for more information about the installation
directory.
It is recommended that you use the latest Eclipse integrated development environment (IDE) for the migration,
although you can use any IDE for this release that supports the client environments above. Project files for Eclipse
are provided in the installation directory. Please see ..\SDKInstallDir\docs\DevEnvReadme.htm for
instructions on using these included project files with Eclipse after installing the JAXB release.
(optional) Jakarta Tomcat 5.5, if you wish to build the Java Server Pages (JSP) samples.
Update and run setenv.bat(int ..\SDKInstallDir\build\)is necessary only if you want to build the SDK source or run SDK samples from the command line
(in a command window).
Modify and run the ..\SDKInstallDir\build\setenv.bat file as follows:
After upgrading to Apache Ant 1.6.x, or higher, modify the ..\SDKInstallDir\build\setenv.bat file by adding the bin directory of your ANT installation to the PATH environment variable.
Modify the ..\SDKInstallDir\build\setenv.bat file so that the JAVA_HOME environmental variable is set to either the JDK 1.5.x or JDK 1.6.x directory.
(Optional) If you have installed Jakarta Tomcat, set the TOMCAT_HOME environment variable in ..\SDKInstallDir\build\setenv.bat to the Jakarta Tomcat location. This step is required
only if you wish to run the included JSP samples using Tomcat.
Make sure to run ..\SDKInstallDir\build\setenv.bat from a command window.
If you are using the Fedora 8 operating system, install the following patches in order to use the Swing/AWT-based
samples in the SDK:
In this section, you will use an ANT project file, build.xml, to do the following:
Generate source code from an eBay WSDL.
Compile SDK source code.
Create .jar files (such as ebaysdkcore.jar and ebaycalls.jar) for SDK libraries.
Note:
Building SDK is necessary only for advanced users who have added customization to the SDK source or need to synchronize the source with a new version of eBay Web Services Definition Language(WSDL).
In a command window, change the directory to the SDKInstallDir described in the Installation Instructions
In SDKInstallDir, follow the instructions in Post-Installation Configuration to change 'JAVA_HOME' in the 'setenv.bat' file according to your local JDK installation, then run 'setenv.bat' in command line.
In the same command window, in SDKInstallDir/build, run the following command: ant build,
(for a list of available ant tasks, run: ant help)
When a new WSDL is available, advanced users can use it to update the SDK:
Read the Trading API Release Notes. The Release Notes contain changes for Trading API versions released after your current version. The Release Notes are located at the Developer Documentation Center.
Download the new WSDL(see WSDL Locations) you want to use to SDKInstallDir\source\wsdl folder.
At a command prompt, from ...\SDKInstallDir\build, run the following command: ant build
For the Trading Web Services API Guide, the Trading API Release Notes, and other API documentation
(such as the Input/Output Reference and information about API versions), please see the
Java Developer Center.
For the Library Reference (javadoc), which includes documentation for the classes in the SDK, please see the following folder: ...\SDKInstallDir\docs\LibRef.
SDK-related items containing sample code are available in the Knowledge Base.
If your eBay SDK for Java application uses GetCategoriesCall to retrieve categories, make sure you set aside a large amount of memory for the Java virtual machine. If the application incurs Out of Memory errors, you should increase the amount of memory dedicated to the JVM.
Since the wsimport tool cannot generate 'RecipientRelationCodeType' as a Java Enum type from the eBay WSDL, use Java 'String' type instead whenever a 'RecipientRelationCodeType' is expected.
lib: jar files for eBay SDK for Java:
- ebaysdkcore.jar: the core library
- ebaycalls.jar: the API wrapper library
- eps.jar: the eBay Picture Service library
- attributes.jar: the eBay Attributes API library
- helper.jar: the helper library used in the SDK
The WSDL is located at https://developer.ebay.com/webservices/Version/ebaySvc.wsdl.
Version in the URL means latest or it means a numerical version of a WSDL release (see the top of the particular WSDL file).
In the case of Version meaning latest, the WSDL is the latest released version (https://developer.ebay.com/webservices/latest/ebaySvc.wsdl). If Version in the URL means a numerical version of the WSDL, Version is a number (for example, https://developer.ebay.com/webservices/445/ebaySvc.wsdl).
Hypothetically, if the latest release of the WSDL were 449, you would find that WSDL version at both https://developer.ebay.com/webservices/latest/ebaySvc.wsdl and at https://developer.ebay.com/webservices/449/ebaySvc.wsdl.
Each version of the eBay SDK for Java is based on a specific WSDL version of the eBay Trading API. eBay updates its WSDL file regularly. Advanced users can use more recent fields and calls by updating the code stubs in their SDK with a more recent WSDL file than the one delivered with the SDK.
Please note that WSDL updates should always be done in a test environment because WSDL updates can prevent you from using some of the wrapper classes delivered with the SDK. If you update your SDK with a WSDL that contains updated input fields for requests (that is, updated request types), you will need to manually update the affected wrapper classes or use the affected request objects directly, without wrappers.
To update the code stubs in your SDK with a more recent WSDL file, please see related instructions in Building the SDK.
Starting with SDK version 687, the eBay SDK uses the Simple Logging Facade for Java (SLF4J), a simple facade for
various logging frameworks, e.g. log4j, java.uitl.logging (also referred to as JDK 1.4 logging).
By default, eBay SDK uses log4j as the underlying
logging framework. To let log4j work properly, you need to configure log4j beforehand. For example, you can
configure log4j in the log4j.properties file and put this file in the classpath of your application (for a sample log4j.properties file, refer
to the SDK sample consoleAddItem, in {SDKRoot}\samples\consoleAddItem\src\main\resources).
If you want to switch to another logging framework such as java.util.logging, you need to remove slf4j-log4j12-1.6.1.jar and log4j-1.2.16.jar from your
classpath, then add slf4j-jdk14-1.6.1.jar (in {SDKRoot}\lib\externalLib\optional\slf4j-1.6.1) in your classpath. For details about how to configure
java.util.logging, refer to Java SDK documentation.
SDK logging can be further configured by setting ApiContext instance accordingly, for example, if you want to
disable SOAP payload logging (by default, it is enabled), just call setLogSOAPMessages (false) on the ApiLogging instance (property of ApiContext).
For more settings of ApiLogging, refer to SDK library reference.