Oracle Cloud Infrastructure Documentation

Getting Started with Toolkit for Eclipse

Building the Toolkit

After you clone the repository on GitHub, you will need to build the Toolkit using Maven artifacts that are included with the Java SDK release.

  1. Extract the Java SDK release.
  2. Copy the dependency JARs from the Java SDK located in /lib and /thirdparty to the Toolkit under /plugins/lib.
  3. Verify that the JARs' versions match the library versions listed in oci-toolkit-eclipse/plugins/META-INF/MANIFEST.MF.
  4. At the command line, run mvn package.

After the build process completes, you can find the release .zip file in the following location:

oci-toolkit-eclipse/releng/com.oracle.oci.eclipse.update/target/com.oracle.oci.eclipse.<update-version>.zip

Installing the Toolkit

After building the toolkit, launch the Eclipse IDE.

  1. From the top navigation bar, select Help > Install New Software...
  2. In Install dialog, click Add...
  3. In the Add Repository dialog, click Archive...
  4. In the right pane of the Repository Archive window, select the zip file containing the toolkit. Click Open.
  5. In the Add Repository dialog click Add.
  6. In the Available Software dialog, select Oracle Cloud Infrastructure Toolkit for Eclipse, then click Next.
  7. In the Install Details dialog, click Finish.

Configuring the Toolkit

Oracle Cloud Infrastructure Preferences

Before you can use the toolkit, you must configure the Oracle Cloud Infrastructure Preferences in the Eclipse IDE. This process will provide the necessary identifiers and credentials so the toolkit can connect to your Oracle Cloud Infrastructure account. For more information, see Required Keys and OCIDs.

  1. From the top navigation bar, select Preferences > Oracle Cloud Infrastructure Preferences .
  2. For Profile Name, provide a short descriptive name.
  3. From the Region dropdown, select your region.

  4. Enter your User OCID and Tenancy OCID. For information on how to locate this information, see Where to Get the Tenancy's OCID and User's OCID.
  5. For Key File, click Browse and select the appropriate file. For more information, see How to Generate an API Signing Key.
  6. Enter the Fingerprint for the Key File. For more information, see How to Get the Key's Fingerprint.
  7. Enter the Passphrase, if you created one for the key pair. If not, leave this field blank.

  8. Click Save Profile.
  9. Click Apply and Close.

Proxy Settings

If you are on a network that uses a proxy to connect to the internet, you must configure Eclipse proxy settings. For more information, see Network Connections in the Eclipse IDE Documentation.

Uninstalling the Toolkit

Launch the Eclipse IDE.

  1. From the top navigation bar, select Help > About Eclipse IDE
  2. Click Installation Details.
  3. In the Installation Details window, select the Installed Software tab.
  4. Select Oracle Cloud Infrastructure Toolkit for Eclipse and click Uninstall...
  5. In the Uninstall dialog, confirm the items to be uninstalled then click Finish.
  6. Click Restart.