Per impostazione predefinita, Google Cloud Search riconosce solo le identità Google archiviate in Google Cloud Directory (utenti e gruppi). I connettori di identità vengono utilizzati per sincronizzare le identità aziendali con le identità Google utilizzate da Google Cloud Search.
Google offre le seguenti opzioni per lo sviluppo dei connettori di identità:
L'SDK Identity Connector. Questa opzione è pensata per gli sviluppatori che programmano il linguaggio di programmazione Java. L'SDK Identity Connector è un wrapper attorno all'API REST che consente di creare rapidamente i connettori. Per creare un connettore di identità utilizzando l'SDK, consulta Creare un connettore di identità utilizzando l'SDK Identity Connector.
Un'API REST di basso livello e librerie API. Queste opzioni sono per gli sviluppatori che potrebbero non programmare in Java o il cui codebase supporta meglio un'API REST o una libreria. Per creare un connettore di identità utilizzando l'API REST, consulta API Directory: account utente per informazioni sulla mappatura degli utenti e documentazione di Cloud Identity per informazioni sui gruppi di mappatura.
Crea un connettore di identità utilizzando l'SDK Identity Connector
Un tipico connettore di identità esegue le seguenti attività:
- Configura il connettore.
- Recupera tutti gli utenti dal tuo sistema di identità aziendale e inviali a Google per la sincronizzazione con le identità Google.
- Recupera tutti i gruppi dal tuo sistema di identità aziendale e inviali a Google per la sincronizzazione con le identità Google.
configura le dipendenze
Per utilizzare l'SDK, devi includere determinate dipendenze nel file di build. Fai clic su una scheda in basso per visualizzare le dipendenze per l'ambiente di build:
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'
Crea la configurazione del connettore
Ogni connettore ha un file di configurazione contenente i parametri utilizzati dal connettore, ad esempio l'ID del repository. I parametri sono definiti come coppie chiave-valore, ad esempio api.sourceId=1234567890abcdef
.
L'SDK Google Cloud Search contiene diversi parametri di configurazione forniti da Google utilizzati da tutti i connettori. Devi dichiarare i seguenti parametri forniti da Google nel file di configurazione:
- Per un connettore di contenuti, devi dichiarare
api.sourceId
eapi.serviceAccountPrivateKeyFile
poiché questi parametri identificano la posizione del repository e la chiave privata necessaria per accedere al repository.
- Per un connettore di identità, devi dichiarare
api.identitySourceId
poiché questo parametro identifica la località dell'origine identità esterna. Se esegui la sincronizzazione degli utenti, devi anche dichiarareapi.customerId
come ID univoco dell'account Google Workspace della tua azienda.
A meno che tu non voglia sostituire i valori predefiniti di altri parametri forniti da Google, non è necessario dichiararli nel file di configurazione. Per saperne di più sui parametri di configurazione forniti da Google, ad esempio su come generare determinati ID e chiavi, consulta la sezione Parametri di configurazione forniti da Google.
Puoi anche definire parametri specifici per il repository da utilizzare nel file di configurazione.
Passa il file di configurazione al connettore
Imposta la proprietà di sistema config
in modo da passare il file di configurazione al connettore. Puoi impostare la proprietà utilizzando l'argomento -D
quando avvii il connettore. Ad esempio, il comando seguente avvia il connettore
con il file di configurazione MyConfig.properties
:
java -classpath myconnector.jar;... -Dconfig=MyConfig.properties MyConnector
Se questo argomento non è presente, l'SDK tenta di accedere a un file di configurazione predefinito denominato connector-config.properties
.
Crea un connettore di identità per la sincronizzazione completo utilizzando una classe di modello
L'SDK Identity Connector contiene una classe di modelli FullSyncIdentityConnector
che puoi utilizzare per sincronizzare tutti gli utenti e i gruppi dal repository delle identità con le identità Google. Questa sezione spiega come utilizzare il modello FullSyncIdentityConnector
per eseguire una sincronizzazione completa di utenti e gruppi da un repository di identità non Google.
Questa sezione della documentazione fa riferimento agli snippet di codice dell'esempio IdentityConnecorSample.java
. Questo esempio legge le identità di utenti e gruppi da due file CSV e le sincronizza con le identità Google.
Implementare il punto di ingresso del connettore
Il punto di ingresso a un connettore è il metodo main()
. L'attività principale di questo metodo è creare un'istanza della classe Application
e richiamare il relativo metodo start()
per eseguire il connettore.
Prima di chiamare application.start()
, utilizza la classe IdentityApplication.Builder
per creare un'istanza del modello FullSyncIdentityConnector
. FullSyncIdentityConnector
accetta un oggetto
Repository
di cui implementerai i metodi.
Il seguente snippet di codice mostra come implementare il metodo main()
:
Dietro le quinte, l'SDK chiama il metodo
initConfig()
dopo le chiamate al metodo main()
del connettore
Application.build
.
Il metodo initConfig()
esegue le seguenti attività:
- Chiama il metodo
Configuation.isInitialized()
per garantire cheConfiguration
non sia stato inizializzato. - Inizializza un oggetto
Configuration
con le coppie chiave-valore fornite da Google. Ogni coppia chiave-valore è archiviata in un oggettoConfigValue
all'interno dell'oggettoConfiguration
.
Implementare l'interfaccia di Repository
L'unico scopo dell'oggetto Repository
è eseguire la
sincronizzazione delle identità dei repository con le identità Google. Quando utilizzi un modello, devi eseguire solo l'override di alcuni metodi nell'interfaccia di Repository
per creare un connettore di identità. Per FullTraversalConnector
, probabilmente eseguirai l'override dei seguenti metodi:
Il metodo
init()
. Per eseguire la configurazione e l'inizializzazione del repository di identità, sostituisci il metodo "init().Il metodo
listUsers()
. Per sincronizzare tutti gli utenti nel repository delle identità con gli utenti Google, sostituisci il metodolistUsers()
.Il metodo
listGroups()
. Per sincronizzare tutti i gruppi nel repository delle identità con Google Gruppi, esegui l'override del metodolistGroups()
.(Facoltativo) Il metodo
close()
. Se devi eseguire la pulizia del repository, sostituisci il metodoclose()
. Questo metodo viene chiamato una volta durante l'arresto del connettore.
Ottieni parametri di configurazione personalizzati
Nell'ambito della gestione della configurazione del connettore, dovrai ottenere
parametri personalizzati dall'oggetto
Configuration
. Questa attività viene generalmente eseguita con il metodo
init()
di una
classe
Repository
.
La classe Configuration
offre diversi metodi per ottenere tipi di dati diversi da una configurazione. Ogni metodo restituisce un oggetto ConfigValue
. Quindi, utilizzerai il metodo
get()
dell'oggetto ConfigValue
per recuperare il valore effettivo.
Lo snippet seguente mostra come recuperare il valore userMappingCsvPath
e groupMappingCsvPath
da un oggetto Configuration
:
Per ottenere e analizzare un parametro contenente diversi valori, utilizza uno dei parser dei tipi della classe Configuration
per analizzare i dati in blocchi discreti.
Lo snippet seguente, dal connettore del tutorial, utilizza il metodo getMultiValue
per ottenere un elenco di nomi di repository GitHub:
Ottieni il mapping per tutti gli utenti
Esegui l'override di listUsers()
per recuperare il mapping per tutti gli utenti dal tuo repository di identità. Il metodo listUsers()
accetta un checkpoint che rappresenta l'ultima identità da sincronizzare. Il checkpoint può essere utilizzato per riprendere la sincronizzazione in caso di interruzione del processo. Per ogni utente nel tuo repository, dovrai eseguire questi passaggi nel
metodo listUsers()
:
- Ottenere un mapping composto dall'identità Google e dall'identità esterna associata.
- Raggruppa la coppia in un iteratore restituito dal metodo
listUsers()
.
Recupera una mappatura utente
Il seguente snippet di codice mostra come recuperare le mappature delle identità archiviate in un file CSV:
pacchettizza la mappatura di un utente in un iteratore
Il metodo listUsers()
restituisce un valore Iterator
, in particolare CheckpointCloseableIterable
, di oggetti IdentityUser
. Puoi utilizzare la classe CheckpointClosableIterableImpl.Builder
per creare e restituire un iteratore. Il seguente snippet di codice mostra come pacchettizzare ogni mapping nella build dell'iteratore da quell'elenco:
Crea un gruppo
Esegui l'override di listGroups()
per recuperare tutti i gruppi e i relativi membri dal tuo repository di identità. Il metodo listGroups()
accetta un checkpoint che rappresenta l'ultima identità da sincronizzare. Il checkpoint può essere utilizzato per riprendere la sincronizzazione in caso di interruzione del processo. Per ogni utente nel tuo repository, eseguirai questi passaggi nel metodo listGroups()
:
- Recupera il gruppo e i suoi membri.
- Pacchettizza ogni gruppo e i membri in un iteratore restituito dal metodo
listGroups()
.
Recuperare l'identità del gruppo
Il seguente snippet di codice mostra come recuperare i gruppi e i membri archiviati in un file CSV:
Raggruppa il gruppo e i membri in un iteratore
Il metodo listGroups()
restituisce un valore Iterator
, in particolare CheckpointCloseableIterable
, di oggetti IdentityGroup
.
Puoi utilizzare la classe CheckpointClosableIterableImpl.Builder
per creare e restituire un iteratore. Il seguente snippet di codice mostra come pacchettizzare ogni gruppo e i membri in un elenco e creare l'iteratore da quell'elenco:
Passaggi successivi
Ecco alcune operazioni che puoi eseguire:
- (Facoltativo) Implementa il metodo close() per rilasciare eventuali risorse prima dell'arresto.
- (Facoltativo) Crea un connettore di contenuti utilizzando l'SDK del connettore di contenuti.