البدء السريع بلغة Java

تشرح مبادئ التشغيل السريع كيفية إعداد وتشغيل تطبيق يتّصل بواجهة برمجة تطبيقات Google Workspace.

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

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

الأهداف

• إعداد البيئة.
• إعداد العيّنة
• نفِّذ النموذج.

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

• الإصدار 1.8 من Java أو إصدار أحدث.
• الإصدار 7.0 أو إصدار أحدث من Gradle:
• مشروع على Google Cloud:

• حساب على Google

إعداد البيئة

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

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

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

• في "وحدة تحكُّم Google Cloud"، فعِّل Google Vault API.

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

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

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

1. في Google Cloud Console، انتقِل إلى القائمة menu > واجهات برمجة التطبيقات والخدمات > شاشة موافقة OAuth.

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

2. بالنسبة إلى نوع المستخدم، اختَر داخلي، ثم انقر على إنشاء.
3. أكمِل نموذج تسجيل التطبيق، ثم انقر على حفظ ومتابعة.

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

5. مراجعة ملخّص تسجيل التطبيق لإجراء تغييرات، انقر على تعديل. إذا بدا تسجيل التطبيق على ما يرام، انقر على الرجوع إلى لوحة البيانات.

مصادقة بيانات الاعتماد لتطبيق سطح المكتب

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

1. في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة menu > واجهات برمجة التطبيقات والخدمات > بيانات الاعتماد.

   الانتقال إلى بيانات الاعتماد

2. انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
3. انقر على نوع التطبيق > تطبيق الكمبيوتر المكتبي.
4. في حقل الاسم، اكتب اسمًا لبيانات الاعتماد. ولا يظهر هذا الاسم إلا في وحدة تحكُّم Google Cloud.
5. انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل الجديد وسر العميل.
6. انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن معرّفات عميل OAuth 2.0.
7. احفظ ملف JSON الذي تم تنزيله باسم credentials.json، وانقله إلى دليل العمل.

تجهيز مساحة العمل

1. في دليل العمل، أنشئ بنية مشروع جديدة على النحو التالي:

   gradle init --type basic
   mkdir -p src/main/java src/main/resources 
   

2. في دليل src/main/resources/، انسخ ملف credentials.json الذي سبق لك تنزيله.

3. افتح ملف 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'
   }
   

إعداد العيّنة

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

2. ضمِّن الرمز التالي في ملف 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());
       }
     }
   }

تنفيذ النموذج

1. تنفيذ النموذج:

   gradle run
   

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

   عند تشغيل تطبيق Java، يمكنك طلب واجهة برمجة تطبيقات Google Vault API.

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

الخطوات التالية

• تحديد مشاكل المصادقة والترخيص وحلّها
• المستندات المرجعية لواجهة برمجة تطبيقات Vault
• مستندات برنامج Google APIs للغة Java
• مستندات Javadoc في Google Vault API