Theo mặc định, Google Cloud Search chỉ nhận dạng danh tính Google được lưu trữ trong Google Cloud Directory (người dùng và nhóm). Trình kết nối danh tính được dùng để đồng bộ hoá danh tính của doanh nghiệp với danh tính trên Google mà Google Cloud Search sử dụng.
Google cung cấp các lựa chọn sau đây để phát triển trình kết nối danh tính:
Identity Connector SDK. Lựa chọn này dành cho những nhà phát triển đang lập trình bằng ngôn ngữ lập trình Java. Identity Connector SDK là một trình bao bọc xung quanh REST API, cho phép bạn nhanh chóng tạo các trình kết nối. Để tạo một trình kết nối danh tính bằng SDK, hãy tham khảo phần Tạo trình kết nối danh tính bằng Identity Connector SDK.
Một API REST cấp thấp và các thư viện API. Đây là những lựa chọn dành cho những nhà phát triển có thể không lập trình bằng Java hoặc có cơ sở mã phù hợp hơn với một API REST hoặc một thư viện. Để tạo một trình kết nối danh tính bằng REST API, hãy tham khảo Directory API: User Accounts (API thư mục: Tài khoản người dùng) để biết thông tin về việc liên kết người dùng và Cloud Identity Documentation (Tài liệu về Cloud Identity) để biết thông tin về việc liên kết nhóm.
Tạo trình kết nối nhận dạng bằng Identity Connector SDK
Trình kết nối danh tính thông thường thực hiện các tác vụ sau:
- Định cấu hình trình kết nối.
- Truy xuất tất cả người dùng từ hệ thống nhận dạng doanh nghiệp của bạn và gửi họ đến Google để đồng bộ hoá với danh tính trên Google.
- Truy xuất tất cả các nhóm từ hệ thống nhận dạng doanh nghiệp của bạn và gửi chúng đến Google để đồng bộ hoá với danh tính trên Google.
Thiết lập phần phụ thuộc
Bạn phải thêm một số phần phụ thuộc vào tệp bản dựng để sử dụng SDK. Nhấp vào một thẻ bên dưới để xem các phần phụ thuộc cho môi trường tạo bản dựng:
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'
Tạo cấu hình trình kết nối
Mỗi trình kết nối đều có một tệp cấu hình chứa các tham số mà trình kết nối sử dụng, chẳng hạn như mã nhận dạng cho kho lưu trữ của bạn. Các tham số được xác định là các cặp khoá-giá trị, chẳng hạn như api.sourceId=1234567890abcdef
.
SDK Google Cloud Search chứa một số thông số cấu hình do Google cung cấp mà tất cả các trình kết nối đều sử dụng. Bạn phải khai báo các thông số sau do Google cung cấp trong tệp cấu hình:
- Đối với một trình kết nối nội dung, bạn phải khai báo
api.sourceId
vàapi.serviceAccountPrivateKeyFile
vì các tham số này xác định vị trí của kho lưu trữ và khoá riêng tư cần thiết để truy cập vào kho lưu trữ.
- Đối với trình kết nối danh tính, bạn phải khai báo
api.identitySourceId
vì tham số này xác định vị trí của nguồn danh tính bên ngoài. Nếu đang đồng bộ hoá người dùng, bạn cũng phải khai báoapi.customerId
làm mã nhận dạng duy nhất cho tài khoản Google Workspace của doanh nghiệp.
Trừ phi muốn ghi đè các giá trị mặc định của những tham số khác do Google cung cấp, bạn không cần khai báo các tham số đó trong tệp cấu hình. Để biết thêm thông tin về các thông số cấu hình do Google cung cấp, chẳng hạn như cách tạo một số mã nhận dạng và khoá nhất định, hãy tham khảo bài viết Các thông số cấu hình do Google cung cấp.
Bạn cũng có thể xác định các tham số dành riêng cho kho lưu trữ của riêng mình để sử dụng trong tệp cấu hình.
Truyền tệp cấu hình đến trình kết nối
Đặt thuộc tính hệ thống config
để truyền tệp cấu hình đến trình kết nối. Bạn có thể đặt thuộc tính bằng cách sử dụng đối số -D
khi khởi động trình kết nối. Ví dụ: lệnh sau đây sẽ khởi động trình kết nối bằng tệp cấu hình MyConfig.properties
:
java -classpath myconnector.jar;... -Dconfig=MyConfig.properties MyConnector
Nếu thiếu đối số này, SDK sẽ cố gắng truy cập vào một tệp cấu hình mặc định có tên là connector-config.properties
.
Tạo trình kết nối danh tính đồng bộ hoá đầy đủ bằng lớp mẫu
Identity Connector SDK chứa một lớp mẫu FullSyncIdentityConnector
mà bạn có thể dùng để đồng bộ hoá tất cả người dùng và nhóm từ kho lưu trữ danh tính với danh tính trên Google. Phần này giải thích cách sử dụng mẫu FullSyncIdentityConnector
để thực hiện quá trình đồng bộ hoá đầy đủ người dùng và nhóm từ một kho lưu trữ danh tính không phải của Google.
Phần này của tài liệu đề cập đến các đoạn mã trong mẫu IdentityConnecorSample.java
. Mẫu này đọc danh tính người dùng và nhóm từ hai tệp CSV, rồi đồng bộ hoá các danh tính đó với danh tính trên Google.
Triển khai điểm truy cập của trình kết nối
Điểm truy cập vào một trình kết nối là phương thức main()
. Nhiệm vụ chính của phương thức này là tạo một phiên bản của lớp Application
và gọi phương thức start()
để chạy trình kết nối.
Trước khi gọi application.start()
, hãy dùng lớp IdentityApplication.Builder
để tạo thực thể cho mẫu FullSyncIdentityConnector
. FullSyncIdentityConnector
chấp nhận một đối tượng Repository
mà bạn sẽ triển khai các phương thức.
Đoạn mã sau đây cho thấy cách triển khai phương thức main()
:
Ở chế độ nền, SDK sẽ gọi phương thức initConfig()
sau khi phương thức main()
của trình kết nối gọi Application.build
.
Phương thức initConfig()
thực hiện các tác vụ sau:
- Gọi phương thức
Configuation.isInitialized()
để đảm bảo rằngConfiguration
chưa được khởi chạy. - Khởi chạy một đối tượng
Configuration
bằng các cặp khoá-giá trị do Google cung cấp. Mỗi cặp khoá-giá trị được lưu trữ trong một đối tượngConfigValue
trong đối tượngConfiguration
.
Triển khai giao diện Repository
Mục đích duy nhất của đối tượng Repository
là thực hiện việc đồng bộ hoá danh tính kho lưu trữ với danh tính trên Google. Khi sử dụng một mẫu, bạn chỉ cần ghi đè một số phương thức nhất định trong giao diện Repository
để tạo một trình kết nối danh tính. Đối với FullTraversalConnector
, bạn có thể sẽ ghi đè các phương thức sau:
Phương thức
init()
. Để thực hiện mọi quá trình thiết lập và khởi chạy kho lưu trữ danh tính, hãy ghi đè phương thức init().Phương thức
listUsers()
. Để đồng bộ hoá tất cả người dùng trong kho lưu trữ danh tính với người dùng Google, hãy ghi đè phương thứclistUsers()
.Phương thức
listGroups()
. Để đồng bộ hoá tất cả các nhóm trong kho lưu trữ danh tính với Nhóm Google, hãy ghi đè phương thứclistGroups()
.(không bắt buộc) Phương thức
close()
. Nếu bạn cần dọn dẹp kho lưu trữ, hãy ghi đè phương thứcclose()
. Phương thức này được gọi một lần trong quá trình tắt trình kết nối.
Nhận các tham số cấu hình tuỳ chỉnh
Trong quá trình xử lý cấu hình của trình kết nối, bạn sẽ cần lấy mọi tham số tuỳ chỉnh từ đối tượng Configuration
. Tác vụ này thường được thực hiện trong phương thức init()
của lớp Repository
.
Lớp Configuration
có một số phương thức để lấy các loại dữ liệu khác nhau từ một cấu hình. Mỗi phương thức trả về một đối tượng ConfigValue
. Sau đó, bạn sẽ sử dụng phương thức get()
của đối tượng ConfigValue
để truy xuất giá trị thực tế.
Đoạn mã sau đây cho biết cách truy xuất giá trị userMappingCsvPath
và groupMappingCsvPath
từ một đối tượng Configuration
:
Để lấy và phân tích cú pháp một thông số chứa nhiều giá trị, hãy sử dụng một trong các trình phân tích cú pháp loại của lớp Configuration
để phân tích cú pháp dữ liệu thành các khối riêng biệt.
Đoạn mã sau đây (trong trình kết nối hướng dẫn) sử dụng phương thức getMultiValue
để lấy danh sách tên kho lưu trữ GitHub:
Lấy thông tin liên kết cho tất cả người dùng
Ghi đè listUsers()
để truy xuất thông tin liên kết cho tất cả người dùng từ kho lưu trữ danh tính của bạn. Phương thức listUsers()
chấp nhận một điểm kiểm tra đại diện cho danh tính cuối cùng cần được đồng bộ hoá. Bạn có thể dùng điểm kiểm tra để tiếp tục đồng bộ hoá nếu quá trình này bị gián đoạn. Đối với mỗi người dùng trong kho lưu trữ, bạn sẽ thực hiện các bước sau trong phương thức listUsers()
:
- Nhận một mối liên kết bao gồm danh tính trên Google và danh tính bên ngoài được liên kết.
- Đóng gói cặp này vào một trình lặp do phương thức
listUsers()
trả về.
Nhận thông tin ánh xạ người dùng
Đoạn mã sau đây minh hoạ cách truy xuất các mối liên kết danh tính được lưu trữ trong một tệp CSV:
Đóng gói một ánh xạ người dùng vào một trình lặp
Phương thức listUsers()
trả về một Iterator
, cụ thể là CheckpointCloseableIterable
của các đối tượng IdentityUser
. Bạn có thể sử dụng lớp CheckpointClosableIterableImpl.Builder
để tạo và trả về một trình lặp. Đoạn mã sau đây cho biết cách đóng gói từng hoạt động ánh xạ vào danh sách để tạo trình lặp từ danh sách đó:
Lấy một nhóm
Ghi đè listGroups()
để truy xuất tất cả các nhóm và thành viên của các nhóm đó từ kho lưu trữ danh tính của bạn. Phương thức listGroups()
chấp nhận một điểm kiểm tra đại diện cho danh tính cuối cùng cần được đồng bộ hoá. Bạn có thể dùng điểm kiểm tra để tiếp tục đồng bộ hoá nếu quá trình này bị gián đoạn. Đối với mỗi người dùng trong kho lưu trữ, bạn sẽ thực hiện các bước sau trong phương thức listGroups()
:
- Lấy nhóm và các thành viên của nhóm.
- Đóng gói từng nhóm và thành viên vào một trình lặp do phương thức
listGroups()
trả về.
Nhận danh tính của nhóm
Đoạn mã sau đây minh hoạ cách truy xuất các nhóm và thành viên được lưu trữ trong tệp CSV:
Đóng gói nhóm và các thành viên vào một trình lặp
Phương thức listGroups()
trả về một Iterator
, cụ thể là CheckpointCloseableIterable
của các đối tượng IdentityGroup
.
Bạn có thể sử dụng lớp CheckpointClosableIterableImpl.Builder
để tạo và trả về một trình lặp. Đoạn mã sau đây cho biết cách đóng gói từng nhóm và thành viên vào một danh sách, đồng thời tạo trình lặp từ danh sách đó:
Các bước tiếp theo
Sau đây là một số bước tiếp theo bạn có thể thực hiện:
- (không bắt buộc) Triển khai phương thức close() để giải phóng mọi tài nguyên trước khi tắt.
- (không bắt buộc) Tạo một trình kết nối nội dung bằng Content Connector SDK.