Utwórz łącznik tożsamości

Domyślnie Google Cloud Search rozpoznaje tylko tożsamości Google w katalogu Google Cloud. Użyj oprogramowania sprzęgającego tożsamości, aby zsynchronizować tożsamości firmowe z tożsamościami Google, których używa Cloud Search.

Google udostępnia te opcje tworzenia oprogramowania sprzęgającego tożsamości:

• Pakiet SDK oprogramowania sprzęgającego tożsamości: najlepszy dla programistów w języku Java. Pakiet SDK to otoka interfejsu API typu REST, która umożliwia szybkie tworzenie oprogramowania sprzęgającego. Aby używać pakietu SDK, przeczytaj artykuł Tworzenie łącznika tożsamości za pomocą pakietu SDK łącznika tożsamości.

• Interfejs API typu REST niskiego poziomu i biblioteki interfejsu API: najlepsze dla programistów, którzy nie używają języka Java. Aby utworzyć łącznik tożsamości za pomocą interfejsu API typu REST, przeczytaj artykuł Directory API: User Accounts (Interfejs Directory API: konta użytkowników) dotyczący mapowania użytkowników oraz dokumentację Google Cloud Identity dotyczącą mapowania grup.

Tworzenie łącznika tożsamości za pomocą pakietu SDK łącznika tożsamości

Typowy łącznik tożsamości wykonuje te zadania:

1. Konfiguruje oprogramowanie sprzęgające.
2. Pobiera użytkowników z systemu tożsamości i wysyła ich do Google.
3. Pobiera grupy z systemu tożsamości i wysyła je do Google.

Konfigurowanie zależności

Dołącz te zależności do pliku kompilacji.

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

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

Tworzenie konfiguracji oprogramowania sprzęgającego

Każde oprogramowanie sprzęgające używa pliku konfiguracyjnego do określania parametrów, takich jak identyfikator repozytorium. Zdefiniuj parametry jako klucz-wartość pary, takie jak api.sourceId=1234567890abcdef.

Pakiet Google Cloud Search SDK zawiera parametry dostarczone przez Google dla wszystkich oprogramowań sprzęgających. W pliku konfiguracyjnym musisz zadeklarować te elementy:

• Łącznik treści: zadeklaruj api.sourceId i api.serviceAccountPrivateKeyFile. Określają one repozytorium i klucz prywatny wymagany do uzyskania dostępu.

• Łącznik tożsamości: zadeklaruj api.identitySourceId, aby zidentyfikować swoje zewnętrzne źródło tożsamości. W przypadku synchronizacji użytkowników zadeklaruj też api.customerId (unikalny identyfikator konta Google Workspace).

Zadeklaruj inne parametry dostarczone przez Google tylko wtedy, gdy chcesz zastąpić ich wartości domyślne. Więcej informacji o generowaniu identyfikatorów i kluczy znajdziesz w artykule Parametry dostarczone przez Google.

W pliku konfiguracyjnym możesz też zdefiniować parametry specyficzne dla repozytorium.

Przekazywanie pliku konfiguracyjnego do oprogramowania sprzęgającego

Aby przekazać plik konfiguracyjny, ustaw właściwość systemową config. Podczas uruchamiania oprogramowania sprzęgającego użyj argumentu -D. Na przykład:

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

Jeśli pominiesz ten argument, pakiet SDK spróbuje użyć pliku o nazwie connector-config.properties w katalogu lokalnym.

Tworzenie łącznika tożsamości z pełną synchronizacją za pomocą klasy szablonu

Pakiet SDK zawiera szablon FullSyncIdentityConnector, który umożliwia synchronizowanie wszystkich użytkowników i grup z repozytorium. W tej sekcji dowiesz się, jak go używać.

Ta sekcja odnosi się do kodu z przykładu IdentityConnectorSample.java, który odczytuje tożsamości z plików CSV.

Implementowanie punktu wejścia oprogramowania sprzęgającego

Punktem wejścia jest metoda main(). Tworzy ona instancję Application i wywołuje start() , aby uruchomić oprogramowanie sprzęgające.

Zanim wywołasz application.start(), użyj IdentityApplication.Builder aby utworzyć instancję szablonu FullSyncIdentityConnector.

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

Pakiet SDK wywołuje initConfig() po tym, jak metoda main() wywoła Application.build(). Metoda initConfig():

1. Sprawdza, czy Configuration nie jest jeszcze zainicjowana.
2. Inicjuje obiekt Configuration za pomocą par klucz-wartość dostarczonych przez Google.

Implementowanie interfejsu repozytorium

Obiekt Repository synchronizuje tożsamości repozytorium z tożsamościami Google. Gdy używasz szablonu, musisz zastąpić tylko niektóre metody. W przypadku FullSyncIdentityConnector zastąp te metody:

• init(): do konfiguracji i inicjowania.
• listUsers(): do synchronizowania wszystkich użytkowników.
• listGroups(): do synchronizowania wszystkich grup.
• (Opcjonalnie) close(): Do czyszczenia podczas zamykania.

Pobieranie niestandardowych parametrów konfiguracji

Pobierz parametry niestandardowe z obiektu Configuration, zwykle w metodzie init(). Ten fragment kodu pokazuje, jak pobrać ścieżki CSV:

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

Aby pobrać i przeanalizować parametr zawierający kilka wartości, użyj jednego z analizatorów typów klasy Configuration, aby podzielić dane na osobne części. Ten fragment kodu z oprogramowania sprzęgającego samouczka używa metody getMultiValue do pobierania listy nazw repozytoriów GitHub:

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

Pobieranie mapowania wszystkich użytkowników

Zastąp listUsers(), aby pobrać mapowania użytkowników. Ta metoda akceptuje punkt kontrolny, aby wznowić synchronizację w przypadku przerwania. W przypadku każdego użytkownika:

1. Pobierz mapowanie między tożsamością Google a tożsamością zewnętrzną.
2. Spakuj parę do iteratora zwracanego przez listUsers().

Pobieranie mapowania użytkownika

Ten fragment kodu pokazuje, jak pobrać mapowania tożsamości z pliku CSV:

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

Pakowanie mapowania użytkownika do iteratora

Metoda listUsers() zwraca CheckpointCloseableIterable obiektów IdentityUser.

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

Pobieranie grupy

Zastąp listGroups(), aby pobrać grupy i ich członków. Ta metoda akceptuje punkt kontrolny. W przypadku każdej grupy:

1. Pobierz grupę i jej członków.
2. Spakuj je do iteratora zwracanego przez listGroups().

Pobieranie tożsamości grupy

Ten fragment kodu pokazuje, jak pobrać grupy i członków z pliku CSV:

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

}

Pakowanie grupy i członków do iteratora

Metoda listGroups() zwraca CheckpointCloseableIterable obiektów IdentityGroup.

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

Następne kroki

• (Opcjonalnie) Zaimplementuj close() aby zwolnić zasoby.
• (Opcjonalnie) Utwórz łącznik treści.