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

إنشاء موصِّل هوية

لا يتعرّف Google Cloud Search تلقائيًا إلا على هويات Google في Google Cloud Directory. استخدِم موصّلات الهوية لمزامنة هويات المؤسسة مع هويات Google التي يستخدمها Cloud Search.

تقدّم Google الخيارات التالية لتطوير موصّلات الهوية:

حزمة تطوير البرامج (SDK) لموصّل الهوية: هي الخيار الأفضل لمبرمجي Java. تتضمّن حزمة تطوير البرامج (SDK) برنامجًا تضمينيًا حول واجهة برمجة التطبيقات REST، ما يتيح لك إنشاء الموصّلات بسرعة. لاستخدام حزمة تطوير البرامج (SDK)، يُرجى الاطّلاع على مقالة إنشاء موصّل هوية باستخدام حزمة تطوير البرامج (SDK) لموصّل الهوية.
واجهة برمجة تطبيقات REST منخفضة المستوى ومكتبات واجهة برمجة التطبيقات: هي الخيار الأفضل للمبرمجين الذين لا يستخدمون Java. لإنشاء موصّل هوية باستخدام واجهة برمجة التطبيقات REST، يُرجى الاطّلاع على مستندات Directory API: User Accounts لربط المستخدمين و مستندات Google Cloud Identity لربط المجموعات.

إنشاء موصّل هوية باستخدام حزمة تطوير البرامج (SDK) لموصّل الهوية

ينفّذ موصّل الهوية العادي المهام التالية:

ضبط الموصّل
استرداد المستخدمين من نظام الهوية وإرسالهم إلى Google
استرداد المجموعات من نظام الهوية وإرسالها إلى Google

إعداد التبعيات

أدرِج هذه التبعيات في ملف الإصدار.

Maven

<dependency>
  <groupId>com.google.enterprise.cloudsearch</groupId>
  <artifactId>google-cloudsearch-identity-connector-sdk</artifactId>
  <version>v1-0.0.3</version>
</dependency>

Gradle

compile group: 'com.google.enterprise.cloudsearch',
        name: 'google-cloudsearch-identity-connector-sdk',
        version: 'v1-0.0.3'

إنشاء إعدادات الموصّل

يستخدم كل موصّل ملف إعدادات للمَعلمات، مثل معرّف المستودع. حدِّد المَعلمات كأزواج مفتاح-قيمة، مثل api.sourceId=1234567890abcdef

تتضمّن حزمة تطوير البرامج (SDK) في Google Cloud Search مَعلمات مقدَّمة من Google لجميع الموصّلات. عليك الإعلان عن ما يلي في ملف الإعدادات:

موصّل المحتوى: أعلِن عن api.sourceId و api.serviceAccountPrivateKeyFile. تحدّد هاتان المَعلمتان المستودع والمفتاح الخاص اللازم للوصول.

موصّل الهوية: أعلِن عن api.identitySourceId لتحديد مصدر الهوية الخارجي. لمزامنة المستخدمين، أعلِن أيضًا عن api.customerId (المعرّف الفريد لحسابك على Google Workspace).

لا تعلن عن المَعلمات الأخرى المقدَّمة من Google إلا لإلغاء قيمها التلقائية. لمعرفة التفاصيل حول إنشاء المعرّفات والمفاتيح، يُرجى الاطّلاع على مقالة المَعلمات المقدَّمة من Google.

يمكنك أيضًا تحديد مَعلمات خاصة بالمستودع في ملف الإعدادات.

إرسال ملف الإعدادات إلى الموصّل

اضبط خاصية النظام config لإرسال ملف الإعدادات. استخدِم الوسيطة -D عند بدء الموصّل. على سبيل المثال:

java -classpath myconnector.jar -Dconfig=MyConfig.properties MyConnector

إذا لم تُدرِج هذه الوسيطة، تحاول حزمة تطوير البرامج (SDK) استخدام ملف باسم connector-config.properties في الدليل المحلي.

إنشاء موصّل هوية للمزامنة الكاملة باستخدام فئة نموذجية

تتضمّن حزمة تطوير البرامج (SDK) نموذج FullSyncIdentityConnector لمزامنة جميع المستخدمين والمجموعات من المستودع. يوضّح هذا القسم كيفية استخدامه.

يشير هذا القسم إلى الرمز البرمجي من نموذج IdentityConnectorSample.java الذي يقرأ الهويات من ملفات CSV.

تنفيذ نقطة دخول الموصّل

نقطة الدخول هي طريقة main(). تنشئ هذه الطريقة مثيلاً من Application وتستدعي start() لتشغيل الموصّل.

قبل استدعاء application.start()، استخدِم IdentityApplication.Builder لإنشاء نموذج FullSyncIdentityConnector.

IdentityConnectorSample.java

عرض على GitHub

/**
 * This sample connector uses the Cloud Search SDK template class for a full
 * sync connector. In the full sync case, the repository is responsible
 * for providing a snapshot of the complete identity mappings and
 * group rosters. This is then reconciled against the current set
 * of mappings and groups in Cloud Directory.
 *
 * @param args program command line arguments
 * @throws InterruptedException thrown if an abort is issued during initialization
 */
public static void main(String[] args) throws InterruptedException {
  Repository repository = new CsvRepository();
  IdentityConnector connector = new FullSyncIdentityConnector(repository);
  IdentityApplication application = new IdentityApplication.Builder(connector, args).build();
  application.start();
}

تستدعي حزمة تطوير البرامج (SDK) طريقة initConfig() بعد أن تستدعي طريقة main() طريقة Application.build(). تنفّذ طريقة initConfig() ما يلي:

تتأكّد من عدم تهيئة Configuration من قبل.
تُهيّئ عنصر Configuration باستخدام أزواج المفتاح والقيمة المقدَّمة من Google.

تنفيذ واجهة Repository

يزامن عنصر Repository هويات المستودع مع هويات Google. عند استخدام نموذج، عليك فقط إلغاء طرق معيّنة. بالنسبة إلى FullSyncIdentityConnector، عليك إلغاء هذه الطرق:

init(): للإعداد والتهيئة
listUsers(): لمزامنة جميع المستخدمين
listGroups(): لمزامنة جميع المجموعات
(اختياري) close(): للتنظيف أثناء الإيقاف

الحصول على مَعلمات الإعدادات المخصّصة

استردِع المَعلمات المخصّصة من عنصر Configuration، عادةً في طريقة init(). يوضّح المقتطف التالي كيفية استرداد مسارات CSV:

IdentityConnectorSample.java

عرض على GitHub

/**
 * Initializes the repository once the SDK is initialized.
 *
 * @param context Injected context, contains convenienve methods
 *                for building users & groups
 * @throws IOException if unable to initialize.
 */
@Override
public void init(RepositoryContext context) throws IOException {
  log.info("Initializing repository");
  this.context = context;
  userMappingCsvPath = Configuration.getString(
      "sample.usersFile", "users.csv").get().trim();
  groupMappingCsvPath = Configuration.getString(
      "sample.groupsFile", "groups.csv").get().trim();
}

للحصول على مَعلمة تحتوي على عدة قيم وتحليلها، استخدِم أحد محلّلات النوع في فئة Configuration لتحليل البيانات إلى أجزاء منفصلة. يستخدم المقتطف التالي، من موصّل البرنامج التعليمي، طريقة getMultiValue للحصول على قائمة بأسماء مستودعات GitHub:

GithubRepository.java

عرض على GitHub

ConfigValue<List<String>> repos = Configuration.getMultiValue(
    "github.repos",
    Collections.emptyList(),
    Configuration.STRING_PARSER);

الحصول على عملية الربط لجميع المستخدمين

ألغِ طريقة listUsers() لاسترداد عمليات ربط المستخدمين. تقبل هذه الطريقة نقطة تحقّق لاستئناف المزامنة إذا تم إيقافها. لكل مستخدم:

احصل على عملية الربط بين هوية Google والهوية الخارجية.
جمِّع الزوج في المكرّر الذي تعرضه listUsers().

الحصول على عملية ربط مستخدم

يوضّح هذا المقتطف كيفية استرداد عمليات ربط الهوية من ملف CSV:

IdentityConnectorSample.java

عرض على GitHub

/**
 * Retrieves all user identity mappings for the identity source. For the
 * full sync connector, the repository must provide a complete snapshot
 * of the mappings. This is reconciled against the current mappings
 * in Cloud Directory. All identity mappings returned here are
 * set in Cloud Directory. Any previously mapped users that are omitted
 * are unmapped.
 *
 * The connector does not create new users. All users are assumed to
 * exist in Cloud Directory.
 *
 * @param checkpoint Saved state if paging over large result sets. Not used
 *                   for this sample.
 * @return Iterator of user identity mappings
 * @throws IOException if unable to read user identity mappings
 */
@Override
public CheckpointCloseableIterable<IdentityUser> listUsers(byte[] checkpoint)
    throws IOException {
  List<IdentityUser> users = new ArrayList<>();
  try (Reader in = new FileReader(userMappingCsvPath)) {
    // Read user mappings from CSV file
    CSVParser parser = CSVFormat.RFC4180
        .withIgnoreSurroundingSpaces()
        .withIgnoreEmptyLines()
        .withCommentMarker('#')
        .parse(in);
    for (CSVRecord record : parser.getRecords()) {
      // Each record is in form: "primary_email", "external_id"
      String primaryEmailAddress = record.get(0);
      String externalId = record.get(1);
      if (primaryEmailAddress.isEmpty() || externalId.isEmpty()) {
        // Skip any malformed mappings
        continue;
      }
      log.info(() -> String.format("Adding user %s/%s",
          primaryEmailAddress, externalId));

      // Add the identity mapping
      IdentityUser user = context.buildIdentityUser(
          primaryEmailAddress, externalId);
      users.add(user);
    }
  }
  // ...
}

تجميع عملية ربط مستخدم في مكرّر

تعرض طريقة listUsers() عنصر CheckpointCloseableIterable من IdentityUser عناصر.

IdentityConnectorSample.java

عرض على GitHub

CheckpointCloseableIterable<IdentityUser> iterator =
  new CheckpointCloseableIterableImpl.Builder<IdentityUser>(users)
      .setHasMore(false)
      .setCheckpoint((byte[])null)
      .build();

الحصول على مجموعة

ألغِ طريقة listGroups() لاسترداد المجموعات وأعضائها. تقبل هذه الطريقة نقطة تحقّق. لكل مجموعة:

احصل على المجموعة وأعضائها.
جمِّعها في المكرّر الذي تعرضه listGroups().

الحصول على هوية المجموعة

يوضّح هذا المقتطف كيفية استرداد المجموعات والأعضاء من ملف CSV:

IdentityConnectorSample.java

عرض على GitHub

/**
 * Retrieves all group rosters for the identity source. For the
 * full sync connector, the repository must provide a complete snapshot
 * of the rosters. This is reconciled against the current rosters
 * in Cloud Directory. All groups and members  returned here are
 * set in Cloud Directory. Any previously created groups or members
 * that are omitted are removed.
 *
 * @param checkpoint Saved state if paging over large result sets. Not used
 *                   for this sample.
 * @return Iterator of group rosters
 * @throws IOException if unable to read groups
 */    @Override
public CheckpointCloseableIterable<IdentityGroup> listGroups(byte[] checkpoint)
    throws IOException {
  List<IdentityGroup> groups = new ArrayList<>();
  try (Reader in = new FileReader(groupMappingCsvPath)) {
    // Read group rosters from CSV
    CSVParser parser = CSVFormat.RFC4180
        .withIgnoreSurroundingSpaces()
        .withIgnoreEmptyLines()
        .withCommentMarker('#')
        .parse(in);
    for (CSVRecord record : parser.getRecords()) {
      // Each record is in form: "group_id", "member"[, ..., "memberN"]
      String groupName = record.get(0);
      log.info(() -> String.format("Adding group %s", groupName));
      // Parse the remaining columns as group memberships
      Supplier<Set<Membership>> members = new MembershipsSupplier(record);
      IdentityGroup group = context.buildIdentityGroup(groupName, members);
      groups.add(group);
    }
  }
  // ...

}

تجميع المجموعة والأعضاء في مكرّر

تعرض طريقة listGroups() عنصر CheckpointCloseableIterable من IdentityGroup عناصر.

IdentityConnectorSample.java

عرض على GitHub

CheckpointCloseableIterable<IdentityGroup> iterator =
   new CheckpointCloseableIterableImpl.Builder<IdentityGroup>(groups)
      .setHasMore(false)
      .setCheckpoint((byte[])null)
      .build();

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

(اختياري) نفِّذ close() لتحرير الموارد.
(اختياري) أنشئ موصّل محتوى.

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

إنشاء موصّل هوية باستخدام حزمة تطوير البرامج (SDK) لموصّل الهوية

إعداد التبعيات

Maven

Gradle

إنشاء إعدادات الموصّل

إرسال ملف الإعدادات إلى الموصّل

إنشاء موصّل هوية للمزامنة الكاملة باستخدام فئة نموذجية

تنفيذ نقطة دخول الموصّل

تنفيذ واجهة Repository

الحصول على مَعلمات الإعدادات المخصّصة

الحصول على عملية الربط لجميع المستخدمين

الحصول على عملية ربط مستخدم

تجميع عملية ربط مستخدم في مكرّر

الحصول على مجموعة

الحصول على هوية المجموعة

تجميع المجموعة والأعضاء في مكرّر

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

إنشاء موصِّل هوية