IdentityConnector
Stay organized with collections
Save and categorize content based on your preferences.
|
Known Indirect Subclasses
|
Interface for user-specific implementation details of the connector.
Implementations must be thread-safe. Implementations are discouraged from keeping any state
locally except perhaps soft-state such as a connection cache.
Public Methods
Initializes the connector with the current context.
Initialization is the ideal time to start any threads to do extra behind-the-scenes work.
The context allows access to other useful objects that can be used at any time such as
the IdentityService.
If an unrecoverable fatal error occurs during initialization, throw a StartupException to cancel the startup process. If a recoverable error occurs during
initialization, most Exception instances other than StartupException cause a
retry of initialization after a short delay.
Throws
| Exception |
if errors occur during connector initialization
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-18 UTC.
[null,null,["Last updated 2025-03-18 UTC."],[],[],null,["# IdentityConnector\n\npublic interface **IdentityConnector** implements [Connector](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Connector)\\\u003c[IdentityConnectorContext](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityConnectorContext)\\\u003e \n\n|---|---|---|\n| Known Indirect Subclasses [FullSyncIdentityConnector](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/FullSyncIdentityConnector) |--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------| | [FullSyncIdentityConnector](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/FullSyncIdentityConnector) | Connector implementation which periodically sync all users and groups with Google | |||\n\nInterface for user-specific implementation details of the connector.\n\nImplementations must be thread-safe. Implementations are discouraged from keeping any state\nlocally except perhaps soft-state such as a connection cache. \n\n### Public Method Summary\n\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract void | [init](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityConnector#init(com.google.enterprise.cloudsearch.sdk.identity.IdentityConnectorContext))([IdentityConnectorContext](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityConnectorContext) context) Initializes the connector with the current context. |\n\n### Inherited Method Summary\n\nFrom interface [com.google.enterprise.cloudsearch.sdk.Connector](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Connector) \n\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract void | [destroy](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Connector#destroy())() Shuts down and releases connector resources. |\n| String | [getDefaultId](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Connector#getDefaultId())() Gets the default connector ID. |\n| abstract void | [init](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Connector#init(T))([IdentityConnectorContext](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityConnectorContext) context) Initializes the connector with the current context. |\n| abstract void | [saveCheckpoint](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Connector#saveCheckpoint(boolean))(boolean isShutdown) Saves checkpoint information such as current traversal position or incremental change tokens. |\n| abstract void | [traverse](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Connector#traverse())() Implements a connector-specific traversal strategy. |\n\nPublic Methods\n--------------\n\n#### public abstract void\n**init**\n([IdentityConnectorContext](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityConnectorContext) context)\n\nInitializes the connector with the current context.\n\nInitialization is the ideal time to start any threads to do extra behind-the-scenes work.\nThe `context` allows access to other useful objects that can be used at any time such as\nthe [IdentityService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityService).\n\nIf an unrecoverable fatal error occurs during initialization, throw a [StartupException](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/StartupException) to cancel the startup process. If a recoverable error occurs during\ninitialization, most [Exception](/workspace/cloud-search/docs/reference/sdk/java/lang/Exception) instances other than [StartupException](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/StartupException) cause a\nretry of initialization after a short delay. \n\n##### Parameters\n\n| context | [IdentityConnectorContext](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityConnectorContext) instance for accessing framework objects |\n|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\n##### Throws\n\n| Exception | if errors occur during connector initialization |\n|-----------|-------------------------------------------------|"]]
