IdentityApplication
Stay organized with collections
Save and categorize content based on your preferences.
Main object and access point for the SDK.
Every connector begins execution by creating an instance of this class and calling its
start()
method. This starts processing, triggering the SDK to begin making connector
calls as configured in the configuration file.
Sample usage:
public static void main(String[] args) throws IOException, InterruptedException {
IdentityApplication application = new IdentityApplication.Builder(
new MyIdentityConnector(new MyIdentityRepository()), args).build();
application.start();
}
Optional configuration parameter(s):
schedule.incrementalTraversalIntervalSecs
- Specifies the interval between
scheduled incremental traversals (in seconds).
schedule.performTraversalOnStart
- Specifies whether to run the traversal
immediately at start up rather than waiting for the first interval to expire.
schedule.traversalIntervalSecs
- Specifies the interval between scheduled
traversals (in seconds).
connector.runOnce
- Specifies whether the connector should exit after a single
traversal.
Inherited Constant Summary
Inherited Method Summary
From class
com.google.common.util.concurrent.AbstractIdleService
final
void
|
addListener(Service.Listener arg0, Executor arg1)
|
final
void
|
awaitRunning()
|
final
void
|
awaitRunning(long arg0, TimeUnit arg1)
|
final
void
|
awaitTerminated(long arg0, TimeUnit arg1)
|
final
void
|
awaitTerminated()
|
final
Throwable
|
failureCause()
|
final
boolean
|
isRunning()
|
final
Service
|
startAsync()
|
final
Service.State
|
state()
|
final
Service
|
stopAsync()
|
String
|
toString()
|
From class
java.lang.Object
boolean
|
equals(Object arg0)
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
From interface
com.google.common.util.concurrent.Service
abstract
void
|
addListener(Service.Listener arg0, Executor arg1)
|
abstract
void
|
awaitRunning()
|
abstract
void
|
awaitRunning(long arg0, TimeUnit arg1)
|
abstract
void
|
awaitTerminated(long arg0, TimeUnit arg1)
|
abstract
void
|
awaitTerminated()
|
abstract
Throwable
|
failureCause()
|
abstract
boolean
|
isRunning()
|
abstract
Service
|
startAsync()
|
abstract
Service.State
|
state()
|
abstract
Service
|
stopAsync()
|
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,["# IdentityApplication\n\npublic class **IdentityApplication** extends [Application](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application)\\\u003cIdentityApplication.ApplicationHelper, [IdentityConnectorContext](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityConnectorContext)\\\u003e \nMain object and access point for the SDK.\n\nEvery connector begins execution by creating an instance of this class and calling its\n[start()](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application#start()) method. This starts processing, triggering the SDK to begin making connector\ncalls as configured in the configuration file.\n\nSample usage: \n\n public static void main(String[] args) throws IOException, InterruptedException {\n IdentityApplication application = new IdentityApplication.Builder(\n new MyIdentityConnector(new MyIdentityRepository()), args).build();\n application.start();\n } \n \nOptional configuration parameter(s):\n\n- `schedule.incrementalTraversalIntervalSecs` - Specifies the interval between scheduled incremental traversals (in seconds).\n- `schedule.performTraversalOnStart` - Specifies whether to run the traversal immediately at start up rather than waiting for the first interval to expire.\n- `schedule.traversalIntervalSecs` - Specifies the interval between scheduled traversals (in seconds).\n- `connector.runOnce` - Specifies whether the connector should exit after a single traversal.\n\n\u003cbr /\u003e\n\n### Nested Class Summary\n\n|-------|---|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| class | [IdentityApplication.Builder](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityApplication.Builder) || Builder for creating an instance of [IdentityApplication](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/identity/IdentityApplication) |\n\n### Inherited Constant Summary\n\nFrom class [com.google.enterprise.cloudsearch.sdk.Application](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application) \n\n|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|\n| String | [INCREMENTAL_INTERVAL_SECONDS](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application#INCREMENTAL_INTERVAL_SECONDS) | Configuration key for incremental traversal interval. |\n| String | [POLL_INTERVAL_SECONDS](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application#POLL_INTERVAL_SECONDS) | Configuration key for interval between poll requests. |\n| String | [RUN_ONCE](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application#RUN_ONCE) | Configuration key to specify if connector should exit after full traversal. |\n| String | [TRAVERSE_INTERVAL_SECONDS](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application#TRAVERSE_INTERVAL_SECONDS) | Configuration key for full traversal intervals. |\n| String | [TRAVERSE_ON_START](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application#TRAVERSE_ON_START) | Configuration key to indicate if traversal should be performed at start of the connector process. |\n\n### Inherited Method Summary\n\nFrom class [com.google.enterprise.cloudsearch.sdk.Application](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application) \n\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static void | [setLogger](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application#setLogger(java.util.logging.Logger))(Logger logger) Helper method to override default [Logger](/workspace/cloud-search/docs/reference/sdk/java/util/logging/Logger) used by [Application](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application) implementation. |\n| synchronized void | [shutdown](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application#shutdown(java.lang.String))(String event) Shutdown Connector in response to an event. |\n| void | [start](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Application#start())() Begins connector execution by initializing and starting the SDK. |\n\nFrom class com.google.common.util.concurrent.AbstractIdleService \n\n|---------------------|---------------------------------------------------|\n| final void | addListener(Service.Listener arg0, Executor arg1) |\n| final void | awaitRunning() |\n| final void | awaitRunning(long arg0, TimeUnit arg1) |\n| final void | awaitTerminated(long arg0, TimeUnit arg1) |\n| final void | awaitTerminated() |\n| final Throwable | failureCause() |\n| final boolean | isRunning() |\n| final Service | startAsync() |\n| final Service.State | state() |\n| final Service | stopAsync() |\n| String | toString() |\n\nFrom class java.lang.Object \n\n|------------------|---------------------------|\n| boolean | equals(Object arg0) |\n| final Class\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| String | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nFrom interface com.google.common.util.concurrent.Service \n\n|------------------------|---------------------------------------------------|\n| abstract void | addListener(Service.Listener arg0, Executor arg1) |\n| abstract void | awaitRunning() |\n| abstract void | awaitRunning(long arg0, TimeUnit arg1) |\n| abstract void | awaitTerminated(long arg0, TimeUnit arg1) |\n| abstract void | awaitTerminated() |\n| abstract Throwable | failureCause() |\n| abstract boolean | isRunning() |\n| abstract Service | startAsync() |\n| abstract Service.State | state() |\n| abstract Service | stopAsync() |"]]