Google Cloud Search varsayılan olarak yalnızca Google Cloud Directory'de depolanan Google kimliklerini (kullanıcı 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'sı, REST API'yi sarmalayan ve hızlıca bağlayıcı oluşturmanıza olanak tanıyan bir sarmalayıcıdır. SDK'yı kullanarak kimlik bağlayıcı oluşturmak için Identity Connector SDK'sını kullanarak kimlik bağlayıcı oluşturma başlıklı makaleyi inceleyin.
Düşük düzey REST API ve API kitaplıkları. Bu seçenekler, Java'da programlama yapmayan veya kod tabanı REST API'yi ya da kitaplığı daha iyi barındıran geliştiriciler içindir. REST API'yi kullanarak kimlik bağlayıcı oluşturmak için kullanıcıları eşleme hakkında bilgi edinmek üzere Directory API: User Accounts (Dizin API'si: Kullanıcı Hesapları) bölümüne, grupları eşleme hakkında bilgi edinmek için ise Cloud Identity Dokümanları'na bakın.
Identity Connector SDK'sını kullanarak kimlik bağlayıcısı oluşturma
Tipik bir kimlik bağlayıcı aşağıdaki görevleri gerçekleştirir:
- Bağlayıcıyı yapılandırın.
- Tüm kullanıcıları kurumsal kimlik sisteminizden alın ve Google kimlikleriyle senkronize edilmeleri için Google'a gönderin.
- Tüm grupları kurumsal kimlik sisteminizden alın ve Google kimlikleriyle senkronize edilmeleri için Google'a gönderin.
Bağımlılıkları ayarlama
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 sekmelerden birini 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şturun
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 ve Google tarafından sağlanan çeşitli yapılandırma parametreleri içerir. Yapılandırma dosyanızda Google tarafından sağlanan aşağıdaki parametreleri belirtmeniz gerekir:
- İçerik bağlayıcı için
api.sourceId
veapi.serviceAccountPrivateKeyFile
parametrelerini belirtmeniz gerekir. Bu parametreler, deponuzun konumunu ve depoya erişmek için gereken özel anahtarı tanımlar.
- Kimlik bağlayıcısı için
api.identitySourceId
parametresini belirtmeniz gerekir. Bu parametre, harici kimlik kaynağınızın konumunu tanımlar. Kullanıcıları senkronize ediyorsanız kuruluşunuzun Google Workspace hesabı için benzersiz kimlik olarakapi.customerId
değerini de belirtmeniz gerekir.
Google tarafından sağlanan diğer parametrelerin varsayılan değerlerini geçersiz kılmak istemiyorsanız bunları yapılandırma dosyanızda belirtmeniz gerekmez. Google tarafından sağlanan yapılandırma parametreleri hakkında ek bilgi (ör. belirli kimliklerin ve anahtarların nasıl oluşturulacağı) için Google tarafından sağlanan yapılandırma parametreleri başlıklı makaleyi inceleyin.
Ayrıca, yapılandırma dosyanızda kullanmak üzere kendi depoya özgü parametrelerinizi de tanımlayabilirsiniz.
Yapılandırma dosyasını bağlayıcıya iletin
Yapılandırma dosyasını bağlayıcınıza iletmek için config
sistem özelliğini ayarlayın. Bağlantıyı başlatırken -D
bağımsız değişkenini kullanarak mülkü 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 kimlik bağlayıcısı oluşturma
Identity Connector SDK'sı, kimlik deposundaki tüm kullanıcıları 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ı ve grupların tam senkronizasyonunu gerçekleştirmek için FullSyncIdentityConnector
şablonunun nasıl kullanılacağı açıklanmaktadır.
Belgelerin bu bölümünde, IdentityConnecorSample.java
örneğindeki kod snippet'leri ele alınmaktadır. Bu örnek, iki CSV dosyasından kullanıcı ve grup kimliklerini okur ve bunları Google kimlikleriyle senkronize eder.
Bağlayıcının giriş noktasını uygulama
Bir 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 sınıfın start()
yöntemini çağırmaktır.
application.start()
işlevini çağırmadan önce, FullSyncIdentityConnector
şablonunu örneklemek için IdentityApplication.Builder
sınıfını kullanın. FullSyncIdentityConnector
, yöntemlerini uygulayacağınız bir Repository
nesnesi kabul eder.
Aşağıdaki kod snippet'inde, main()
yönteminin nasıl uygulanacağı gösterilmektedir:
Arka planda, SDK, bağlayıcınızın main()
yöntemi Application.build
çağrısından sonra initConfig()
yöntemini çağırır.
initConfig()
yöntemi aşağıdaki görevleri gerçekleştirir:
Configuration
sınıfının başlatılmadığından emin olmak içinConfiguation.isInitialized()
yöntemini çağırır.- Google tarafından sağlanan anahtar/değer çiftleriyle bir
Configuration
nesnesini başlatır. Her anahtar/değer çifti,Configuration
nesnesinde birConfigValue
nesnesine depolanır.
Repository
arayüzünü uygulama
Repository
nesnesinin tek amacı, depolama alanı kimliklerinin Google kimlikleriyle senkronizasyonunu gerçekleştirmektir. Şablon kullanırken kimlik bağlayıcı oluşturmak için yalnızca Repository
arayüzündeki 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. Kimlik deposu kurulumunu ve ilklendirmesini 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çinlistUsers()
yöntemini geçersiz kılın.listGroups()
yöntemi. Kimlik deposundaki tüm grupları Google Gruplar ile senkronize etmek içinlistGroups()
yöntemini geçersiz kılın.(isteğe bağlı)
close()
yöntemi. Depoyu temizlemeniz gerekiyorsaclose()
yöntemini geçersiz kılın. Bu yöntem, bağlayıcı kapatılırken bir kez çağrılır.
Özel yapılandırma parametrelerini alma
Bağlantıcınızın yapılandırmasını işleme kapsamında, tüm özel parametreleri Configuration
nesnesinden almanız gerekir. Bu görev genellikle bir Repository
sınıfının init()
yönteminde gerçekleştirilir.
Configuration
sınıfında, bir yapılandırmadan farklı veri türleri elde etmek için çeşitli yöntemler bulunur. Her yöntem bir ConfigValue
nesnesi döndürür. Ardından, 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:
Birden fazla değer içeren bir parametreyi almak ve ayrıştırmak için verileri ayrı parçalara ayırmak üzere Configuration
sınıfının tür ayrıştırıcılarından birini kullanın.
Eğitim bağlayıcısından alınan aşağıdaki snippet'te, GitHub depo adlarının listesini almak için getMultiValue
yöntemi kullanılır:
Tüm kullanıcılar için eşlemeyi alma
Kimlik deponuzdaki tüm kullanıcıların eşlemesini almak için listUsers()
seçeneğini geçersiz kılın. listUsers()
yöntemi, senkronize edilecek son kimliği temsil eden bir kontrol noktasını kabul eder. Bu kontrol noktası, süreç kesintiye uğrarsa senkronizasyonu devam ettirmek için kullanılabilir. Deponuzdaki her kullanıcı için listUsers()
yönteminde aşağıdaki adımları uygularsınız:
- Google kimliği ve ilişkili harici kimlikten oluşan bir eşleme alın.
- Çifti,
listUsers()
yöntemi tarafından döndürülen bir iteratöre paketleyin.
Kullanıcı eşlemesi alma
Aşağıdaki kod snippet'inde, CSV dosyasında depolanan kimlik eşlemelerinin nasıl alınacağı gösterilmektedir:
Kullanıcı eşlemesini bir iteratöre paketleme
listUsers()
yöntemi, IdentityUser
nesnelerinden oluşan bir Iterator
(özellikle CheckpointCloseableIterable
) 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'inde, her eşlemenin nasıl bir liste halinde paketleneceği ve bu listeden iteratör oluşturulacağı gösterilmektedir:
Grup alma
Tüm grupları ve üyelerini kimlik deponuzdan almak için listGroups()
değerini geçersiz kılın. listGroups()
yöntemi, senkronize edilecek son kimliği temsil eden bir kontrol noktasını kabul eder. Bu kontrol noktası, süreç kesintiye uğrarsa senkronizasyonu devam ettirmek için kullanılabilir. Deponuzdaki her kullanıcı için listGroups()
yönteminde aşağıdaki adımları uygularsınız:
- Grubu ve üyelerini alın.
- Her grubu ve üyeleri
listGroups()
yöntemi tarafından döndürülen bir iteratöre paketleyin.
Grup kimliğini alma
Aşağıdaki kod snippet'inde, CSV dosyasında depolanan grupların ve üyelerin nasıl alınacağı gösterilmektedir:
Grubu ve üyeleri bir iteratöre paketleme
listGroups()
yöntemi, IdentityGroup
nesnelerinden oluşan bir Iterator
(özellikle CheckpointCloseableIterable
) 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'inde, her grubun ve üyelerin bir listede nasıl paketleneceği ve iteratörünün bu listeden nasıl oluşturulacağı gösterilmektedir:
Sonraki Adımlar
Aşağıda, uygulayabileceğiniz birkaç adım verilmiştir:
- (isteğe bağlı) Kapatma işleminden önce tüm kaynakları serbest bırakmak için close() yöntemini uygulayın.
- (isteğe bağlı) Content Connector SDK'sını kullanarak içerik bağlayıcı oluşturun.