Java Quickstart

Complete the steps described in the rest of this page to create a simple Java command-line application that makes requests to the Google Vault API.

Prerequisites

To run this quickstart, you need the following prerequisites:

  • Authorization credentials for a desktop application. To learn how to create credentials for a desktop application, refer to Create credentials.
  • A Google account.

Step 1: Prepare the project

To prepare the project:

  1. In your working directory, run the following commands to create a new project structure:

    gradle init --type basic
    mkdir -p src/main/java src/main/resources 
    
  2. Copy the credentials.json file you downloaded as a prerequisite into the newly-created src/main/resources/ directory.

  3. Open the default build.gradle file and replace its contents with the following code:

    vault/quickstart/build.gradle
    apply plugin: 'java'
    apply plugin: 'application'
    
    mainClassName = 'Quickstart'
    sourceCompatibility = 1.8
    targetCompatibility = 1.8
    version = '1.0'
    
    repositories {
        mavenCentral()
    }
    
    dependencies {
        compile 'com.google.api-client:google-api-client:1.23.0'
        compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
        compile 'com.google.apis:google-api-services-vault:v1-rev8-1.23.0' 
    }
    

Step 2: Set up the sample

To set up the sample:

  1. In src/main/java/, create a new Java file with a name that matches the mainClassName value in your build.gradle file.
  2. Include the following code in your new Java file:

    vault/quickstart/src/main/java/Quickstart.java
    import com.google.api.client.auth.oauth2.Credential;
    import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
    import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
    import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
    import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
    import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
    import com.google.api.client.http.HttpTransport;
    import com.google.api.client.json.jackson2.JacksonFactory;
    import com.google.api.client.json.JsonFactory;
    import com.google.api.client.util.store.FileDataStoreFactory;
    import com.google.api.services.vault.v1.VaultScopes;
    import com.google.api.services.vault.v1.model.*;
    import com.google.api.services.vault.v1.Vault;
    
    import java.io.FileNotFoundException;
    import java.io.IOException;
    import java.io.InputStream;
    import java.io.InputStreamReader;
    import java.util.Arrays;
    import java.util.List;
    
    public class Quickstart {
        /** Application name. */
        private static final String APPLICATION_NAME =
            "Google Vault API Java Quickstart";
    
        /** Directory to store authorization tokens for this application. */
        private static final java.io.File DATA_STORE_DIR = new java.io.File("tokens");
    
        /** Global instance of the {@link FileDataStoreFactory}. */
        private static FileDataStoreFactory DATA_STORE_FACTORY;
    
        /** Global instance of the JSON factory. */
        private static final JsonFactory JSON_FACTORY =
            JacksonFactory.getDefaultInstance();
    
        /** Global instance of the HTTP transport. */
        private static HttpTransport HTTP_TRANSPORT;
    
        /** Global instance of the scopes required by this quickstart.
         *
         * If modifying these scopes, delete your previously saved credentials
         * at ~/.credentials/vault.googleapis.com-java-quickstart
         */
        private static final List<String> SCOPES =
            Arrays.asList(VaultScopes.EDISCOVERY_READONLY);
    
        static {
            try {
                HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
                DATA_STORE_FACTORY = new FileDataStoreFactory(DATA_STORE_DIR);
            } catch (Throwable t) {
                t.printStackTrace();
                System.exit(1);
            }
        }
    
        /**
         * Creates an authorized Credential object.
         * @return an authorized Credential object.
         * @throws IOException
         */
        public static Credential authorize() throws IOException {
            // Load client secrets.
            InputStream in =
                Quickstart.class.getResourceAsStream("/credentials.json");
            if (in == null) {
                throw new FileNotFoundException("Resource not found: " + CREDENTIALS_FILE_PATH);
            }
            GoogleClientSecrets clientSecrets =
                    GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in));
    
            // Build flow and trigger user authorization request.
            GoogleAuthorizationCodeFlow flow =
                    new GoogleAuthorizationCodeFlow.Builder(
                            HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, SCOPES)
                    .setDataStoreFactory(DATA_STORE_FACTORY)
                    .setAccessType("offline")
                    .build();
            Credential credential = new AuthorizationCodeInstalledApp(
                flow, new LocalServerReceiver()).authorize("user");
            System.out.println(
                    "Credentials saved to " + DATA_STORE_DIR.getAbsolutePath());
            return credential;
        }
    
        /**
         * Build and return an authorized Vault client service.
         * @return an authorized Vault client service
         * @throws IOException
         */
        public static Vault getVaultService() throws IOException {
            Credential credential = authorize();
            return new Vault.Builder(HTTP_TRANSPORT, JSON_FACTORY, credential)
                    .setApplicationName(APPLICATION_NAME)
                    .build();
        }
    
        public static void main(String[] args) throws IOException {
            // Build a new authorized API client service.
            Vault service = getVaultService();
    
            // List the first 10 matters.
            ListMattersResponse response = service.matters().list()
                .setPageSize(10)
                .execute();
            List<Matter> matters = response.getMatters();
            if (matters == null || matters.size() == 0) {
                System.out.println("No matters found.");
            } else {
                System.out.println("Matters:");
                for (Matter matter: matters) {
                    System.out.printf("%s (%s)\n", matter.getName(),
                            matter.getMatterId());
                }
            }
        }
    }

Step 3: Run the sample

To run the sample:

  1. Execute the following command:

    gradle run
    

    This command builds and runs the sample.

  2. (optional). If this is your first time running the sample, the sample opens a new window prompting you to authorize access to your data:

    1. If you are not already signed in to your Google account, you are prompted to sign in. If you are signed in to multiple Google accounts, you are asked to select one account to use for authorization.
    1. Click Accept. The app is authorized to access your data.
  3. The sample executes.

If you have problems, refer to the Troubleshoot the sample section.

Troubleshoot the sample

This section describes a common issue that you can encounter while attempting to run this quickstart.

This app isn't verified

If the OAuth consent screen displays the warning "This app isn't verified," your app is requesting scopes that provide access to sensitive user data. If your application uses sensitive scopes, your your app must go through the verification process to remove that warning and other limitations. During the development phase you can continue past this warning by clicking Advanced > Go to {Project Name} (unsafe).

Further reading

For further information on the APIs used in this quickstart, refer to the following: