Working with Vault Java SDK Code

Vault Toolbox provides tools to extract, deploy, and delete custom Vault Java SDK code directly from Visual Studio Code. This guide outlines how to use each of these tools.

Extracting Vault Java SDK Code from Vault

Section link for Extracting Vault Java SDK Code from Vault

Vault Toolbox can extract custom Vault Java SDK code from Vault, allowing you to review it prior to writing custom code.

Caution

Extracting Vault Java SDK code deletes any local .java file whose class no longer exists in Vault, so the folder always mirrors Vault exactly. The confirmation dialog warns you before this happens if local files already exist. Click Change Location in the dialog instead of Extract to choose a different folder first. A class that merely fails to download during a run is never deleted, since its absence from your folder doesn't mean it's absent from Vault.

To extract Vault Java SDK code from Vault:

1. Select the Vault Toolbox icon in the lefthand panel.
2. Select the Actions () tab.
3. Expand Components () and select Extract Java SDK Code from Vault ().
4. In the confirmation dialog, click Extract.

Note

You must connect an environment before extracting. If no environment is connected, this action is disabled and Vault Toolbox prompts you to connect one first. See Managing Environments to learn how to connect an environment.

Once the operation completes, you can access all extracted classes from the vault-toolbox/sdk/<vaultId> folder within your repository, organized as a Java package tree. If one or more classes fail to download, Vault Toolbox still writes the classes that succeeded and reports which failed so you can investigate.

Deploying Vault Java SDK Code to Vault

Section link for Deploying Vault Java SDK Code to Vault

To deploy Vault Java SDK code to Vault, right-click a .java file in the editor or the Explorer panel and select Vault Toolbox > Deploy to Vault.

Caution

You cannot deploy Vault Java SDK code directly to a production Vault. The change-controlled path to production is a VPK deploy; this action targets sandboxes only.

Vault Toolbox reports whether the deploy succeeded or failed in a notification, including a View API Call button that opens the API History entry for the deploy.

Deleting Vault Java SDK Code from Vault

Section link for Deleting Vault Java SDK Code from Vault

To delete Vault Java SDK code from Vault, right-click a .java file in the editor or the Explorer panel and select Vault Toolbox > Delete from Vault.

Caution

Deleting a class permanently removes it from Vault. You cannot delete Vault Java SDK code directly from a production Vault. This action targets sandbox environments only.

Vault Toolbox derives the class name automatically from the file's package declaration and file name, so you don't need to provide it yourself. A confirmation dialog shows the exact class name and target Vault before anything is sent.

Vault Toolbox reports whether the deletion succeeded or failed in a notification, including a View API Call button that opens the API History entry for the deletion.