デフォルトでは、Google Cloud Search は Google Cloud Directory(ユーザーとグループ)に保存されている Google ID のみを認識します。ID コネクタは、企業の ID を Google Cloud Search で使用される Google ID と同期させるために使用します。
Google は、ID コネクタを開発するための以下のオプションを提供しています。
Identity Connector SDK。このオプションは、Java プログラミング言語でプログラミングしているデベロッパーを対象としています。Identity Connector SDK は、コネクタをすばやく作成するための REST API を簡単に使えるようにしたラッパーです。この SDK で ID コネクタを作成する場合は、Identity Connector SDK を使用して ID コネクタを作成するをご覧ください。
低レベル REST API と API ライブラリ。これらのオプションは、Java でプログラミングしていないデベロッパーや、コードベースが REST API やライブラリに問題なく対応できるデベロッパー向けです。REST API を使用して ID コネクタを作成するには、ユーザーのマッピングについては Directory API: ユーザー アカウントを、グループのマッピングについては Cloud Identity のドキュメントをご覧ください。
Identity Connector SDK を使用して ID コネクタを作成する
ID コネクタによって行われる標準的なタスクは、次のとおりです。
- コネクタを構成します。
- 企業 ID システムからすべてのユーザーを取得し、Google ID との同期のために Google に送信します。
- 企業 ID システムからすべてのグループを取得し、Google ID との同期のために Google に送信します。
依存関係を設定する
この SDK を使用するには、ビルドファイルに特定の依存関係を含める必要があります。下のタブをクリックすると、ビルド環境の依存関係が表示されます。
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'
コネクタ構成を作成する
コネクタごとに対応する構成ファイルが存在し、コネクタはそこに含まれているパラメータ(お客様のリポジトリの ID など)を使用します。パラメータは、api.sourceId=1234567890abcdef
などの Key-Value ペアとして定義されます。
Google Cloud Search SDK には、すべてのコネクタで使用される Google 提供構成パラメータが複数含まれています。以下の Google 提供パラメータをお客様の構成ファイル内で宣言してください。
- コンテンツ コネクタの場合は、
api.sourceId
とapi.serviceAccountPrivateKeyFile
を宣言する必要があります。これらのパラメータは、リポジトリの場所と、リポジトリへのアクセスに必要な秘密鍵を識別するためです。
- ID コネクタの場合、このパラメータは外部 ID ソースの場所を識別するため、
api.identitySourceId
を宣言する必要があります。ユーザーを同期する場合は、企業の Google Workspace アカウントの一意の ID としてapi.customerId
も宣言する必要があります。
Google 提供の他のパラメータのデフォルト値をオーバーライドする場合を除き、構成ファイルで宣言する必要はありません。特定の ID や鍵を生成する方法など、Google 提供の構成パラメータの詳細については、Google 提供の構成パラメータをご覧ください。
独自のリポジトリ パラメータを定義して、お客様の構成ファイル内で使用することもできます。
構成ファイルをコネクタに渡す
構成ファイルをコネクタに渡すようにシステム プロパティ config
を設定します。このプロパティは、コネクタの起動時に -D
引数を使用して設定できます。たとえば、次のコマンドは、MyConfig.properties
構成ファイルを使用してコネクタを起動します。
java -classpath myconnector.jar;... -Dconfig=MyConfig.properties MyConnector
この引数がない場合、SDK は connector-config.properties
という名前のデフォルト構成ファイルにアクセスしようとします。
テンプレート クラスを使用して完全同期 ID コネクタを作成する
Identity Connector SDK には、ID リポジトリのすべてのユーザーとグループを Google ID と同期するために使用できる FullSyncIdentityConnector
テンプレート クラスが含まれています。このセクションでは、FullSyncIdentityConnector
テンプレートを使用して、Google 以外の ID リポジトリからユーザーとグループを完全に同期する方法について説明します。
ドキュメントのこのセクションでは、IdentityConnecorSample.java
サンプルのコード スニペットについて説明します。このサンプルでは、2 つの CSV ファイルからユーザー ID とグループ ID を読み取り、Google ID と同期します。
コネクタのエントリ ポイントを実装する
コネクタのエントリ ポイントは main()
メソッドです。このメソッドの主なタスクは、Application
クラスのインスタンスを作成し、その start()
メソッドを呼び出してコネクタを実行することです。
application.start()
を呼び出す前に、IdentityApplication.Builder
クラスを使用して FullSyncIdentityConnector
テンプレートをインスタンス化します。FullSyncIdentityConnector
は、実装するメソッドを含む Repository
オブジェクトを受け入れます。次のコード スニペットは、main()
メソッドの実装方法を示しています。
コネクタの main()
メソッドが Application.build
を呼び出した後に、SDK はバックグラウンドで initConfig()
メソッドを呼び出します。initConfig()
メソッドは、次のタスクを実行します。
Configuation.isInitialized()
メソッドを呼び出して、Configuration
が初期化されていないことを確認します。- Google 提供の Key-Value ペアで
Configuration
オブジェクトを初期化します。各 Key-Value ペアは、Configuration
オブジェクト内のConfigValue
オブジェクトに格納されます。
Repository
インターフェースを実装する
Repository
オブジェクトの唯一の目的は、リポジトリ ID を Google ID と同期することです。テンプレートを使用すると、Repository
インターフェース内の特定のメソッドをオーバーライドするだけで、ID コネクタを作成できます。FullTraversalConnector
では、次のメソッドをオーバーライドできます。
init()
メソッド。ID リポジトリを設定して初期化するには、init() メソッドをオーバーライドします。listUsers()
メソッド。ID リポジトリ内のすべてのユーザーを Google ユーザーと同期するには、listUsers()
メソッドをオーバーライドします。listGroups()
メソッド。ID リポジトリ内のすべてのグループを Google グループと同期するには、listGroups()
メソッドをオーバーライドします。(省略可)
close()
メソッド。リポジトリのクリーンアップを行う必要がある場合は、close()
メソッドをオーバーライドします。このメソッドは、コネクタのシャットダウン時に 1 回呼び出されます。
カスタム構成パラメータを取得する
コネクタの構成を処理する際に、Configuration
オブジェクトからカスタム パラメータを取得する必要があります。このタスクは通常、Repository
クラスの init()
メソッドで実行します。
Configuration
クラスには、構成からさまざまなデータ型を取得するためのメソッドがいくつかあります。各メソッドは ConfigValue
オブジェクトを返します。次に、ConfigValue
オブジェクトの get()
メソッドを使用して、実際の値を取得します。次のスニペットは、Configuration
オブジェクトから userMappingCsvPath
と groupMappingCsvPath
の値を取得する方法を示しています。
複数の値を含むパラメータを取得して解析するには、Configuration
クラスのいずれかの型パーサーを使用してデータを個別のチャンクに解析します。次のチュートリアル コネクタのスニペットでは、getMultiValue
メソッドを使用して GitHub リポジトリ名のリストを取得しています。
すべてのユーザーのマッピングを取得する
listUsers()
をオーバーライドして、ID リポジトリからすべてのユーザーのマッピングを取得します。listUsers()
メソッドは、同期する最後の ID を表すチェックポイントを受け入れます。チェックポイントは、プロセスが中断された場合に同期を再開する目的で使用できます。リポジトリ内のユーザーごとに、listUsers()
メソッドで次の操作を行います。
- Google ID および関連する外部 ID からなるマッピングを取得します。
- ペアを
listUsers()
メソッドから返されるイテレータにパッケージ化します。
ユーザー マッピングを取得する
以下のコード スニペットは、CSV ファイルに保存されている ID マッピングを取得する方法を示しています。
イテレータにユーザー マッピングをパッケージ化する
listUsers()
メソッドは、Iterator
(具体的には IdentityUser
オブジェクトの CheckpointCloseableIterable
)を返します。CheckpointClosableIterableImpl.Builder
クラスを使用すると、イテレータを作成して返すことができます。以下のコード スニペットは、各マッピングをリストにパッケージ化して、そのリストからイテレータを構築する方法を示しています。
グループを取得する
listGroups()
をオーバーライドして、ID リポジトリからすべてのグループとそのメンバーを取得します。listGroups()
メソッドは、同期する最後の ID を表すチェックポイントを受け入れます。チェックポイントは、プロセスが中断された場合に同期を再開する目的で使用できます。リポジトリ内のユーザーごとに、listGroups()
メソッドで次の操作を行います。
- グループとそのメンバーを取得します。
- 各グループとメンバーを
listGroups()
メソッドから返されるイテレータにパッケージ化します。
グループ ID を取得する
以下のコード スニペットは、CSV ファイルに保存されているグループとメンバーを取得する方法を示しています。
グループとメンバーをイテレータにパッケージ化する
listGroups()
メソッドは、Iterator
(具体的には IdentityGroup
オブジェクトの CheckpointCloseableIterable
)を返します。CheckpointClosableIterableImpl.Builder
クラスを使用すると、イテレータを作成して返すことができます。次のコード スニペットは、各グループとメンバーをリストにパッケージ化し、そのリストからイテレータを構築する方法を示しています。
次のステップ
必要に応じて次の手順を行います。
- (オプション)シャットダウンの前にリソースをすべて解放する close() メソッドを実装する。
- (オプション)Content Connector SDK を使用してコンテンツ コネクタを作成する。