DominoClient (HCL Domino API 1.0.27-SNAPSHOT API)

All Superinterfaces:

AutoCloseable, IAdaptable
```
public interface DominoClient
extends IAdaptable, AutoCloseable
```
Used as the entry point and thread management, borrowed from other Java APIs. Handles mapping to Domino server, protocol etc

Since:

0.5.0

Author:

t.b.d

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DominoClient.ECLType` Types of ECL settings
`static class`	`DominoClient.Encryption` Available encryption strengths for database creation
`static interface`	`DominoClient.IBreakHandler` Implement this method to send break signals to long running operations
`static interface`	`DominoClient.IProgressListener` Definition of function that will handle the progress bar signal. The progress signal handler displays a progress bar. The progress position will generally start at 0 and end at Range. The current progress supplied is either absolute (`DominoClient.IProgressListener.setPos(long)`) or a delta from the previous progress state (`DominoClient.IProgressListener.setDeltaPos(long)`). As the operation which is supplying progress information is performed, the range may change. If it does, an additional `DominoClient.IProgressListener.setRange(long)` will be signaled.
`static interface`	`DominoClient.LifecycleListener` Interface for subscribing to `DominoClient` lifecycle events.
`static interface`	`DominoClient.NotesReplicationStats` Replication statistics
`static class`	`DominoClient.OpenDatabase` Enum for options for opening the database, if the specified database is not currently available
`static interface`	`DominoClient.ReplicationStateListener` Listener to get replication progress

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addLifecycleListener(DominoClient.LifecycleListener listener)` Adds a listener to the client that will be called when certain lifecycle events occur.
`void`	`close()`
`void`	`compact(String pathname, Set<CompactMode> mode)` This function compresses a local database to remove the space left by deleting documents, freeing up disk space. Deletion stubs however, are left intact in the database.
`Database`	`createDatabase(String serverName, String filePath, boolean forceCreation, boolean initDesign, DominoClient.Encryption encryption)` Creates a new database on the target server with a given file path.
`Database`	`createDatabase(String serverName, String filePath, boolean forceCreation, boolean initDesign, DominoClient.Encryption encryption, DatabaseClass dbClass)` Creates a new database on the target server with a given file path.
`Database`	`createDatabaseFromTemplate(String sourceServerName, String sourceFilePath, String targetServerName, String targetFilePath, DominoClient.Encryption encryption)` Creates a new database from the specified template DB.
`Database`	`createDatabaseReplica(String sourceServerName, String sourceFilePath, String targetServerName, String targetFilePath, DominoClient.Encryption encryption)` Creates a new database replica, which is a new database with copied design/data documents and the same replica ID as the specified DB.
`DominoDateRange`	`createDateRange(TemporalAccessor start, TemporalAccessor end)` Creates a new `DominoDateRange` of two `Temporal` values.
`DominoDateTime`	`createDateTime(TemporalAccessor temporal)` Creates a `DominoDateTime` instance for the provided `TemporalAccessor` object. Some examples of supported `TemporalAccessor` value: `DominoDateTime` `Instant.now()` `LocalDate.now()` `LocalTime.now()` `ZoneId zone = ZoneId.systemDefault(); Instant now=Instant.now(); OffsetDateTime.ofInstant(now, zone);`
`DxlExporter`	`createDxlExporter()`
`DxlImporter`	`createDxlImporter()`
`Formula`	`createFormula(String formula)` Compiles a formula
`IDTable`	`createIDTable()` Creates a new, empty ID table.
`DominoUniversalNoteId`	`createUNID(String unidStr)` Creates a `DominoUniversalNoteId` for a given UNID string that can be used in `Document.replaceItemValue(String, Object)` to create an item of type `ItemDataType.TYPE_NOTEREF_LIST` to reference another `Document`, e.g.
`void`	`deleteDatabase(String serverName, String filePath)` Deletes the database at the specified path.
`AdministrationProcess`	`getAdministrationProcess(String serverName)` Creates a new AdministrationProcess object
`BuildVersionInfo`	`getBuildVersion(String server)` This function returns a `BuildVersionInfo` object which contains all types of information about the level of code running on the specified server. See `BuildVersionInfo` for more information.
`Calendaring`	`getCalendaring()` Method to access the calendaring and scheduling API of domino.
`DatabaseChangePathList`	`getDatabasePaths(String serverName, TemporalAccessor modifiedSince)` Retrieves a list of databases on the target server, optionally restricted to those modified since a given time.
`DominoRuntime`	`getDominoRuntime()` Obtains an accessor object for the Notes/Domino runtime configuration
`Ecl`	`getEcl(DominoClient.ECLType eclType, List<String> namesList)` Returns the `Ecl` for a names list (what the user is allowed to do)
`Ecl`	`getEcl(DominoClient.ECLType eclType, String userName)` Returns the `Ecl` for a username (what the user is allowed to do)
`String`	`getEffectiveUserName()` Returns the current Domino username code will run as
`UserNamesList`	`getEffectiveUserNamesList(String server)` Computes a list of name variants and groups of the current effective user on the specified server
`FreeBusy`	`getFreeBusy()` Method to access the free-busy schedules of a Domino server.
`String`	`getIDUserName()` Returns the current Domino ID name used to access Domino server / client
`IdVault`	`getIdVault()`
`Collection<String>`	`getKnownServers(String portName)` Retrieves a list of servers known to the current Domino environment.
`MessageQueues`	`getMessageQueues()` Method to access the message queues of the Domino API.
`MimeReader`	`getMimeReader()` Returns a utility class to read MIME content from a `Document`.
`MimeWriter`	`getMimeWriter()` Returns a utility class to write MIME content to a `Document`
`Person`	`getPerson(String username)` Returns a utility class that provides information about a user
`Replication`	`getReplication()` Returns replication utilities
`RichTextHTMLConverter`	`getRichTextHtmlConverter()` Returns a utility class to render a document or single item as HTML
`ServerAdmin`	`getServerAdmin()` Returns a utility class with server administration features
`default ThreadFactory`	`getThreadFactory()` Obtains a `ThreadFactory` implementation that produces Notes-initialized threads.
`boolean`	`isAdmin()` This will be used to restrict access to the admin APIs, managed against the Java application's permitted access
`boolean`	`isFullAccess()` Returns `true` if databases are supposed to be opened with full access (if the current user has sufficient rights on the accessed server)
`boolean`	`isOnServer()` Whether the code is running on a Domino server or client
`Database`	`openDatabase(String path)` Opens a database by path.
`Database`	`openDatabase(String path, Set<DominoClient.OpenDatabase> options)` Opens a database by path.
`Database`	`openDatabase(String serverName, String filePath)` Opens a database.
`Database`	`openDatabase(String serverName, String filePath, Set<DominoClient.OpenDatabase> options)` Opens a database with options if database is not accessible.
`DbDirectory`	`openDbDirectory()` Opens the db-directory to enumerate database (and other) files as well as subdirectories in the data-directory of a server (or locally)
`Optional<Database>`	`openMailDatabase()` Opens the mail database if the current user
`Optional<Database>`	`openMailDatabase(Set<DominoClient.OpenDatabase> options)` Opens the mail database if the current user
`UserDirectory`	`openUserDirectory(String serverName)` Opens the effective user directory for the provided server.
`ServerPingInfo`	`pingServer(String serverName, boolean retrieveLoadIndex, boolean retrieveClusterInfo)` Attempts to ping the named server, optionally retrieving additional information.
`DominoClient.NotesReplicationStats`	`replicateDbsWithServer(String serverName, Set<Database.ReplicateOption> options, List<String> fileList, int timeLimitMin, DominoClient.ReplicationStateListener progressListener)` This routine replicates Domino database files on the local system with a specified server. Either all common files can be replicated or a specified list of files can be replicated. Replication can be performed in either direction or both directions (push, pull, or both). Please note: Run this method inside `runInterruptable(Callable, IBreakHandler)` to be able to cancel the process and inside `runWithProgress(Callable, IProgressListener)` to get progress info.
`Optional<DominoException>`	`resolveErrorCode(int code)` Converts a Domino API error code into a `DominoException`.
`<T> FutureTask<T>`	`runAsync(Callable<T> callable)` Runs a block of code asynchronously in a background thread
`<T> FutureTask<T>`	`runAsync(ExecutorService service, Callable<T> callable)` Runs a block of code asynchronously in a background thread
`<T> T`	`runInterruptable(Callable<T> callable, DominoClient.IBreakHandler breakHandler)` The method registers a break signal handler for the execution time of the specified `Callable`.
`<T> T`	`runWithProgress(Callable<T> callable, DominoClient.IProgressListener progressHandler)` The method registers a progress signal handler for the execution time of the specified `Callable`.
`String`	`validateCredentials(String serverName, String userName, String password)` Attempts to validate the provider username and password credentials using the named server.
`String`	`validateCredentialsWithToken(String serverName, Object token)` Attempts to validate the provided credentials token with any registered providers.

Methods inherited from interface com.hcl.domino.data.IAdaptable
getAdapter

- Method Detail
  - getIDUserName
```
String getIDUserName()
```
    Returns the current Domino ID name used to access Domino server / client
    
    Returns:
    
    current ID's Domino username
  - getEffectiveUserName
```
String getEffectiveUserName()
```
    Returns the current Domino username code will run as
    
    Returns:
    
    current "running-as" Domino username
  - getEffectiveUserNamesList
```
UserNamesList getEffectiveUserNamesList(String server)
```
    Computes a list of name variants and groups of the current effective user on the specified server
    
    Parameters:
    
    server - server, use empty string for local environment
    
    Returns:
    
    user names list
  - isOnServer
```
boolean isOnServer()
```
    Whether the code is running on a Domino server or client
    
    Returns:
    
    true for server, false for client
  - openDbDirectory
```
DbDirectory openDbDirectory()
```
    Opens the db-directory to enumerate database (and other) files as well as subdirectories in the data-directory of a server (or locally)
    
    Returns:
    
    the directory
  - createDatabase
```
Database createDatabase(String serverName,
                        String filePath,
                        boolean forceCreation,
                        boolean initDesign,
                        DominoClient.Encryption encryption)
```
    Creates a new database on the target server with a given file path.
    
    Parameters:
    
    serverName - Domino server name to connect to, or an empty string for the current server
    
    filePath - the file path of the destination database
    
    forceCreation - to overwrite an existing database if applicable
    
    initDesign - true to run a DXL import on the new database which creates a view and basic structures like the DB icon and the design collection; if false, you need to run your own initialization since the created database cannot yet be opened in the Notes Client
    
    encryption - encryption level for new database
    
    Returns:
    
    a database object for the newly-created database
    
    Throws:
    
    IllegalArgumentException - if filePath is empty
    
    DominoException - if the database already exists and forceCreation is false
  - createDatabase
```
Database createDatabase(String serverName,
                        String filePath,
                        boolean forceCreation,
                        boolean initDesign,
                        DominoClient.Encryption encryption,
                        DatabaseClass dbClass)
```
    Creates a new database on the target server with a given file path.
    
    Parameters:
    
    serverName - Domino server name to connect to, or an empty string for the current server
    
    filePath - the file path of the destination database
    
    forceCreation - to overwrite an existing database if applicable
    
    initDesign - true to run a DXL import on the new database which creates a view and basic structures like the DB icon and the design collection; if false, you need to run your own initialization since the created database cannot yet be opened in the Notes Client
    
    encryption - encryption level for new database
    
    dbClass - type of database to create
    
    Returns:
    
    a database object for the newly-created database
    
    Throws:
    
    IllegalArgumentException - if filePath is empty
    
    DominoException - if the database already exists and forceCreation is false
  - createDatabaseFromTemplate
```
Database createDatabaseFromTemplate(String sourceServerName,
                                    String sourceFilePath,
                                    String targetServerName,
                                    String targetFilePath,
                                    DominoClient.Encryption encryption)
```
    Creates a new database from the specified template DB. Handles copying all design/data documents, setting the inherited template name and creating a ACL based on ACL entries of the template, e.g. a "[Group1]" entry of the template becomes a "Group1" entry in the created DB.
    
    Parameters:
    
    sourceServerName - server name of template database
    
    sourceFilePath - filepath of template database
    
    targetServerName - Domino server name to connect to, or an empty string for the current server
    
    targetFilePath - the file path of the destination database
    
    encryption - encryption level for new database
    
    Returns:
    
    a database object for the newly-created database
  - createDatabaseReplica
```
Database createDatabaseReplica(String sourceServerName,
                               String sourceFilePath,
                               String targetServerName,
                               String targetFilePath,
                               DominoClient.Encryption encryption)
```
    Creates a new database replica, which is a new database with copied design/data documents and the same replica ID as the specified DB.
    
    Parameters:
    
    sourceServerName - server name of database to create the replica for
    
    sourceFilePath - filepath of database to create the replica for
    
    targetServerName - Domino server name to connect to, or an empty string for the current server
    
    targetFilePath - the file path of the destination database
    
    encryption - encryption level for new database
    
    Returns:
    
    a database object for the newly-created replica database
  - openDatabase
```
Database openDatabase(String path)
```
    Opens a database by path. This path may be relative to the data directory of the current machine or may contain the name of a remote server. The database path may also be a replica ID.
    Some examples of legal database paths are:
    - foo/bar.nsf
    - 852584A8:00507284
    - ServerName/OrgName!!foo/bar.nsf
    - CN=ServerName/O=OrgName!!foo/bar.nsf
    - ServerName/OrgName!!852584A8:00507284
    Parameters:
    
    path - a path of the database
    
    Returns:
    
    database object for data access
  - openDatabase
```
Database openDatabase(String path,
                      Set<DominoClient.OpenDatabase> options)
```
    Opens a database by path. This path may be relative to the data directory of the current machine or may contain the name of a remote server. The database path may also be a replica ID.
    Some examples of legal database paths are:
    - foo/bar.nsf
    - 852584A8:00507284
    - ServerName/OrgName!!foo/bar.nsf
    - CN=ServerName/O=OrgName!!foo/bar.nsf
    - ServerName/OrgName!!852584A8:00507284
    Parameters:
    
    path - a path of the database
    
    options - set of options for if the database is not accessible
    
    Returns:
    
    Database database object for data access
  - openDatabase
```
Database openDatabase(String serverName,
                      String filePath)
```
    Opens a database. Data queries against a remote server will be slower
    
    Parameters:
    
    serverName - Domino server name to connect to, or an empty string for the current server
    
    filePath - path of the database relative to Domino's data directory or a replica ID
    
    Returns:
    
    Database database object for data access
  - openDatabase
```
Database openDatabase(String serverName,
                      String filePath,
                      Set<DominoClient.OpenDatabase> options)
```
    Opens a database with options if database is not accessible. Data queries against a remote server will be slower
    
    Parameters:
    
    serverName - Domino server name to connect to, empty string for current server
    
    filePath - path of the database relative to Domino's data directory or a replica ID
    
    options - set of options for if the database is not accessible
    
    Returns:
    
    Database database object for data access
  - openMailDatabase
```
Optional<Database> openMailDatabase()
```
    Opens the mail database if the current user
    
    Returns:
    
    an Optional describing the user's mail database, or an empty one if the user has no mail database or it cannot be found
  - openMailDatabase
```
Optional<Database> openMailDatabase(Set<DominoClient.OpenDatabase> options)
```
    Opens the mail database if the current user
    
    Parameters:
    
    options - set of options for if the database is not accessible
    
    Returns:
    
    an Optional describing the user's mail database, or an empty one if the user has no mail database or it cannot be found
  - deleteDatabase
```
void deleteDatabase(String serverName,
                    String filePath)
```
    Deletes the database at the specified path.
    
    Parameters:
    
    serverName - Domino server name to connect to, empty string for current server
    
    filePath - path of the database relative to Domino's data directory
  - isAdmin
```
boolean isAdmin()
```
    This will be used to restrict access to the admin APIs, managed against the Java application's permitted access
    
    Returns:
    
    whether or not the session can access admin APIs
  - isFullAccess
```
boolean isFullAccess()
```
    Returns true if databases are supposed to be opened with full access (if the current user has sufficient rights on the accessed server)
    
    Returns:
    
    true if full access
  - getDominoRuntime
```
DominoRuntime getDominoRuntime()
```
    Obtains an accessor object for the Notes/Domino runtime configuration
    
    Returns:
    
    a new DominoRuntime object
  - runAsync
```
<T> FutureTask<T> runAsync(Callable<T> callable)
```
    Runs a block of code asynchronously in a background thread
    
    Type Parameters:
    
    T - result type
    
    Parameters:
    
    callable - code to run
    
    Returns:
    
    FutureTask to get progress/result
  - runAsync
```
<T> FutureTask<T> runAsync(ExecutorService service,
                           Callable<T> callable)
```
    Runs a block of code asynchronously in a background thread
    
    Type Parameters:
    
    T - result type
    
    Parameters:
    
    service - ExecutorService to select the background thread
    
    callable - code to run
    
    Returns:
    
    FutureTask to get progress/result and cancel the operation
  - getThreadFactory
```
default ThreadFactory getThreadFactory()
```
    Obtains a ThreadFactory implementation that produces Notes-initialized threads.
    
    Returns:
    
    a Notes-aware ThreadFactory instance
  - runInterruptable
```
<T> T runInterruptable(Callable<T> callable,
                       DominoClient.IBreakHandler breakHandler)
```
    The method registers a break signal handler for the execution time of the specified Callable. The break signal handler can be used to send a break signal to Domino so that the current (probably long running) operation, e.g. a fulltext on a remote database, can be interrupted.
    
    Type Parameters:
    
    T - result type
    
    Parameters:
    
    callable - callable to execute
    
    breakHandler - break handler to interrupt the current operation
    
    Returns:
    
    optional result
  - runWithProgress
```
<T> T runWithProgress(Callable<T> callable,
                      DominoClient.IProgressListener progressHandler)
```
    The method registers a progress signal handler for the execution time of the specified Callable. The progress signal handler can be used to get notified about the progress of method execution, e.g. replication or copy operations.
    
    Type Parameters:
    
    T - result type
    
    Parameters:
    
    callable - callable to execute
    
    progressHandler - progress handler to get notified about progress changes
    
    Returns:
    
    optional result
  - createDateTime
```
DominoDateTime createDateTime(TemporalAccessor temporal)
```
    Creates a DominoDateTime instance for the provided TemporalAccessor object.
    Some examples of supported TemporalAccessor value:
    - DominoDateTime
    - Instant.now()
    - LocalDate.now()
    - LocalTime.now()
    - ZoneId zone = ZoneId.systemDefault(); Instant now=Instant.now(); OffsetDateTime.ofInstant(now, zone);
    Parameters:
    
    temporal - the temporal implementation to convert; must not be null
    
    Returns:
    
    a DominoDateTime instance that represents the value of temporal
    
    Throws:
    
    NullPointerException - if temporal is null
    
    IllegalArgumentException - if temporal contains a time zone that cannot be expressed in 15-minute increments
  - createDateRange
```
DominoDateRange createDateRange(TemporalAccessor start,
                                TemporalAccessor end)
```
    Creates a new DominoDateRange of two Temporal values. Some examples of supported Temporal value:
    - Instant.now()
    - LocalDate.now()
    - LocalTime.now()
    - ZoneId zone = ZoneId.systemDefault(); Instant now=Instant.now(); OffsetDateTime.ofInstant(now, zone);
    Parameters:
    
    start - start temporal
    
    end - end temporal
    
    Returns:
    
    range
  - createDxlImporter
```
DxlImporter createDxlImporter()
```
    Returns:
    
    a newly-created DXL importer
  - createDxlExporter
```
DxlExporter createDxlExporter()
```
    Returns:
    
    a newly-created DXL exporter
  - getFreeBusy
```
FreeBusy getFreeBusy()
```
    Method to access the free-busy schedules of a Domino server.
    
    Returns:
    
    instance of FreeBusy to access the free-busy schedules
  - getCalendaring
```
Calendaring getCalendaring()
```
    Method to access the calendaring and scheduling API of domino.
    
    Returns:
    
    instance of Calendaring
  - getMessageQueues
```
MessageQueues getMessageQueues()
```
    Method to access the message queues of the Domino API. Message queues provide IPC communication between all processes that access the Domino API.
    
    Returns:
    
    an instance of MessageQueues to querying and creation
  - getMimeReader
```
MimeReader getMimeReader()
```
    Returns a utility class to read MIME content from a Document.
    
    Returns:
    
    an instance of MimeReader to read MIME
  - getMimeWriter
```
MimeWriter getMimeWriter()
```
    Returns a utility class to write MIME content to a Document
    
    Returns:
    
    an instance of MimeWriter to write MIME
  - createIDTable
```
IDTable createIDTable()
```
    Creates a new, empty ID table.
    
    Returns:
    
    a newly-created ID table
  - createFormula
```
Formula createFormula(String formula)
               throws FormulaCompilationException
```
    Compiles a formula
    
    Parameters:
    
    formula - formula to compile
    
    Returns:
    
    compiled formula
    
    Throws:
    
    FormulaCompilationException - if formula has wrong syntax
  - createUNID
```
DominoUniversalNoteId createUNID(String unidStr)
```
    Creates a DominoUniversalNoteId for a given UNID string that can be used in Document.replaceItemValue(String, Object) to create an item of type ItemDataType.TYPE_NOTEREF_LIST to reference another Document, e.g. in a response hierarchy.
    
    Parameters:
    
    unidStr - UNID String
    
    Returns:
    
    Domino universal id
  - getRichTextHtmlConverter
```
RichTextHTMLConverter getRichTextHtmlConverter()
```
    Returns a utility class to render a document or single item as HTML
    
    Returns:
    
    converter
  - replicateDbsWithServer
```
DominoClient.NotesReplicationStats replicateDbsWithServer(String serverName,
                                                          Set<Database.ReplicateOption> options,
                                                          List<String> fileList,
                                                          int timeLimitMin,
                                                          DominoClient.ReplicationStateListener progressListener)
```
    This routine replicates Domino database files on the local system with a specified server.
    
    Either all common files can be replicated or a specified list of files can be replicated.
    
    Replication can be performed in either direction or both directions (push, pull, or both).
    
    Please note:
    Run this method inside runInterruptable(Callable, IBreakHandler) to be able to cancel the process and inside runWithProgress(Callable, IProgressListener) to get progress info.
    
    Parameters:
    
    serverName - destination server (either abbreviated or canonical format)
    
    options - replication options
    
    fileList - list of files to replicate, use server!!filepath format to specify databases on other servers
    
    timeLimitMin - If non-zero, number of minutes replication is allowed to execute before cancellation. If not specified, no limit is imposed
    
    progressListener - replication progress listener or null if not required
    
    Returns:
    
    replication stats
  - getServerAdmin
```
ServerAdmin getServerAdmin()
```
    Returns a utility class with server administration features
    
    Returns:
    
    admin utils
  - getIdVault
```
IdVault getIdVault()
```
  - getKnownServers
```
Collection<String> getKnownServers(String portName)
```
    Retrieves a list of servers known to the current Domino environment.
    
    Parameters:
    
    portName - the port name to query, or null for all ports
    
    Returns:
    
    a Collection of distinguished server names
  - getDatabasePaths
```
DatabaseChangePathList getDatabasePaths(String serverName,
                                        TemporalAccessor modifiedSince)
```
    Retrieves a list of databases on the target server, optionally restricted to those modified since a given time.
    
    Parameters:
    
    serverName - the server to query, or null for local
    
    modifiedSince - the start time of the query, or null for all databases
    
    Returns:
    
    a DatabaseChangePathList object containing the path list and new since time
  - getPerson
```
Person getPerson(String username)
```
    Returns a utility class that provides information about a user
    
    Parameters:
    
    username - username
    
    Returns:
    
    person class
  - validateCredentials
```
String validateCredentials(String serverName,
                           String userName,
                           String password)
                    throws NameNotFoundException,
                           AuthenticationException,
                           AuthenticationNotSupportedException
```
    Attempts to validate the provider username and password credentials using the named server.
    
    Parameters:
    
    serverName - the name of the server to validate against, or null to use the local runtime
    
    userName - a name for the user; may be a short name or other user ID
    
    password - the password to check for the user
    
    Returns:
    
    the user's canonical name in Notes format
    
    Throws:
    
    IllegalArgumentException - if userName is empty
    
    NameNotFoundException - if the provided name cannot be found in any directory
    
    AuthenticationException - if the provided password does not match the user's password
    
    AuthenticationNotSupportedException - if the user exists but does not have a specified password
  - validateCredentialsWithToken
```
String validateCredentialsWithToken(String serverName,
                                    Object token)
                             throws NameNotFoundException,
                                    AuthenticationException,
                                    AuthenticationNotSupportedException
```
    Attempts to validate the provided credentials token with any registered providers.
    
    Parameters:
    
    token - the token to use to authenticate. The class of the token depends on the available provider implementations
    
    serverName - the name of the server to contact
    
    Returns:
    
    the in-memory user ID
    
    Throws:
    
    IllegalArgumentException - when no provider can be found to handle token
    
    NameNotFoundException - if the implementation finds that the name cannot be found
    
    AuthenticationException - if the implementation finds that the credentials cannot be validated
    
    AuthenticationNotSupportedException - if the implementation finds that the user exists but cannot be validated with that token
    
    UnsupportedOperationException - if no implementation is found that can handle the provided token
    
    Since:
    
    1.0.19
  - getEcl
```
Ecl getEcl(DominoClient.ECLType eclType,
           String userName)
```
    Returns the Ecl for a username (what the user is allowed to do)
    
    Parameters:
    
    eclType - ECL type
    
    userName - username either abbreviated or canonical
    
    Returns:
    
    ECL
  - getEcl
```
Ecl getEcl(DominoClient.ECLType eclType,
           List<String> namesList)
```
    Returns the Ecl for a names list (what the user is allowed to do)
    
    Parameters:
    
    eclType - ECL type
    
    namesList - usernameslist, e.g. with the same content as @UserNamesList
    
    Returns:
    
    ECL
  - getReplication
```
Replication getReplication()
```
    Returns replication utilities
    
    Returns:
    
    replication
  - openUserDirectory
```
UserDirectory openUserDirectory(String serverName)
```
    Opens the effective user directory for the provided server. This allows lookup of user, server, and group names using the server's primary and secondary directories.
    
    Parameters:
    
    serverName - the name of the server to query, or null to use the local runtime
    
    Returns:
    
    the UserDirectory for the server
    
    Since:
    
    1.0.2
  - getAdministrationProcess
```
AdministrationProcess getAdministrationProcess(String serverName)
```
    Creates a new AdministrationProcess object
    
    Parameters:
    
    serverName - The name of the server containing the Administration Requests database (ADMIN4.NSF). An empty string means the local computer. The server must contain a replica of the Certification Log. You must have access privileges to the Domino Directory on the server for Administration Process requests that use it
    
    Returns:
    
    The newly created Administration Process object
  - close
```
void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - addLifecycleListener
```
void addLifecycleListener(DominoClient.LifecycleListener listener)
```
    Adds a listener to the client that will be called when certain lifecycle events occur.
    
    Parameters:
    
    listener - the listener to add
    
    Since:
    
    1.0.2
  - compact
```
void compact(String pathname,
             Set<CompactMode> mode)
```
    This function compresses a local database to remove the space left by deleting documents, freeing up disk space.
    Deletion stubs however, are left intact in the database.
    
    Parameters:
    
    pathname - path of local database
    
    mode - compact flags
  - pingServer
```
ServerPingInfo pingServer(String serverName,
                          boolean retrieveLoadIndex,
                          boolean retrieveClusterInfo)
```
    Attempts to ping the named server, optionally retrieving additional information.
    
    Parameters:
    
    serverName - the name of the server to ping
    
    retrieveLoadIndex - whether to query the server's availability index
    
    retrieveClusterInfo - whether to query the server's cluster name and peers
    
    Returns:
    
    a ServerPingInfo instance optionally containing load index and cluster information
    
    Throws:
    
    ServerNotFoundException - if the server cannot be resolved
    
    ServerUnavailableException - if the server is resolved but busy
    
    ServerRestrictedException - if the server is resolved but restricted
    
    Since:
    
    1.0.20
  - getBuildVersion
```
BuildVersionInfo getBuildVersion(String server)
```
    This function returns a BuildVersionInfo object which contains all types of information about the level of code running on the specified server.
    
    See BuildVersionInfo for more information.
    
    Parameters:
    
    server - to check the version for, e.g. "" for local environment
    
    Returns:
    
    version
  - resolveErrorCode
```
Optional<DominoException> resolveErrorCode(int code)
```
    Converts a Domino API error code into a DominoException.
    
    Parameters:
    
    code - error code
    
    Returns:
    
    an Optional describing a newly-created instance of DominoException or a subclass, an empty one if result is 0

Interface DominoClient

Nested Class Summary

Method Summary

Methods inherited from interface com.hcl.domino.data.IAdaptable

Method Detail

getIDUserName

getEffectiveUserName

getEffectiveUserNamesList

isOnServer

openDbDirectory

createDatabase

createDatabase

createDatabaseFromTemplate

createDatabaseReplica

openDatabase

openDatabase

openDatabase

openDatabase

openMailDatabase

openMailDatabase

deleteDatabase

isAdmin

isFullAccess

getDominoRuntime

runAsync

runAsync

getThreadFactory

runInterruptable

runWithProgress

createDateTime

createDateRange

createDxlImporter

createDxlExporter

getFreeBusy

getCalendaring

getMessageQueues

getMimeReader

getMimeWriter

createIDTable

createFormula

createUNID

getRichTextHtmlConverter

replicateDbsWithServer

getServerAdmin

getIdVault

getKnownServers

getDatabasePaths

getPerson

validateCredentials

validateCredentialsWithToken

getEcl

getEcl

getReplication

openUserDirectory

getAdministrationProcess

close

addLifecycleListener

compact

pingServer

getBuildVersion

resolveErrorCode