3 Configuring Oracle JDeveloper to Support Integration with Oracle API Catalog

This chapter describes how to configure Oracle JDeveloper to integrate with Oracle API Catalog. First, you must download the Oracle Enterprise Repository plug-in for JDeveloper. Next, you can create a connection to an Oracle API Catalog server. After installing the plug-in and creating a repository connection, see Chapter 4, "Using Oracle JDeveloper to Interact with Oracle API Catalog" for the next steps.

This chapter includes the following sections:

3.1 Install the Oracle Enterprise Repository JDeveloper 12c Plug-in

To install the Oracle Enterprise Repository plug-in for Oracle JDeveloper 12c:

  1. Install Oracle JDeveloper on your local computer. Starting in 12c, you must use the Oracle SOA Suite Quick Start distribution to obtain a version of JDeveloper pre-configured for Oracle SOA Suite. See "Installing Oracle SOA Suite Quick Start for Developers" in Installing SOA Suite and Business Process Management Suite Quick Start for Developers for more information.

    Note:

    Ensure that you are using the Oracle SOA Suite Quick Start for Developers distribution. The Oracle BPM Suite Quick Start for Developers distribution includes a version of JDeveloper that will not work with the plug-in and is not supported for use with Oracle API Catalog.
  2. Acquire the file for patch 19721053 (p19721053_121300_Generic.zip) from My Oracle Support.

  3. Ensure that JDeveloper is closed before continuing.

  4. Follow the instructions in the patch's README.txt file.

  5. Restart JDeveloper.

3.2 Create a New Repository Connection

After you have installed the plug-in, you can create a connection to a repository server.

To create a new repository connection:

  1. Click File, New. The New Gallery dialog is displayed.

  2. Select General, Connections, and then select Oracle Enterprise Repository Connection, as shown in Figure 3-1.

    Figure 3-1 New Gallery Dialog

    Description of Figure 3-1 follows
    Description of "Figure 3-1 New Gallery Dialog"

  3. Click OK. The Create Oracle Enterprise Repository Connection dialog is displayed, as shown in Figure 3-2.

    Figure 3-2 Create Oracle Enterprise Repository Connection Dialog

    Description of Figure 3-2 follows
    Description of "Figure 3-2 Create Oracle Enterprise Repository Connection Dialog"

  4. Enter the following information:

    • Connecting To: Select Oracle Enterprise Repository if you are connecting to OER, or select Oracle API Catalog if you are connecting to OAC.

    • Connection Name: A descriptive name for the Oracle API Catalog connection.

    • Repository URL: The URL from where a running instance of Oracle API Catalog can be accessed.

    • User Name: The user name for the Oracle API Catalog.

    • Password: The password for the Oracle API Catalog.

  5. Click Test Connection. A success message is displayed in the Status pane.

  6. Click OK.

  7. In the Resource Palette, under IDE Connections, expand Oracle Enterprise Repository to see the application server connection that you created, as shown in Figure 3-3.

    Figure 3-3 Resource Palette

    Description of Figure 3-3 follows
    Description of "Figure 3-3 Resource Palette"

  8. Enter a search criteria to search for assets in the Search field. A list of all the assets is displayed, as shown in Figure 3-4.

    Figure 3-4 Search Results

    Description of Figure 3-4 follows
    Description of "Figure 3-4 Search Results"

3.3 Edit an Existing Repository Connection

To edit an existing connection between JDeveloper and Oracle API Catalog:

  1. In the Resource Palette, under IDE Connections, expand Oracle Enterprise Repository to see the existing repository connections.

  2. Right-click on the connection you want to edit, and then click Properties.

  3. Edit any of the following fields:

    • Repository URL: The URL from where a running instance of Oracle API Catalog can be accessed.

    • User Name: The user name for the Oracle API Catalog.

    • Password: The password for the Oracle API Catalog.

  4. Click Test Connection. A success message is displayed in the Status pane.

  5. Click OK to save the changes and close the dialog.