Help Manual

Active Directory Connectivity

Documentation for Active Directory drivers found within JDBC Driver Pack

Active Directory OnPremise

Building the JDBC URL

After installing the license, access the connection management page by executing the command java -jar kingswaysoft.jdbc.jar. Enter the necessary details, and the program will automatically generate the JDBC connection URL. Users can click Test Connection to test the generated URL, and Copy to Clipboard to copy the connection string for use within the application where the JDBC driver is being used.

Note: If the license is not installed, you can still use the connection manager to generate a JDBC URL; however, the 'Test Connection' feature will be disabled.

General Page

The General page of the Active Directory OnPremise Connection Manager allows you to specify the general settings of the connection:

connectionmanage

Authentication Methods for Active Directory OnPremise

Domain

The Domain field lets you specify the domain name of the directory to connect to. The domain name should be a fully qualified name.

User Name

The User Name field allows you to specify the user account that you want to use to connect to your Active Directory. Depending on how you want to manipulate your data, the user account needs to have proper privileges to do so.

Password

The Password field allows you to specify the password for the above user account in order to authenticate with Active Directory.

Container Path

The starting point in the Active Directory tree where a search operation begins.

Using the JDBC Driver

Explore detailed examples in this section that demonstrate the application of JDBC classes such as Connection, Statement, and ResultSet to effectively manage interactions with Active Directory OnPremise data. This section covers the use of regular statements and prepared statements for executing complex or frequently executed queries.

Executing Statements

Once you've connected from your code (see Connecting with DriverManager and Connecting with DataSource), you can execute SQL statements using the Statement class. Refer to the Executing Prepared Statements section for information on how to execute parameterized statements.

SELECT

Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data. To retrieve the results of a query, you would then call the getResultSet method of the Statement.

String sql = "SELECT * FROM user WHERE cn = 'Arielle.Ortiz'";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the inserted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "INSERT INTO user (cn, userPrincipalName, department) VALUES ('Jdbc.Test', '[email protected]', 'Sales')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

cn,errorcode,errormessage,processdata,haserrors
Jdbc.Test,null,null,[Attribute(name=objectClass, values={'user'}), Attribute(name=cn, values={'Jdbc.Test'}), Attribute(name=userPrincipalName, values={'[email protected]'}), Attribute(name=department, values={'Sales'})],false
String sql = "INSERT INTO group (_ContainerPath, cn, groupType, whenChanged) VALUES ('OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local', 'testGroupInsert', -2147483646, '1999-09-23T17:42:36Z')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

distinguishedName,errorcode,errormessage,processdata,haserrors
CN=testGroupInsert,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[Attribute(name=objectClass, values={'group'}), Attribute(name=cn, values={'testGroupInsert'}), Attribute(name=groupType, values={'-2147483646'}), Attribute(name=whenChanged, values={'19990923174236.0Z'})],false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the updated data's ID, exceptions raised during execution, and details of the affected data.

String sql = "UPDATE user SET department = 'departmentUpdated' WHERE distinguishedName = 'CN=Arielle.Ortiz,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

distinguishedName,errorcode,errormessage,processdata,haserrors
CN=Arielle.Ortiz,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[LDAPModification(type=replace, attr=department, values={'departmentUpdated'})],false
String sql = "UPDATE group SET description = 'testing' WHERE cn = 'TestGroup' AND _ContainerPath = 'OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

distinguishedName,errorcode,errormessage,processdata,haserrors
CN=TestGroup,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[LDAPModification(type=replace, attr=description, values={'testing'})],false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "DELETE FROM user WHERE distinguishedName = 'CN=Jdbc.Test1,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

distinguishedName,errorcode,errormessage,processdata,haserrors
CN=Jdbc.Test1,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,null,false
String sql = "DELETE FROM group WHERE _ContainerPath = 'OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local' AND cn = 'TestGroup'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

_ContainerPath,cn,errorcode,errormessage,processdata,haserrors
OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,TestGroup,null,null,null,false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the ID of upserted data, exceptions raised during execution, and the data affected by the upserting.

String sql = "UPSERT INTO user (distinguishedName, department, givenName) VALUES ('CN=gag15,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local', 'testDepartmentNotExistTest', 'testGivenNameNotExistTest') ON DUPLICATE KEY UPDATE UPSERTFIELDS = (distinguishedName)";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

distinguishedName,errorcode,errormessage,processdata,haserrors,isnew
CN=gag15,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[Attribute(name=objectClass, values={'user'}), Attribute(name=distinguishedName, values={'CN=gag15,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local'}), Attribute(name=department, values={'testDepartmentNotExistTest'}), Attribute(name=givenName, values={'testGivenNameNotExistTest'})],false,false
String sql = "UPSERT INTO group (_ContainerPath, cn, groupType) VALUES ('OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local', 'testGroupInsert', -2147483646) ON DUPLICATE KEY UPDATE UPSERTFIELDS = (cn)";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

distinguishedName,errorcode,errormessage,processdata,haserrors,isnew
CN=testGroupInsert,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[Attribute(name=objectClass, values={'group'}), Attribute(name=cn, values={'testGroupInsert'}), Attribute(name=groupType, values={'-2147483646'})],false,true

Executing Prepared Statements

Using a PreparedStatement can improve performance when you need to execute a SQL statement multiple times with different parameters. Unlike a Statement object, a PreparedStatement object is provided with a SQL statement when it is created, which can then be executed with different values each time. This special type of statement is derived from the more general class, Statement.

Below are the steps outlining how to execute a prepared statement:

  1. Create a PreparedStatement: Use the prepareStatement method of the Connection class to instantiate a PreparedStatement. Refer to Connecting with DriverManager or Connecting with DataSource for information related to establishing connections.
  2. Set Parameters: Declare parameters by calling the corresponding setter method of the PreparedStatement. Note: The parameter indices start at 1.
  3. Execute the Statement: Use the generic execute or executeUpdate method of the PreparedStatement.
  4. Retrieve Results: Call the getResultSet method of the Prepared Statement to obtain the query results, which will be returned as a ResultSet.
  5. Iterate Over the Result Set: Use the next method of the ResultSet to iterate through the results. To obtain column information, utilize the ResultSetMetaData class. Instantiate a ResultSetMetaData object by calling the getMetaData method of the ResultSet.

SELECT

Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the retrieved data.

String sql = "SELECT * FROM user WHERE cn = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "Arielle.Ortiz");
    ps.execute(query);
    while (ps.getResultSet().next()) {
        for (int i = 1; i <= ps.getResultSet().getMetaData().getColumnCount(); i++) {
            LOGGER.info(ps.getResultSet().getMetaData().getColumnLabel(i) + "="
            + ps.getResultSet().getString(i));
        }
    }
} catch (SQLException e) {
    LOGGER.error(e);
}

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of inserted data, exceptions raised during execution, and the data affected by the insertion.

String sql = "INSERT INTO user (cn, userPrincipalName, department) VALUES (?, ?, ?)";

try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "Jdbc.Test");
    ps.setString(2, "[email protected]");
    ps.setString(3, "Sales");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

cn,errorcode,errormessage,processdata,haserrors
Jdbc.Test,null,null,[Attribute(name=objectClass, values={'user'}), Attribute(name=cn, values={'Jdbc.Test'}), Attribute(name=userPrincipalName, values={'[email protected]'}), Attribute(name=department, values={'Sales'})],false
String sql = "INSERT INTO group (_ContainerPath, cn, groupType, whenChanged) VALUES (?, ?, ?, ?)";

try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local");
    ps.setString(2, "testGroupInsert");
    ps.setInt(3, "-2147483646");
    ps.setString(4, "1999-09-23T17:42:36Z");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

distinguishedName,errorcode,errormessage,processdata,haserrors
CN=testGroupInsert,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[Attribute(name=objectClass, values={'group'}), Attribute(name=cn, values={'testGroupInsert'}), Attribute(name=groupType, values={'-2147483646'}), Attribute(name=whenChanged, values={'19990923174236.0Z'})],false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of updated data, exceptions raised during execution, and the data affected by the update.

String sql = "UPDATE user SET department = ? WHERE distinguishedName = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "departmentUpdated");
    ps.setString(2, "CN=Arielle.Ortiz,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

distinguishedName,errorcode,errormessage,processdata,haserrors
CN=Arielle.Ortiz,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[LDAPModification(type=replace, attr=department, values={'departmentUpdated'})],false
String sql = "UPDATE group SET description = 'testing' WHERE cn = ? AND _ContainerPath = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "TestGroup");
    ps.setString(2, "OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

distinguishedName,errorcode,errormessage,processdata,haserrors
CN=TestGroup,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[LDAPModification(type=replace, attr=description, values={'testing'})],false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "DELETE FROM user WHERE distinguishedName = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "CN=Jdbc.Test1,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local");
    ps.executeUpdate();
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

distinguishedName,errorcode,errormessage,processdata,haserrors
CN=Jdbc.Test1,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,null,false
String sql = "DELETE FROM group WHERE _ContainerPath = ? AND cn = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local");
    ps.setString(2, "TestGroup");
    ps.executeUpdate();
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

_ContainerPath,cn,errorcode,errormessage,processdata,haserrors
OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,TestGroup,null,null,null,false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of upserted data, exceptions raised during execution, and the data affected by the upserting.

String sql = "UPSERT INTO user (distinguishedName, department, givenName) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE UPSERTFIELDS = (distinguishedName)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "CN=gag15,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local");
    ps.setString(2, "testDepartmentNotExistTest");
    ps.setString(3, "testGivenNameNotExistTest");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

distinguishedName,errorcode,errormessage,processdata,haserrors,isnew
CN=gag15,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[Attribute(name=objectClass, values={'user'}), Attribute(name=distinguishedName, values={'CN=gag15,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local'}), Attribute(name=department, values={'testDepartmentNotExistTest'}), Attribute(name=givenName, values={'testGivenNameNotExistTest'})],false,false
String sql = "UPSERT INTO group (_ContainerPath, cn, groupType) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE UPSERTFIELDS = (cn)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local");
    ps.setString(2, "testGroupInsert");
    ps.setInt(3, "-2147483646");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

distinguishedName,errorcode,errormessage,processdata,haserrors,isnew
CN=testGroupInsert,OU=Marketing,OU=BusinessTest,DC=KWSTEST,DC=local,null,null,[Attribute(name=objectClass, values={'group'}), Attribute(name=cn, values={'testGroupInsert'}), Attribute(name=groupType, values={'-2147483646'})],false,true

Metadata Discovery

This section provides examples on how to retrieve table and column metadata using the getTables and getColumns methods from the DatabaseMetaData interface. These are essential for discovering database structures.

Tables

The getTables method from the DatabaseMetaData interface can be used to retrieve a list of tables.

This method only retrieves tables that are not write-only.

To get a list of tables which include write-only tables, query the table [system.tables](/products/jdbc-driver-pack/help-manual/advancedfeatures#systemtables).

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getTables(null, null, null, null);
    LOGGER.info("\r\n" + rs.toString());
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS
null,null,group,Table,nullnull,null,organizationalUnit,Table,nullnull,null,system.columns,Table,nullnull,null,system.tables,Table,nullnull,null,user,Table,null

The getTables method returns the following metadata columns:

Column Name Data Type Description
TABLE_CAT String The catalog that contains the table.
TABLE_SCHEM String The schema of the table.
TABLE_NAME String The name of the table.
TABLE_TYPE String The type of the table (e.g., TABLE or VIEW).
REMARKS String An optional description of the table.

Columns

Use the getColumns method of the DatabaseMetaData interface to retrieve detailed information about database columns. To narrow the results to a specific table, specify the table name using the parameter table_name.

This method returns columns only for tables that are not write-only.

To get columns for tables which are write-only, query the table [system.columns](/products/jdbc-driver-pack/help-manual/advancedfeatures#systemcolumns).

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getColumns(null, null, "user", null);
    LOGGER.info(rs.toString());
} catch (SQLException e) {
    e.printStackTrace();
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,DATA_TYPE,TYPE_NAME,COLUMN_SIZE,BUFFER_LENGTH,DECIMAL_DIGITS,NUM_PREC_RADIX,NULLABLE,REMARKS,COLUMN_DEF,SQL_DATA_TYPE,SQL_DATETIME_SUB,CHAR_OCTET_LENGTH,ORDINAL_POSITION,IS_NULLABLE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,DTS_TYPE
null,null,user,accountExpires,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,user,badPasswordTime,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,user,badPwdCount,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,user,c,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,user,cn,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,user,co,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,user,codePage,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,user,company,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,user,countryCode,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,user,dSCorePropagationData,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
......

The getColumns method returns the following columns:

Column Name Data Type Description
TABLE_CAT String The database name.
TABLE_SCHEM String The table schema.
TABLE_NAME String The table name.
COLUMN_NAME String The column name.
DATA_TYPE Integer The data type represented by a constant value from java.sql.Types.
TYPE_NAME String The data type name used by the driver.
COLUMN_SIZE Integer The length in characters of the column or the numeric precision.
BUFFER_LENGTH Integer The buffer length.
DECIMAL_DIGITS Integer The column scale or number of digits to the right of the decimal point.
NUM_PREC_RADIX Integer The radix, or base.
NULLABLE Integer Whether the column can contain null as defined by the following JDBC DatabaseMetaData constants: columnNoNulls (0) or columnNullable (1).
REMARKS String The comment or note associated with the object.
COLUMN_DEF String The default value for the column.
SQL_DATA_TYPE Integer Reserved by the specification.
SQL_DATETIME_SUB Integer Reserved by the specification.
CHAR_OCTET_LENGTH Integer The maximum length of binary and character-based columns.
ORDINAL_POSITION Integer The position of the column in the table, starting at 1.
IS_NULLABLE String Whether a null value is allowed: YES or NO.
IS_AUTOINCREMENT String Whether the column value is assigned by Active Directory OnPremise in fixed increments.
IS_GENERATEDCOLUMN String Whether the column is generated: YES or NO.
DTS_TYPE String Object DTS attribute type.

Primary Keys

The getPrimaryKeys method in the DatabaseMetaData interface is used to retrieve metadata about primary keys for a given table in Active Directory OnPremise.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "user");
    LOGGER.info("\r\n" + resultSet.toString());
    Assertions.assertNotNull(resultSet);
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}

TABLE_NAME,PRIMARY_COLUMN_NAME
user,cn

The getPrimaryKeys method returns the following columns:

Column Name Data Type Description
TABLE_NAME String The name of the table that contains the primary key.
PRIMARY_COLUMN_NAME String The name of the column that serves as the primary key for the table.

Connection Settings

Connection Setting Type Default Value Description
ApiThrottleRate Integer 5 The maximum number of API requests a client can make to the server within a specific time period, defined in requests per second.
CacheExpirationTime Integer 30 Defines the expiration time for cache. A value of 0 disables caching.
ConcurrentWritingThreads Integer 1 The number of threads for executing operations in parallel. A value of 0 will disable multi threading.
ConnectionTimeout Integer 30 ConnectionTimeout is the maximum amount of time the program will wait to set up a connection to the Active Directory OnPremise API.
ConnectionType String "OnPremise" Determines the directory service environment to connect to.
ContainerPath String "" The starting point in the Active Directory tree where a search operation should begin. It defines the scope of users or computers you are querying.
Domain String "corp.kingswaysoft.com" The network address (hostname or IP) of the Active Directory server you need to connect to. This is the location of the directory service itself.
IgnoreCertificateErrors Boolean false Specifies whether to verify the certificate when connecting to Active Directory OnPremise. If no certificate verification is required, you can set this value to 'true'.
IgnoreError Boolean false Determines if the program continues executing SQL statements after encountering an error.
LogFileSize String "10485760" A string specifying the maximum size in bytes for a log file.
LogLevel String "INFO" The logging level for the JDBC driver.
LogPath String "./jdbcLogs" The directory where log files are stored.
MatchHandling String "writeOne" The strategy employed to address situations where multiple records meet the search criteria. Strategies are case-sensitive and include "writeAll" which will affect all matches, "writeOne" which will affect the first match, "ignoreAll" which will ignore all matches, and "raiseError" which will raise an error when multiple matches are found. By default, it is set to 'writeOne'.
OemKey String "" The OEM license key.
Password String "" The secret credential associated with the username, used to prove identity and gain access to the Active Directory.
ReadBatchSize Integer 100 ReadBatchSize is used to set how many records can be read from Active Directory in a single call. Active Directory has a maximum ReadBatchSize of 100.
ResultPath String "" The path where the execution result files are saved.
RetryOnIntermittentErrors Boolean true The RetryOnIntermittentErrors parameter indicates whether to retry the connection when it might occasionally fail due to temporary issues.
SaveResult Boolean false The SaveResult parameter indicates whether to save the execution results to a file.
ServiceName String "ActiveDirectory" The ServiceName refers to the name of the service API selected by the user.
ServiceTimeout Integer 120 The ServiceTimeout is the timeout to receive the full response from Active Directory API.
Suppress404NotFoundError Boolean true When set to true, if a query results in an HTTP 404 error, a result set will still be created. When set to false, an error is logged instead and no result set is created.
UserName String "" The unique identifier (Distinguished Name or User Principal Name) of the account used to bind (authenticate) to the Active Directory server to perform queries or actions.
WriteBatchSize Integer 1 WriteBatchSize is used to set how many records can be written to Active Directory in a single call. At this time, Active Directory does not support batch writing. As such, the value of this property should be kept at 1.