Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle JDeveloper Extensions
11g Release 2 (11.1.2.3.0)

Part Number E20067-04
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

3 Developing with the Extension SDK

This chapter describes the Oracle JDeveloper Extension SDK, which is available to download to JDeveloper, and how to use it to develop your own extensions.

This chapter includes the following sections:

3.1 About Developing with the Extension SDK

The JDeveloper Extension Software Developer Kit (SDK) includes a collection of projects containing sample code and the javadoc-generated documentation for the Extension API.

Each sample project contains a deployment profile for one-click deployment of the sample to the appropriate directory. You can also deploy all the projects at once.

You can use the code that provides each extension as a template to help you develop similar features.

3.2 Downloading and Installing the Extension SDK

You can download and install the Extension SDK using the Check for Updates wizard, or by downloading it from the Oracle website.

To install the Extension SDK using Check for Updates:

  1. Follow the information in "How to Install Extensions with Check for Updates" in Oracle Fusion Middleware User Guide for Oracle JDeveloper, and on the Source page select the Official Oracle Extensions and Updates update center.

  2. On the Updates page, choose Extension SDK from the list of available extensions, and click Next. Owing to the size of the extension, it may take a few minutes to download depending on your internet connection.

  3. When you finish the wizard, JDeveloper will restart and install the Extension SDK. When it restarts, you are asked whether JDeveloper should install the sample application containing the sample projects described in this chapter. If you answer yes, the application extensionsdk is open in the Application Navigator, and the sample projects are listed.

If you are working behind a firewall, JDeveloper will not be able to connect to the update center until you enter details of your proxy server. You can either do this in the Web Browser and Proxy page of the Preferences dialog (available from the Tools menu), or the Check for Updates wizard will time out and display the Web Browser and Proxy page.

To install the Extension SDK using a file:

  1. Follow the information in "How to Install Extensions Directly from OTN" in Oracle Fusion Middleware User Guide for Oracle JDeveloper, and navigate to the page for Official Oracle JDeveloper Extensions.

  2. Download the Extension SDK to a local location, then open the Check for Updates wizard from the Help menu.

  3. On the Source page, choose Install from Local File and enter the location of the esdk_bundle.zip file and complete the wizard.

  4. JDeveloper will restart and install the Extension SDK. When it restarts, you are asked whether JDeveloper should install the sample application containing the sample projects described in this chapter. If you answer yes, the application extensionsdk is open in the Application Navigator, and the sample projects are listed.

3.2.1 What Happens When you Install the Extension SDK

When you successfully install the Extension SDK, the sample application is optionally open in the Application Navigator, giving you access to the sample projects that illustrate different aspects of JDeveloper functionality. You can use the code to help you develop your own extensions.

The Oracle Fusion Middleware Java API Reference for Oracle Extension SDK is available from the Reference node in the Contents list of the online help (available from the Help menu.

3.2.2 Troubleshooting Installing the Extension SDK

If you have trouble downloading the Extension SDK and you are working behind a firewall, ensure that you have set the proxy server settings on the Web Browser and Proxy page of the Preferences dialog (available from the Tools menu).

If the Check for Updates wizard has located the update center you are using, it may take up to a couple of minutes before the list of available extensions is displayed, depending on the speed of your connection.

When you select the Extension SDK in the wizard, it downloads while the wizard is still open, and this can take a couple of minutes, depending on the speed of your connection. Once the extension has finished downloading, JDeveloper needs to restart in order to install it, and a message to this effect is displayed.

3.3 Using with the Sample Extensions

The sample projects available in the Extension SDK are briefly described in this section. For more information, see the comments in each project, which provides guidance on the functionality.

If you need more information about JDeveloper, see the relevant section of the Oracle Fusion Middleware User Guide for Oracle JDeveloper.

For information about running the samples, see Section 3.4, "How to Run the Sample Projects."

3.4 How to Run the Sample Projects

You can run the sample projects in JDeveloper to see how they work.

To run a sample project:

  1. The first time you run one of the sample project extensions, you have to right-click on it and choose Deploy to Target Platform.

  2. To run the extension, right-click and choose Run Extension.

    This runs a second copy of JDeveloper with the sample project installed.