Kimlik bağlayıcı oluşturma

Varsayılan olarak, Google Cloud Search yalnızca Google Cloud Directory'de depolanan Google kimliklerini (kullanıcılar ve gruplar) tanır. Kimlik bağlayıcıları, kuruluşunuzun kimliklerini Google Cloud Search tarafından kullanılan Google kimlikleriyle senkronize etmek için kullanılır.

Google, kimlik bağlayıcıları geliştirmek için aşağıdaki seçenekleri sunar:

  • Identity Connector SDK'sı. Bu seçenek, Java programlama dilinde programlama yapan geliştiriciler içindir. Identity Connector SDK, REST API etrafında hızlıca bağlayıcılar oluşturmanıza olanak tanıyan bir sarmalayıcıdır. SDK'yı kullanarak bir kimlik bağlayıcı oluşturmak için Identity Connector SDK'sını kullanarak kimlik bağlayıcısı oluşturma bölümüne bakın.

  • Alt düzey bir REST API ve API kitaplıkları. Bu seçenekler, Java'da programlama yapmayan veya kod tabanı REST API'ye veya bir kitaplığa daha uygun olan geliştiricilere yöneliktir. REST API'yi kullanarak bir kimlik bağlayıcısı oluşturmak istiyorsanız kullanıcıları eşleme hakkında bilgi için Directory API: Kullanıcı Hesapları, eşleme grupları hakkında bilgi için Cloud Identity Belgeleri sayfasını inceleyin.

Identity Connector SDK'sını kullanarak kimlik bağlayıcısı oluşturma

Tipik bir kimlik bağlayıcısı aşağıdaki görevleri gerçekleştirir:

  1. Bağlayıcıyı yapılandırın.
  2. Kurumsal kimlik sisteminizden tüm kullanıcıları alın ve Google kimlikleriyle senkronize edilmeleri için Google'a gönderin.
  3. Kurumsal kimlik sisteminizden tüm grupları alın ve Google kimlikleriyle senkronize edilmeleri için Google'a gönderin.

Bağımlılıkları belirleme

SDK'yı kullanmak için derleme dosyanıza belirli bağımlılıkları eklemeniz gerekir. Derleme ortamınızın bağımlılıklarını görüntülemek için aşağıdaki bir sekmeyi tıklayın:

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'

Bağlayıcı yapılandırmanızı oluşturma

Her bağlayıcının, bağlayıcı tarafından kullanılan parametreleri (ör. deponuzun kimliği) içeren bir yapılandırma dosyası vardır. Parametreler, api.sourceId=1234567890abcdef gibi anahtar/değer çiftleri olarak tanımlanır.

Google Cloud Search SDK'sı, tüm bağlayıcılar tarafından kullanılan, Google tarafından sağlanan çeşitli yapılandırma parametrelerini içerir. Yapılandırma dosyanızda Google tarafından sağlanan aşağıdaki parametreleri beyan etmeniz gerekir:

  • İçerik bağlayıcıları için deponuzun konumunu ve depoya erişmek için gereken özel anahtarı tanımlayan api.sourceId ve api.serviceAccountPrivateKeyFile parametrelerini bildirmeniz gerekir.
  • Bu parametre harici kimlik kaynağınızın konumunu tanımladığından, kimlik bağlayıcısı için api.identitySourceId değerini bildirmeniz gerekir. Kullanıcıları senkronize ediyorsanız kuruluşunuzun Google Workspace hesabının benzersiz kimliği olarak api.customerId öğesini de beyan etmeniz gerekir.

Google tarafından sağlanan diğer parametrelerin varsayılan değerlerini geçersiz kılmak istemediğiniz sürece bunları yapılandırma dosyanızda belirtmeniz gerekmez. Google'ın sağladığı yapılandırma parametreleri hakkında, belirli kimliklerin ve anahtarların nasıl oluşturulacağı gibi ek bilgiler için Google'ın sağladığı yapılandırma parametreleri bölümüne bakın.

Yapılandırma dosyanızda kullanmak üzere kendi depoya özgü parametrelerinizi de tanımlayabilirsiniz.

Yapılandırma dosyasını bağlayıcıya iletme

Yapılandırma dosyasını bağlayıcınıza aktarmak için config sistem özelliğini ayarlayın. Bağlayıcıyı başlatırken -D bağımsız değişkenini kullanarak özelliği ayarlayabilirsiniz. Örneğin, aşağıdaki komut bağlayıcıyı MyConfig.properties yapılandırma dosyasıyla başlatır:

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

Bu bağımsız değişken eksikse SDK, connector-config.properties adlı varsayılan bir yapılandırma dosyasına erişmeye çalışır.

Şablon sınıfı kullanarak tam senkronizasyon kimliği bağlayıcısı oluşturma

Identity Connector SDK, kimlik deposundaki tüm kullanıcı ve grupları Google kimlikleriyle senkronize etmek için kullanabileceğiniz bir FullSyncIdentityConnector şablon sınıfı içerir. Bu bölümde, Google dışı bir kimlik deposundaki kullanıcılar ve grupların tam senkronizasyonunu gerçekleştirmek için FullSyncIdentityConnector şablonunun nasıl kullanılacağı açıklanmaktadır.

Belgelerin bu bölümü, IdentityConnecorSample.java örneğinden alınan kod snippet'leriyle ilgilidir. Bu örnek, iki CSV dosyasındaki kullanıcı ve grup kimliklerini okur ve bunları Google kimlikleriyle senkronize eder.

Bağlayıcının giriş noktasını uygulayın

Bağlayıcının giriş noktası, main() yöntemidir. Bu yöntemin birincil görevi, Application sınıfının bir örneğini oluşturmak ve bağlayıcıyı çalıştırmak için bu yöntemin start() yöntemini çağırmaktır.

application.start() çağrısından önce, FullSyncIdentityConnector şablonunu örneklendirmek için IdentityApplication.Builder sınıfını kullanın. FullSyncIdentityConnector, yöntemlerini uygulayacağınız bir Repository nesnesini kabul eder. Aşağıdaki kod snippet'i, main() yönteminin nasıl uygulanacağını gösterir:

IdentityConnectorSample.java
/**
 * 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();
}

Arka planda SDK, bağlayıcınızın main() yöntemi çağrısından sonra initConfig() yöntemini Application.build çağırır. initConfig() yöntemi aşağıdaki görevleri yerine getirir:

  1. Configuration'in başlatılmadığından emin olmak için Configuation.isInitialized() yöntemini çağırır.
  2. Google'ın sağladığı anahtar/değer çiftleriyle bir Configuration nesnesini başlatır. Her anahtar/değer çifti, Configuration nesnesi içindeki bir ConfigValue nesnesinde depolanır.

Repository arayüzünü uygulama

Repository nesnesinin tek amacı, depo kimliklerinin Google kimlikleri ile senkronize edilmesini sağlamaktır. Şablon kullanırken, kimlik bağlayıcısı oluşturmak için Repository arayüzünde yalnızca belirli yöntemleri geçersiz kılmanız gerekir. FullTraversalConnector için muhtemelen aşağıdaki yöntemleri geçersiz kılarsınız:

  • init() yöntemi. Herhangi bir kimlik deposu kurulumu ve başlatma işlemi gerçekleştirmek için "init()" yöntemini geçersiz kılın.

  • listUsers() yöntemi. Kimlik deposundaki tüm kullanıcıları Google kullanıcılarıyla senkronize etmek için listUsers() yöntemini geçersiz kılın.

  • listGroups() yöntemi. Kimlik deposundaki tüm grupları Google Gruplar ile senkronize etmek için listGroups() yöntemini geçersiz kılın.

  • (isteğe bağlı) close() yöntemi. Depo temizleme işlemi gerçekleştirmeniz gerekiyorsa close() yöntemini geçersiz kılın. Bu yöntem, bağlayıcının kapatılması sırasında bir kez çağrılır.

Özel yapılandırma parametrelerini alma

Bağlayıcı yapılandırmanızı işlemenin bir parçası olarak Configuration nesnesinden tüm özel parametreleri almanız gerekir. Bu görev genellikle Repository sınıfının init() yönteminde gerçekleştirilir.

Configuration sınıfı, bir yapılandırmadan farklı veri türlerini almak için çeşitli yöntemler sunar. Her yöntem bir ConfigValue nesnesi döndürür. Daha sonra gerçek değeri almak için ConfigValue nesnesinin get() yöntemini kullanırsınız. Aşağıdaki snippet'te, bir Configuration nesnesinden userMappingCsvPath ve groupMappingCsvPath değerlerinin nasıl alınacağı gösterilmektedir:

IdentityConnectorSample.java
/**
 * 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();
}

Birkaç değer içeren bir parametreyi almak ve ayrıştırmak için Configuration sınıfının tür ayrıştırıcılarından birini kullanarak verileri ayrı parçalara ayrıştırın. Eğitim bağlayıcısında yer alan aşağıdaki snippet, GitHub deposu adlarının listesini almak için getMultiValue yöntemini kullanır:

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

Tüm kullanıcılar için eşlemeyi alma

Geçersiz kıl: listUsers() ile kimlik deponuzdaki tüm kullanıcıların eşlemesini alabilirsiniz. listUsers() yöntemi, senkronize edilecek son kimliği temsil eden bir kontrol noktasını kabul eder. İşlem kesintiye uğrarsa senkronizasyonu devam ettirmek için kontrol noktası kullanılabilir. Deponuzdaki her kullanıcı için listUsers() yönteminde şu adımları uygularsınız:

  1. Google kimliği ve ilişkili harici kimlikten oluşan bir eşleme alın.
  2. Çifti, listUsers() yöntemi tarafından döndürülen bir iteratörde paketleyin.

Kullanıcı eşleme alma

Aşağıdaki kod snippet'i, bir CSV dosyasında depolanan kimlik eşlemelerinin nasıl alınacağını gösterir:

IdentityConnectorSample.java
/**
 * 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);
    }
  }
  // ...
}

Kullanıcı eşlemesini bir iteratörde paketleme

listUsers() yöntemi, Iterator (özellikle de bir CheckpointCloseableIterable) IdentityUser nesnesi döndürür. Bir iteratör oluşturmak ve döndürmek için CheckpointClosableIterableImpl.Builder sınıfını kullanabilirsiniz. Aşağıdaki kod snippet'i, her eşlemenin liste halinde nasıl paketleneceğini bu listeden iteratörün derlediğini gösterir:

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

Grup al

Kimlik deponuzdan tüm grupları ve bu grupların üyelerini almak için listGroups() değerini geçersiz kılın. listGroups() yöntemi, senkronize edilecek son kimliği temsil eden bir kontrol noktası kabul eder. İşlemin kesintiye uğraması durumunda senkronizasyonu devam ettirmek için kontrol noktası kullanılabilir. Deponuzdaki her kullanıcı için listGroups() yönteminde şu adımları uygularsınız:

  1. Grubu ve üyelerini alın.
  2. Her grubu ve üyeleri listGroups() yönteminin döndürdüğü bir iteratörde paketleyin.

Grup kimliğini alma

Aşağıdaki kod snippet'i, bir CSV dosyasında depolanan grupların ve üyelerin nasıl alınacağını gösterir:

IdentityConnectorSample.java
/**
 * 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);
    }
  }
  // ...

}

Grubu ve üyeleri bir iteratörde paketle

listGroups() yöntemi, Iterator (özellikle de bir CheckpointCloseableIterable) IdentityGroup nesnesi döndürür. Bir iteratör oluşturmak ve döndürmek için CheckpointClosableIterableImpl.Builder sınıfını kullanabilirsiniz. Aşağıdaki kod snippet'i her bir grubun ve üyelerin bir liste halinde nasıl paketleneceğini ve bu listeden iteratörün nasıl oluşturulacağını gösterir:

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

Sonraki adımlar

Atabileceğiniz sonraki adımlardan bazıları şunlardır: