eBay SDK for Java (JAX-WS) Readme

Please note the following important information:

Contents
Release Information for the eBay SDK for Java
Installation Instructions
General Information for the eBay SDK for Java

Release Information for the eBay SDK for Java

Important: Changes to the Trading API affect the SDK. For example, in schema version 1027, 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.

SDK Version 1131 for Java
SDK Version 1113 for Java
SDK Version 1085 for Java
SDK Version 1065 for Java
SDK Version 1055 for Java
SDK Version 1027 for Java
SDK Version 981 for Java
SDK Version 967 for Java
SDK Version 951 for Java
SDK Version 939 for Java
SDK Version 921 for Java
SDK Version 917 for Java
SDK Version 897 for Java
SDK Version 883 for Java
SDK Version 871 for Java
SDK Version 861 for Java
SDK Version 849 for Java
SDK Version 837 for Java
SDK Version 825 for Java
SDK Version 817 for Java
SDK Version 805 for Java
SDK Version 797 for Java
SDK Version 791 for Java Point Release
SDK Version 787 for Java Point Release
SDK Version 779 for Java Point Release
SDK Version 775 for Java Point Release
SDK Version 771 for Java Full Release
SDK Version 747 for Java Full Release
SDK Version 735 for Java Point Release
SDK Version 715 for Java Point Release
SDK Version 705 for Java Point Release
SDK Version 687 for Java Full Release
SDK Version 673 for Java Full Release
SDK Version 661 for Java Full Release
SDK Version 639 for Java Full Release
SDK Version 631 for Java Full Release
SDK Version 623 for Java Point Release
SDK Version 615 for Java Full Release
SDK Version 603 for Java Point Release
SDK Version 595 for Java Full Release
SDK Version 581 for Java Beta Release
SDK Version 575 for Java Beta Release
SDK Version 561 and Subsequent Point Releases
Previous SDK Releases

SDK Version 1131

This release is compatible with eBay's 1131 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.


SDK Version 1113

This release is compatible with eBay's 1113 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.


SDK Version 1085

This release is compatible with eBay's 1085 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.


SDK Version 1065

This release is compatible with eBay's 1065 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.


SDK Version 1055

With release 1055, the Java Trading API SDK supports OAuth for authentication. eBay uses the OAuth 2.0 protocol only for authorizing the eBay Buy and Sell RESTful APIs. Now, OAuth can be used with the Trading API, as well. With the Trading API, all calls use the authorization code grant type, meaning users must go through the sign-in flow to grant permission to the application to make calls on their behalf. Please refer to the Using OAuth with the eBay traditional APIs for more information.

Using OAuth with the SDK

eBay uses the OAuth 2.0 protocol for authorizing the eBay Buy and Sell RESTful APIs. eBay’s OAuth implementation can also be used with the Trading API. With the Trading API, all calls use the authorization code grant type, meaning users must go through the sign-in flow to grant permission to the application to make calls on their behalf. For details about using authorization code grant type to retrieve access tokens, see Getting User Tokens in the Using eBay RESTful APIs guide.

When you are able to retrieve access tokens and refresh your tokens, you simply pass your token to the ApiContext object and the SDK does the rest.

New ViewItemWithOAuthTokensample using OAuth User Access Token

ViewItemWithOAuthToken sample has been added illustrating the usage of OAuth User Access Token instead of Auth&Auth Token to access eBay Trading API Serveras below


Important: eBay will be adding scopes for use with the Trading API specifically. When new scopes are available, your application must be ready to implement them. Users will be required to sign-in and go through the permission grant flow when the new scopes are implemented. This release is compatible with eBay's 1055 Trading WSDL.


Please refer to the Trading API Release Notes for a detailed list of the new elements and features.



SDK Version 1027

This release is compatible with eBay's 1027 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.


SDK Version 981

This release is compatible with eBay's 981 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 967

This release is compatible with eBay's 967 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 951

This release is compatible with eBay's 951 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 939

This release is compatible with eBay's 939 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 921

This release is compatible with eBay's 921 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 917

This release is compatible with eBay's 917 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 897

This release is compatible with eBay's 897 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 883

This release is compatible with eBay's 883 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 871

This release is compatible with eBay's 871 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 861

This release is compatible with eBay's 861 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 849

This release is compatible with eBay's 849 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 837

This release is compatible with eBay's 837 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 825

This release is compatible with eBay's 825 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 817

This release is compatible with eBay's 817 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 805

This release is compatible with eBay's 805 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 797

This release is compatible with eBay's 797 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 791 for Point Release

This release is compatible with eBay's 791 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 787 for Point Release

This release is compatible with eBay's 787 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 779 for Point Release

This release is compatible with eBay's 779 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 775 for Point Release

This release is compatible with eBay's 775 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new elements and features.

SDK Version 771 for Full Release

This release is compatible with eBay's 771 Trading WSDL, Please refer to the Trading API Release Notes for a detailed list of the new calls and elements.

New ItemSpecificsDemo sample using Item specifics and Seller Profile

AttributesDemo samples has been replaced with ItemSpecificsDemo sample illustrating the usage of Item specifics instead of ID-Based Attributes. ID-based attribute will be deprecated soon. Seller Profile have been used to display the new way for specifying payment, shipping, and return Policy Values.

AddItem series samples illustrating usage of Seller Profile

consoleAddItem, consoleAddItemDirect, consoleAddFixedPriceItem samples have been illustrated with new seller Profile Objects to Specify Payment, Shipping, and Return Policy Values.

SDK Version 747 for Full Release

This release is compatible with eBay's 747 Trading WSDL, and supports the following new features.

New LocalPickup Flag for GetMyEbayBuying and GetMyEbaySelling Calls

The LocalPickup flag indicates whether the buyer has selected local pickup as the shipping option or the seller has made local pickup available as a shipping option.

New SoldAsBin Flag in GetItem

New SoldAsBin flag in GetItem call indicates when an auction listing has ended before the stated auction end time due to a buyer using the Buy It Now option to purchase the item.

New Charity Refund Request Preference

New AutoOptDonationRefund flag in SetUserPreferences call allows a seller to request that eBay automatically request eBay Giving Works donation refunds after Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment. This preference is only applicable to charity listings.

Coming Soon: Motors Subtitle and Deposit Fields Replacing Attributes

eBay has added three new fields (SellerProvidedTitle, DepositAmount, and DepositType) to AddItem and related calls. These fields will soon replace the US and Canada eBay Motors Subtitle attribute (10246), and the US eBay Motors deposit amount and type attributes (10733 and 10734). The attributes will continue to work for a period of time to give developers time to migrate to the new fields. Keep an eye on these release notes for information about when the new fields will be functional.

Two New Member Message Types Added for Classified Ad Listings

ClassifiedsContactSeller and ClassifiedsBestOffer added as new message types. ClassifiedsContactSeller indicates that an inquiry has been sent to the seller regarding the corresponding classified ad listing. ClassifiedsBestOffer indicates that a best offer has been made on the seller's corresponding classified ad listing.

New Payment Status Value Added

A new value of "Paid" can now be returned in GetOrders (and other order retrieval calls) when checkout is complete and order has been paid for by the buyer. This value is returned in the CheckoutStatus.eBayPaymentStatus field. This value may also be returned in the MyeBaySelling and MyeBayBuying calls.

New Dispute Explanation Added

A new dispute explanation was added and available to use through the AddDispute call. The value is "SellerRanOutOfStock", and this value can be used by the seller when cancelling an order due to an item being out of stock.

GetOrders Now Retrieves Seller's Item and Shipping Discounts

Information on one or more item or shipping discounts can now be retrieved using GetOrders and other order retrieval calls.

Product Identifier Features Now Returned in GetCategoryFeautures

Call GetCategoryFeatures to see if a site or category supports the ability to pass in Brand/MPN, EAN, ISBN, or UPC values in an Add/Revise/Relist call.

Other New Features and Changed Functionality

Please refer to the Trading API Release Notes for a detailed list of the new calls and elements since the previous Java SDK release


Back to top

SDK Version 735 for Java Point Release

This release is compatible with eBay's 735 Trading WSDL, and supports the following new features.

Strike-Through Pricing and Minimum Advertised Price Now Available

Sellers can specify discount pricing values for an item to give the item either a Strike-Through Pricing (STP) or Minimum Advertised Price (MAP) display treatment. This feature is available to qualified sellers (and their associated developers) who participate in the Discount Pricing program. Once qualified, sellers can apply Discount Pricing to both MSKU and Non-MSKU items. STP is available on the US, UK, and DE sites while MAP is available only on the US site. For more information, see: Displaying Discount Pricing Information to Buyers.

Return Policy, Handling Time, and Item Condition Now Required for eBay Motors Parts & Accessories Listings

See details at: http://pages.ebay.com/sellerinformation/news/motorspaupdate.html

Other New Features and Changed Functionality

Please refer to the Trading API Release Notes for a detailed list of the new calls and elements since the previous Java SDK release


Back to top

SDK Version 715 for Java Point Release

This release is compatible with eBay's 715 Trading WSDL, and has the following features.

Replacement of Deprecated Search Functionality

The search calls GetSearchResults and GetCategoryListings are now deprecated in the Trading API (see Trading API Release Notes for details). This point release replaces the deprecated functionality by supplying a Finding Kit that shows how to use equivalent calls in the Finding API. The Finding Kit includes a Finding API proxy, samples, and tutorials. You can download the Finding Kit here: http://developer.ebay.com/DevZone/codebase/javasdk-jaxb/FindingKitJava_1.0.zip.


Back to top

SDK Version 705 for Java Point Release

This release is compatible with eBay's 705 Trading WSDL, and contains no new features.


Back to top

SDK Version 687 for Java Full Release

This release is compatible with eBay's 687 Trading WSDL, and supports the following new features.

Improved Logging

Commons logging is replaced with SLF4J (Simple Logging Facade for Java) for better logging support. A Notes About Logging section is added in the readme.

Reorganized Package

The JavaSDK package is re-organized so that its files and folders are in more readily expected locations, as follows.

Source Jar Available

A source jar is now provided in the lib/srcjar folder, for source debugging.

New and Improved Samples and Tutorials

The consoleAddItem sample has been enhanced. It now demonstrates how to set item specifics.

A consoleAddFixedPriceItem sample is added. It demonstrates how to set item variations.


Back to top

SDK Version 673 for Java Full Release

This release is compatible with eBay's 673 Trading WSDL, and contains support for the following new features.

New Calls and Fields

This SDK now supports the ConditionID setting on AddItem and related calls. See the Trading Call Reference to learn about Item.ConditionID.

New Samples and Tutorials

Two new Java console samples, suitable for getting started using the SDK, are added to the SDK with this release. They are called helloWorld and consoleAddItem, and they are accompanied by tutorials.

Maven Now Supported

A Maven pom.xml file is provided in the helloWorld and consoleAddItem samples; refer to readme_maven.txt in the sample folder for instructions for building and running these samples with Maven. Also included: a pom.xml file for building ebaysdkcore.jar with Maven. Refer to {SDK Root}/build/maven_build/readme.txt for build instructions.


Back to top

SDK Version 661 for Java Full Release

This release is compatible with eBay's 661 Trading WSDL, and contains support for the following new features.

New Calls and Fields

The VerifyRelistItem and ExtendSiteHostedPictures calls, as well as a new VerifyOnly field for the ReviseItem call have been introduced in this release. Please refer to the Trading API Release Notes for a detailed list of the new calls and elements.

Updated apiCallDemo Sample

A new UploadPictures sample has been added in the apiCallsDemo. This sample shows how to use the eBay Picture Service (EPS) to upload pictures.

Log4j Dependency Removed

Per your request, we removed the Apache log4j dependency and used Apache commons logging instead in the JavaSDK core library. However, you can still see how to configure Apache log4j in the SDK samples.

Updated Readme for attributesDemo Sample

The readme for the attributesDemo sample has been updated to reflect the latest changes to the sample.


Back to top

SDK Version 639 for Java Full Release

This release is compatible with eBay's 639 Trading WSDL, and contains support for the following new features.

Simplified Java attributesDemo Sample

The Java attributesDemo sample has been simplified. This sample simulates a simple sell your item(SYI) flow, it shows how to use eBay API/SDK to:

For detailed architecture and call flow of the sample, please refer to the readme in the sample folder.

Setting Up JavaSDK in Eclipse

The eclipse project files for JavaSDK have been updated, all absolute references (library, source, jdk) have been changed to relative references, now all projects can be imported into eclipse environment without additional reference updates.

For instructions about how to setup JavaSDK in Eclipse, please refer to the DevEnvReadme in SDK root folder.


Back to top

SDK Version 631 for Java Full Release

This release is compatible with eBay's 631 Trading WSDL, and contains support for the following new features.

New Helper Class for HTTP Proxy Settings

A new class, SdkProxySelector.java, is included in this release for those who access the eBay API using a proxy server and want to configure the proxy settings programmatically. For examples of usage, please refer to the apiCallsDemo sample.

New DetailsDownloader Helper Class

The new DetailsDownloader.java, helper class shows you how to cache eBay details locally.

Most Calls Can Be Made with Tokens Only

With the exception of, GetTokenStatus, RevokeToken, GetSessionID, and FetchToken, all Java SDK API calls can now be made with an eBay API developer token (instead of full eBay API developer credentials.)


Back to top

SDK Version 623 for Java Point Release

This release is compatible with eBay's 623 Trading WSDL, and there are no new features.


Back to top

SDK Version 615 for Java Full Release

This release is compatible with eBay's 615 Trading WSDL, and contains support for the following new features.

Support for the AddFixedPriceItem Family of Calls

Four new classes, AddFixedPriceItem.java, ReviseFixedPriceItem.java, RelistFixedPriceItem.java and AddFixedPriceItem.java, have been added in this release. These classes can be used as single calls within a Java method, or they can be used within data files in the Large Merchant Services solution.



Back to top

SDK Version 603 for Java Point Release

This release is compatible with eBay's 603 Trading WSDL, and contains support for the following new features.

New Helper Classes

Two new helper classes, CategoriesDownloader.java and FeaturesDownloader.java, have been added in this release. The CategoriesDownloader.java class caches eBay Category information to a local disk. The FeaturesDownloader.java class caches the eBay Category Feature information to a local disk. Using these classes, you can access category information without repeatedly making GetCategory and GetCategoryFeatures requests.

Updated AttributesDemo Samples to Cache Meta-data

The AttributesDemo sample has been updated to take advantage of the new helper classes, so that you can see how to cache the eBay categories and features in a local repository.

eBayAccount Class Returned

The eBayAccount class was removed as part of a code clean-up in Release 595. It has been added back into the code for this release. It is also available as a downloadable patch for Release 595.


Back to top

SDK Version 595 for Java Full Release

This release is compatible with eBay's 595 Trading WSDL, and contains support for the following new features.

Migrating from Axis 1.1 to JAX-WS

In this release, the eBay SDK for Java has been migrated from Axis 1.1 to JAX-WS for use with production code. We recommend that you upgrade your production applications from the Axis version of the eBay SDK for Java to the JAX-WS version. For more information, please see Migrating to the JAX-WS eBay SDK for Java.

UploadSiteHostedPicture

Since the classes in the eBay Picture Service (EPS) have been replaced by the UploadSiteHostedPictures Trading API (XML) call, the Java SDK now supports the UploadSiteHostedPictures call. Because this is a Trading API call, you will need to provide an eBay developer authorization token (that you obtain with your application keys) when making this call.

The UploadSiteHostedPictures call is the only call in the Trading API that doesn't support SOAP. Therefore, you need to use the following (XML) endpoints (Gateway URLs):

In addition, it is important that you use these endpoints for both the production and sandbox environments. The addresses for both environments must be consistent because you will need to update the authorization token in your ApiContext class before switching from one platform to the other (Trading API (XML) and SDK servers use different authorization keys.)

You can still use the EPS libraries with this release, but they will eventually be discontinued, so we recommend that you migrate to the newer call as soon as you can. The UploadSiteHostedPictures call enables you to upload files in image formats such as JPG by including a binary attachment after the XML input, as part of the request. The call returns SiteHostedPictureDetails.FullURL, which must be stored by your application (for associating the picture using the Item.PictureDetails.PictureURL field of AddItem, ReviseItem, or RelistItem).

For more information, please see the following:

Selling Manager Pro (SMP) calls are supported in this release.

Support for ProPay

This release also includes support for the ProPay payment method. ProPay is a third party application that allows small businesses to accept credit cards. For more information about ProPay, see www.ProPay.com. For more information about accepted eBay payment methods, see BuyerPaymentMethodCodeType in the Trading Call Reference.

Updates to SDK Samples

An updated JSP attributeDemo sample includes return policy information that is integrated with the rest of the Item details, instead of being posted on a separate page. It also includes a dynamic lookup feature for Shipping Service, Payment Methods, Listing Type, and Listing Duration. This sample demonstrates the usage of eBay Custom Item Specifics with the Trading API GetCategoryFeatures and GetCategorySpecifics calls.

Some SDK samples have been updated based on recent API features. Please note that for Return Policy and for the requirement to specify shipping, some samples contain hard-coded fields. Therefore, if you want to change the target site used in the sample, you must integrate GetCategoryFeaturesCall and GeteBayDetailsCall into the sample. For important information, see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center.

Documentation of Recent API Features

For important information about the latest API features, including new requirements for listings, please see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center.

Removal of Legacy XML Classes

As of this release, all legacy XML classes and calls have been removed. The new UploadSiteHostedPictures call is the only remaining XML call.


Back to top

SDK Version 581 for Java Beta Release

Migrating from Axis 1.1 to JAX-WS

In this second Beta release, the eBay SDK for Java has been migrated from Axis 1.1 to JAX-WS. For more information, please see Migrating to the JAX-WS eBay SDK for Java (Beta Release).

Documentation of Recent API Features Available

For important information about the latest API features, including new requirements for listings, please see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center.

Recent API Feature Updates

The eBay SDK for Java contains updated wrapper classes, updated test cases, and other updates that facilitate your use of recent API features. Changes include updates to user token retrieval and deprecation of eBay Express.

Updates to SDK Samples

Some SDK samples are updated based on recent API features. Please note that for Return Policy and for the requirement to specify shipping, some samples contain hard-coded fields. Therefore, if you want to change the target site used in the sample, you must integrate GetCategoryFeaturesCall and GeteBayDetailsCall into the sample. For important information, see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center.


Back to top

SDK Version 575 for Java Beta Release

Migration from Axis 1.1 to JAX-WS

In this release, the eBay SDK for Java has been migrated from Axis 1.1 to JAX-WS. This migration includes changes to the SDK core classes, wrapper classes, samples, and test cases. Stubs and datatypes are now generated with the wsimport tool under the JAX-WS standard, and this process is automated as before by using Ant (the name of the buildfile is build.xml). For more information, please see Migrating to the JAX-WS eBay SDK for Java.


Back to top

SDK Version 561 and Subsequent Point Releases

SDK Version 561 Was Based on Axis 1-1

SDK version 561, and earlier SDK versions, were based on Axis 1-1.

Handling of Unrecognized Data Values

A new StubModifier tool is used to handle unrecognized enum values received in a SOAP response. The tool post-processes the stubs generated by Apache Axis WSDL2Java. The tool contains the StubModifier class, located in ...\source\Tools\StubModifier\src\tools\webservices\wsdl\stubutil\StubModifier.java.

User Authentication Improvements

The eBay SDK for Java includes the user-authentication improvements released with Trading API version 557. For information about these improvements, see the Release Notes for version 557 of the Trading API and see Authentication and Authorization.

The SDK changes include 3 new wrapper classes (GetSessionIDCall, GetTokenStatusCall, and RevokeTokenCall) and new FetchTokenCall functionality. Please use the new FetchTokenCall functionality in your application. The apiCallsDemo and signinRedirect samples are updated with the new FetchTokenCall functionality. Additionally, the apiCallsDemo is updated to show uses of GetTokenStatusCall and RevokeTokenCall.

Documentation of Recent API Features Available

For information about the latest API features, please see the Trading API Release Notes and the eBay Trading Web Services section of the Developer Documentation Center.


Back to top

Previous Java SDK Releases

For information about previous versions, see the Axis 1.1 Java SDK Readme.


Installation Instructions

Please note that upgrades to an SDK should always be done in a test environment and fully tested before used in production.

  1. Download the zip file for the version of the eBay SDK for Java that you are using.


  2. Note the location of the zip file you downloaded, but before extracting the file, create the following folder: C:\eBayJavaSDK.


  3. 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.


  4. 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.


  5. 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)

Back to top

General Information for the eBay SDK for Java

Development Requirements
Post-Installation Configuration
SDK-Related Links
Building the SDK
Documentation
Known Issues
Included in the eBay SDK for Java
WSDL Locations
WSDL Updates
Supported Client Environments
Notes About Logging

Development Requirements


Back to top

Post-Installation Configuration

Note: Modify and run the ..\SDKInstallDir\build\setenv.bat file as follows:
  1. 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.
  2. 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.
  3. (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.
  4. 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:
  1. http://download.fedora.redhat.com/pub/fedora/linux/updates/8/i386/libxcb-1.0-4.fc8.i386.rpm
  2. http://download.fedora.redhat.com/pub/fedora/linux/updates/8/i386/libxcb-devel-1.0-4.fc8.i386.rpm

Back to top

SDK-Related Links


Back to top

Building the SDK

In this section, you will use an ANT project file, build.xml, to do the following:

Note:

To build the SDK, use the following steps:

  1. Review and follow all the steps in the Installation Instructions


  2. In a command window, change the directory to the SDKInstallDir described in the Installation Instructions


  3. 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.


  4. In the same command window, in SDKInstallDir/build, run the following command: ant build,
    (for a list of available ant tasks, run: ant help)


  5. When a new WSDL is available, advanced users can use it to update the SDK:
    1. 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.


    2. Download the new WSDL(see WSDL Locations) you want to use to SDKInstallDir\source\wsdl folder.


    3. At a command prompt, from ...\SDKInstallDir\build, run the following command:
      ant build



Back to top

Documentation


Back to top

Known Issues


Back to top

Included in the eBay SDK for Java


Back to top

WSDL Locations

The WSDL is located at http://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 (http://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, http://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 http://developer.ebay.com/webservices/latest/ebaySvc.wsdl and at http://developer.ebay.com/webservices/449/ebaySvc.wsdl.


Back to top

WSDL Updates


Back to top

Supported Client Environments

eBay has tested the eBay SDK for Java using the following client environments:

Note: You can use any integrated development environment (IDE) with the eBay SDK for Java, as long as it supports the above environments.


Back to top

Notes About Logging

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, please 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, please refer to Java SDK documentation.

For more details about SLF4J, please refer to its official site.

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, please refer to SDK library reference.


Back to top

© 2005–2010 eBay Inc. All rights reserved.