بدء استخدام Java

يمكنكم إنشاء تطبيق سطر أوامر بلغة Java يرسل طلبات إلى Google Vault API.

توضّح أدلة البدء السريع كيفية إعداد تطبيق يرسل طلبات إلى Google Workspace API وتشغيله. يستخدم دليل البدء السريع هذا طريقة مصادقة مبسطة مناسبة لبيئة الاختبار. بالنسبة إلى بيئة الإنتاج، ننصحكم بالتعرّف على المصادقة والتفويض قبل اختيار بيانات الاعتماد المناسبة لتطبيقكم.

يستخدم دليل البدء السريع هذا مكتبات عملاء واجهة برمجة التطبيقات المقترَحة من Google Workspace للتعامل مع بعض تفاصيل عملية المصادقة والتفويض.

الأهداف

إعداد البيئة
إعداد النموذج
تشغيل النموذج

المتطلبات الأساسية

حساب Google

إعداد البيئة

لإكمال دليل البدء السريع هذا، يجب إعداد البيئة.

تفعيل واجهة برمجة التطبيقات

قبل استخدام Google APIs، يجب تفعيلها في مشروع على Google Cloud. يمكنكم تفعيل واجهة برمجة تطبيقات واحدة أو أكثر في مشروع واحد على Google Cloud.

في Google Cloud Console، فعِّلوا Google Vault API.

تفعيل واجهة برمجة التطبيقات

ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth

إذا كنتم تستخدمون مشروعًا جديدًا على Google Cloud لإكمال دليل البدء السريع هذا، اضبطوا شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth. إذا سبق لكم إكمال هذه الخطوة لمشروعكم على Cloud، انتقِلوا إلى القسم التالي.

في Google API Console، انتقِلوا إلى "القائمة" menu > منصة Google للمصادقة > العلامة التجارية.
الانتقال إلى صفحة "العلامة التجارية"
إذا سبق لكم ضبط "منصة Google للمصادقة"، يمكنكم ضبط إعدادات شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth التالية في العلامة التجارية والجمهور والوصول إلى البيانات. إذا ظهرت لكم رسالة لم يتم ضبط "منصة Google للمصادقة" بعد، انقروا على البدء:

ضمن معلومات التطبيق، أدخِلوا اسمًا للتطبيق في اسم التطبيق.
في البريد الإلكتروني لدعم المستخدمين، اختاروا عنوان بريد إلكتروني للدعم يمكن للمستخدمين التواصل من خلاله إذا كانت لديهم أسئلة حول موافقتهم.
انقروا على التالي.
ضمن الجمهور ، اختاروا داخلي.
انقروا على التالي.
ضمن معلومات الاتصال، أدخِلوا عنوان بريد إلكتروني يمكنكم تلقّي إشعارات من خلاله بشأن أي تغييرات تطرأ على مشروعكم.
انقروا على التالي.
ضمن إنهاء، راجِعوا سياسة بيانات المستخدمين في خدمات Google API، وإذا كنتم موافقين عليها، اختاروا أوافق على "سياسة بيانات المستخدمين في خدمات Google API".
انقروا على متابعة.
انقروا على إنشاء.

يمكنكم في الوقت الحالي تخطّي إضافة النطاقات. في المستقبل، عند إنشاء تطبيق لاستخدامه خارج مؤسسة Google Workspace، يجب تغيير نوع المستخدم إلى خارجي. بعد ذلك، أضيفوا نطاقات التفويض التي يتطلبها تطبيقكم. لمزيد من المعلومات، اطّلِعوا على دليل ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth الكامل .

السماح ببيانات اعتماد لتطبيق على الكمبيوتر

لمصادقة المستخدمين النهائيين والوصول إلى بيانات المستخدمين في تطبيقكم، يجب إنشاء معرّف عميل واحد أو أكثر لبروتوكول OAuth 2.0. يُستخدم معرّف العميل لتعريف تطبيق واحد على خوادم OAuth من Google. إذا كان تطبيقكم يعمل على منصات متعددة، يجب إنشاء معرّف عميل منفصل لكل منصة.

في Google API Console، انتقِلوا إلى "القائمة" > منصة Google للمصادقة > العملاء.
الانتقال إلى صفحة "العملاء"
انقروا على إنشاء عميل.
انقروا على نوع التطبيق > تطبيق على الكمبيوتر.
في حقل الاسم ، اكتبوا اسمًا لبيانات الاعتماد. لا يظهر هذا الاسم إلا في Google API Console.
انقروا على إنشاء.
تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عملاء OAuth 2.0".
احفظوا ملف JSON الذي تم تنزيله باسم credentials.json وانقلوا الملف إلى دليل العمل.

إعداد مساحة العمل

في دليل العمل، أنشئوا بنية مشروع جديدة:
```
gradle init --type basic
mkdir -p src/main/java src/main/resources 
```
في الدليل src/main/resources/، انسخوا ملف credentials.json الذي سبق لكم تنزيله.
افتحوا ملف build.gradle التلقائي واستبدلوا محتوياته بالرمز التالي:

vault/quickstart/build.gradle

عرض على GitHub
```
apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'Quickstart'
sourceCompatibility = 11
targetCompatibility = 11
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.google.api-client:google-api-client:2.0.0'
    implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
    implementation 'com.google.apis:google-api-services-vault:v1-rev20220423-2.0.0'
}
```

إعداد النموذج

في الدليل src/main/java/، أنشئوا ملف Java جديدًا باسم يطابق قيمة mainClassName في ملف build.gradle.

أدرِجوا الرمز التالي في ملف Java الجديد:

vault/quickstart/src/main/java/Quickstart.java

عرض على GitHub

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.gson.GsonFactory;
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 JSON factory.
   */
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
  /**
   * Global instance of the scopes required by this quickstart.
   * <p>
   * 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);
  /**
   * Global instance of the {@link FileDataStoreFactory}.
   */
  private static FileDataStoreFactory DATA_STORE_FACTORY;
  /**
   * Global instance of the HTTP transport.
   */
  private static HttpTransport HTTP_TRANSPORT;

  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.");
      return;
    }
    System.out.println("Matters:");
    for (Matter matter : matters) {
      System.out.printf("%s (%s)\n", matter.getName(),
          matter.getMatterId());
    }
  }
}

تشغيل النموذج

شغِّلوا النموذج:
```
gradle run
```

في المرة الأولى التي تشغّلون فيها النموذج، سيُطلب منكم السماح بالوصول:
1. إذا لم يسبق لكم تسجيل الدخول إلى حساب Google، سجِّلوا الدخول عند المطالبة بذلك. إذا كنتم مسجّلين الدخول إلى حسابات متعددة، اختاروا حسابًا واحدًا لاستخدامه في التفويض.
2. انقروا على حسنًا.
سيتم تشغيل تطبيق Java وإرسال طلبات إلى Google Vault API.

يتم تخزين معلومات التفويض في نظام الملفات، لذا لن يُطلب منكم منح التفويض في المرة التالية التي تشغّلون فيها نموذج الرمز.

بدء استخدام Java تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.