Secara default, Google Cloud Search hanya mengenali identitas Google yang disimpan di Google Cloud Directory (pengguna dan grup). Konektor identitas digunakan untuk menyinkronkan identitas perusahaan Anda dengan identitas Google yang digunakan oleh Google Cloud Search.
Google menyediakan opsi berikut untuk mengembangkan konektor identitas:
Identity Connector SDK. Opsi ini untuk developer yang memprogram dalam bahasa pemrograman Java. Identity Connector SDK adalah wrapper di sekitar REST API yang dapat Anda gunakan untuk membuat konektor dengan cepat. Untuk membuat konektor identitas menggunakan SDK, lihat bagian Membuat konektor identitas menggunakan Identity Connector SDK.
REST API dan library API tingkat rendah. Opsi ini untuk developer yang mungkin tidak membuat program di Java atau yang memiliki codebase yang lebih mengakomodasi REST API atau library. Untuk membuat konektor identitas menggunakan REST API, lihat Directory API: Akun Pengguna untuk mendapatkan informasi tentang pemetaan pengguna dan Dokumentasi Cloud Identity untuk mengetahui informasi tentang pemetaan grup.
Membuat konektor identitas menggunakan Identity Connector SDK
Konektor identitas standar melakukan tugas-tugas berikut:
- Mengonfigurasi konektor.
- Mengambil semua pengguna dari sistem identitas perusahaan Anda dan mengirimkannya ke Google untuk disinkronkan dengan identitas Google.
- Mengambil semua grup dari sistem identitas perusahaan Anda dan mengirimkannya ke Google untuk disinkronkan dengan identitas Google.
Menyiapkan dependensi
Anda harus menyertakan dependensi tertentu dalam file build untuk menggunakan SDK. Klik tab di bawah ini guna melihat dependensi untuk lingkungan build Anda:
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'
Buat konfigurasi konektor Anda
Setiap konektor memiliki file konfigurasi yang berisi parameter yang digunakan oleh konektor, seperti ID untuk repositori Anda. Parameter ditentukan sebagai
key-value pair, seperti
api.sourceId=1234567890abcdef
.
Google Cloud Search SDK berisi beberapa parameter konfigurasi yang disediakan Google yang digunakan oleh semua konektor. Anda harus mendeklarasikan parameter yang disediakan Google berikut ini dalam file konfigurasi Anda:
- Untuk konektor konten, Anda harus mendeklarasikan
api.sourceId
danapi.serviceAccountPrivateKeyFile
karena parameter ini mengidentifikasi lokasi repositori dan kunci pribadi Anda yang diperlukan untuk mengakses repositori.
- Untuk konektor identitas, Anda harus mendeklarasikan
api.identitySourceId
karena parameter ini mengidentifikasi lokasi sumber identitas eksternal Anda. Jika menyinkronkan pengguna, Anda juga harus mendeklarasikanapi.customerId
sebagai ID unik untuk akun Google Workspace perusahaan Anda.
Kecuali jika Anda ingin mengganti nilai default parameter lain yang disediakan Google, Anda tidak perlu mendeklarasikannya dalam file konfigurasi Anda. Untuk informasi tambahan tentang parameter konfigurasi yang disediakan Google, seperti cara membuat ID dan kunci tertentu, lihat parameter konfigurasi yang disediakan Google.
Anda juga dapat menentukan parameter spesifik repositori Anda sendiri untuk digunakan dalam file konfigurasi Anda.
Teruskan file konfigurasi ke konektor
Tetapkan config
properti sistem untuk meneruskan file konfigurasi ke konektor Anda. Anda dapat menetapkan properti menggunakan argumen -D
saat memulai konektor. Misalnya, perintah berikut memulai konektor dengan file konfigurasi MyConfig.properties
:
java -classpath myconnector.jar;... -Dconfig=MyConfig.properties MyConnector
Jika argumen ini tidak ada, SDK akan mencoba mengakses file konfigurasi default bernama connector-config.properties
.
Membuat konektor identitas sinkronisasi lengkap menggunakan class template
Identity Connector SDK berisi class template FullSyncIdentityConnector
yang dapat Anda gunakan untuk menyinkronkan semua pengguna dan grup dari repositori identitas dengan identitas Google. Bagian ini menjelaskan cara menggunakan
template FullSyncIdentityConnector
untuk melakukan sinkronisasi penuh pengguna dan grup dari repositori
identitas non-Google.
Bagian dokumen ini mengacu ke cuplikan kode dari contoh IdentityConnecorSample.java
. Sampel ini membaca identitas pengguna dan grup dari dua file CSV dan menyinkronkannya dengan identitas Google.
Menerapkan titik entri konektor
Titik entri ke konektor adalah metode main()
. Tugas utama metode ini adalah membuat instance class
Application
dan memanggil metode
start()
untuk menjalankan konektor.
Sebelum memanggil
application.start()
,
gunakan
class IdentityApplication.Builder
untuk membuat instance
template FullSyncIdentityConnector
. FullSyncIdentityConnector
menerima objek
Repository
yang metodenya akan Anda implementasikan.
Cuplikan kode berikut menunjukkan cara mengimplementasikan metode main()
:
Di balik layar, SDK memanggil metode initConfig()
setelah metode main()
konektor Anda memanggil Application.build
.
Metode initConfig()
akan menjalankan tugas-tugas berikut:
- Memanggil metode
Configuation.isInitialized()
untuk memastikanConfiguration
belum diinisialisasi. - Menginisialisasi objek
Configuration
dengan key-value pair yang disediakan Google. Setiap key-value pair disimpan di objekConfigValue
dalam objekConfiguration
.
Mengimplementasikan antarmuka Repository
Satu-satunya tujuan objek Repository
adalah untuk melakukan
sinkronisasi identitas repositori ke identitas Google. Saat menggunakan template, Anda hanya perlu mengganti metode tertentu dalam antarmuka Repository
untuk membuat konektor identitas. Untuk
FullTraversalConnector
,
Anda mungkin akan mengganti metode berikut:
Metode
init()
. Untuk melakukan penyiapan dan inisialisasi repositori identitas, ganti dengan metode `init().Metode
listUsers()
. Untuk menyinkronkan semua pengguna di repositori identitas dengan pengguna Google, ganti metodelistUsers()
.Metode
listGroups()
. Untuk menyinkronkan semua grup di repositori identitas dengan Google Grup, ganti metodelistGroups()
.(opsional) Metode
close()
. Jika Anda perlu melakukan pembersihan repositori, ganti metodeclose()
. Metode ini dipanggil sekali selama penutupan konektor.
Mendapatkan parameter konfigurasi khusus
Sebagai bagian dari penanganan konfigurasi konektor, Anda harus mendapatkan parameter khusus dari objek Configuration
. Tugas ini biasanya dilakukan dalam
metode
init()
class
Repository
.
Class Configuration
memiliki beberapa metode untuk mendapatkan berbagai jenis data
dari konfigurasi. Setiap metode menampilkan
objek
ConfigValue
. Selanjutnya, Anda akan menggunakan metode get()
objek ConfigValue
untuk mengambil nilai sebenarnya.
Cuplikan berikut menunjukkan cara mengambil nilai userMappingCsvPath
dan
groupMappingCsvPath
dari objek Configuration
:
Untuk mendapatkan dan mengurai parameter yang berisi beberapa nilai, gunakan salah satu parser jenis class Configuration
untuk mengurai data menjadi potongan terpisah.
Cuplikan berikut, dari konektor tutorial, menggunakan metode getMultiValue
untuk mendapatkan daftar nama repositori GitHub:
Mendapatkan pemetaan untuk semua pengguna
Ganti
listUsers()
untuk mengambil pemetaan bagi semua pengguna dari repositori identitas Anda. Metode
listUsers()
menerima checkpoint yang mewakili identitas terakhir yang akan
disinkronkan. Checkpoint tersebut dapat digunakan untuk melanjutkan sinkronisasi jika prosesnya terganggu. Untuk setiap pengguna di repositori Anda, Anda akan melakukan langkah-langkah ini dalam
metode listUsers()
:
- Dapatkan pemetaan yang terdiri dari identitas Google dan identitas eksternal terkait.
- Gabungkan pasangan ke dalam iterator yang ditampilkan oleh metode
listUsers()
.
Mendapatkan pemetaan pengguna
Cuplikan kode berikut menunjukkan cara mengambil pemetaan identitas yang disimpan dalam file CSV:
Menggabungkan pemetaan pengguna menjadi iterator
Metode listUsers()
menampilkan Iterator
, khususnya
CheckpointCloseableIterable
,
dari
objek
IdentityUser
. Anda dapat menggunakan class CheckpointClosableIterableImpl.Builder
untuk membuat dan menampilkan iterator. Cuplikan kode berikut menunjukkan cara menggabungkan setiap pemetaan ke dalam daftar build asal iterator tersebut:
Mendapatkan grup
Ganti listGroups()
untuk mengambil semua grup dan anggotanya dari repositori identitas Anda. Metode listGroups()
menerima checkpoint yang mewakili identitas terakhir yang akan disinkronkan. Checkpoint tersebut dapat digunakan untuk melanjutkan sinkronisasi jika prosesnya terganggu. Untuk setiap pengguna di repositori Anda, Anda akan melakukan langkah-langkah ini dalam metode listGroups()
:
- Mendapatkan grup dan anggotanya.
- Gabungkan setiap kelompok dan anggotanya ke dalam iterator yang ditampilkan oleh
metode
listGroups()
.
Mendapatkan identitas grup
Cuplikan kode berikut menunjukkan cara mengambil grup dan anggota yang disimpan dalam file CSV:
Menggabungkan grup dan anggota ke dalam iterator
Metode listGroups()
menampilkan Iterator
, khususnya
CheckpointCloseableIterable
,
dari
objek
IdentityGroup
.
Anda dapat menggunakan class CheckpointClosableIterableImpl.Builder
untuk membuat dan menampilkan iterator. Cuplikan kode berikut menunjukkan cara menggabungkan setiap grup dan anggotanya ke dalam sebuah daftar dan membuat iterator dari daftar tersebut:
Langkah Berikutnya
Berikut beberapa langkah yang dapat Anda ambil:
- (opsional) Terapkan metode close() untuk melepaskan resource sebelum penghentian.
- (opsional) Buat konektor konten menggunakan Content Connector SDK.