com.hcl.domino.keep.platform

Class KeepClient

java.lang.Object

com.hcl.domino.keep.platform.KeepClient

All Implemented Interfaces:

com.hcl.domino.data.IAdaptable, com.hcl.domino.DominoClient, java.lang.AutoCloseable

public class KeepClient
extends java.lang.Object
implements com.hcl.domino.DominoClient

Wrapper around the Resource warning with Domino client. This one closes when the containing session closes

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.domino.DominoClient

com.hcl.domino.DominoClient.ECLType, com.hcl.domino.DominoClient.Encryption, com.hcl.domino.DominoClient.IBreakHandler, com.hcl.domino.DominoClient.IProgressListener, com.hcl.domino.DominoClient.LifecycleListener, com.hcl.domino.DominoClient.NotesReplicationStats, com.hcl.domino.DominoClient.OpenDatabase, com.hcl.domino.DominoClient.ReplicationStateListener

Constructor Summary

Constructors

Constructor and Description
KeepClient(com.hcl.domino.DominoClient inner)

Method Summary

Modifier and Type	Method and Description
int	addAnotherRequest()
void	addLifecycleListener(com.hcl.domino.DominoClient.LifecycleListener listener)
int	clientCount()
void	close()
void	close(boolean force) Shut down the inner client
void	compact(java.lang.String pathname, java.util.Set<com.hcl.domino.data.CompactMode> mode)
com.hcl.domino.data.Database	createDatabase(java.lang.String serverName, java.lang.String filePath, boolean forceCreation, boolean initDesign, com.hcl.domino.DominoClient.Encryption encryption)
com.hcl.domino.data.Database	createDatabase(java.lang.String serverName, java.lang.String filePath, boolean forceCreation, boolean initDesign, com.hcl.domino.DominoClient.Encryption encryption, com.hcl.domino.data.DatabaseClass dbClass)
com.hcl.domino.data.Database	createDatabaseFromTemplate(java.lang.String sourceServerName, java.lang.String sourceFilePath, java.lang.String targetServerName, java.lang.String targetFilePath, com.hcl.domino.DominoClient.Encryption encryption)
com.hcl.domino.data.Database	createDatabaseReplica(java.lang.String sourceServerName, java.lang.String sourceFilePath, java.lang.String targetServerName, java.lang.String targetFilePath, com.hcl.domino.DominoClient.Encryption encryption)
com.hcl.domino.data.DominoDateRange	createDateRange(java.time.temporal.TemporalAccessor start, java.time.temporal.TemporalAccessor end)
com.hcl.domino.data.DominoDateTime	createDateTime(java.time.temporal.TemporalAccessor temporal)
com.hcl.domino.dxl.DxlExporter	createDxlExporter()
com.hcl.domino.dxl.DxlImporter	createDxlImporter()
com.hcl.domino.data.Formula	createFormula(java.lang.String formula)
com.hcl.domino.data.IDTable	createIDTable()
com.hcl.domino.data.DominoUniversalNoteId	createUNID(java.lang.String unidStr)
void	deleteDatabase(java.lang.String serverName, java.lang.String filePath)
void	finalClose() Actually closes it
<T> T	getAdapter(java.lang.Class<T> clazz)
com.hcl.domino.admin.AdministrationProcess	getAdministrationProcess(java.lang.String serverName)
com.hcl.domino.BuildVersionInfo	getBuildVersion(java.lang.String server)
com.hcl.domino.calendar.Calendaring	getCalendaring()
com.hcl.domino.data.DatabaseChangePathList	getDatabasePaths(java.lang.String serverName, java.time.temporal.TemporalAccessor modifiedSince)
com.hcl.domino.runtime.DominoRuntime	getDominoRuntime()
com.hcl.domino.security.Ecl	getEcl(com.hcl.domino.DominoClient.ECLType eclType, java.util.List<java.lang.String> namesList)
com.hcl.domino.security.Ecl	getEcl(com.hcl.domino.DominoClient.ECLType eclType, java.lang.String userName)
java.lang.String	getEffectiveUserName()
com.hcl.domino.UserNamesList	getEffectiveUserNamesList(java.lang.String server)
com.hcl.domino.freebusy.FreeBusy	getFreeBusy()
java.lang.String	getIDUserName()
com.hcl.domino.admin.idvault.IdVault	getIdVault()
java.util.Collection<java.lang.String>	getKnownServers(java.lang.String portName)
com.hcl.domino.mq.MessageQueues	getMessageQueues()
com.hcl.domino.mime.MimeReader	getMimeReader()
com.hcl.domino.mime.MimeWriter	getMimeWriter()
com.hcl.domino.person.Person	getPerson(java.lang.String username)
com.hcl.domino.admin.replication.Replication	getReplication()
com.hcl.domino.html.RichTextHTMLConverter	getRichTextHtmlConverter()
com.hcl.domino.admin.ServerAdmin	getServerAdmin()
java.util.concurrent.ThreadFactory	getThreadFactory()
boolean	isAdmin()
boolean	isFullAccess()
boolean	isOnServer()
com.hcl.domino.data.Database	openDatabase(java.lang.String path)
com.hcl.domino.data.Database	openDatabase(java.lang.String path, java.util.Set<com.hcl.domino.DominoClient.OpenDatabase> options)
com.hcl.domino.data.Database	openDatabase(java.lang.String serverName, java.lang.String filePath)
com.hcl.domino.data.Database	openDatabase(java.lang.String serverName, java.lang.String filePath, java.util.Set<com.hcl.domino.DominoClient.OpenDatabase> options)
com.hcl.domino.dbdirectory.DbDirectory	openDbDirectory()
java.util.Optional<com.hcl.domino.data.Database>	openMailDatabase()
java.util.Optional<com.hcl.domino.data.Database>	openMailDatabase(java.util.Set<com.hcl.domino.DominoClient.OpenDatabase> options)
com.hcl.domino.naming.UserDirectory	openUserDirectory(java.lang.String serverName)
com.hcl.domino.server.ServerPingInfo	pingServer(java.lang.String serverName, boolean retrieveLoadIndex, boolean retrieveClusterInfo)
com.hcl.domino.DominoClient.NotesReplicationStats	replicateDbsWithServer(java.lang.String serverName, java.util.Set<com.hcl.domino.data.Database.ReplicateOption> options, java.util.List<java.lang.String> fileList, int timeLimitMin, com.hcl.domino.DominoClient.ReplicationStateListener progressListener)
java.util.Optional<com.hcl.domino.DominoException>	resolveErrorCode(int code)
<T> java.util.concurrent.FutureTask<T>	runAsync(java.util.concurrent.Callable<T> callable)
<T> java.util.concurrent.FutureTask<T>	runAsync(java.util.concurrent.ExecutorService service, java.util.concurrent.Callable<T> callable)
<T> T	runInterruptable(java.util.concurrent.Callable<T> callable, com.hcl.domino.DominoClient.IBreakHandler breakHandler)
<T> T	runWithProgress(java.util.concurrent.Callable<T> callable, com.hcl.domino.DominoClient.IProgressListener progressHandler)
java.lang.String	validateCredentials(java.lang.String serverName, java.lang.String userName, java.lang.String password)
java.lang.String	validateCredentialsWithToken(java.lang.String serverName, java.lang.Object token)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeepClient

public KeepClient(com.hcl.domino.DominoClient inner)

Parameters:

inner - Real Domino client protected from premature closure

Method Detail

addAnotherRequest

public int addAnotherRequest()

Returns:

Total number of sessions

addLifecycleListener

public void addLifecycleListener(com.hcl.domino.DominoClient.LifecycleListener listener)

Specified by:

addLifecycleListener in interface com.hcl.domino.DominoClient

clientCount

public int clientCount()

Returns:

number of times the client has been requested

close

public void close()

Specified by:

close in interface com.hcl.domino.DominoClient

Specified by:

close in interface java.lang.AutoCloseable

close

public void close(boolean force)

Shut down the inner client

Parameters:

force - shutdown client if true

compact

public void compact(java.lang.String pathname,
                    java.util.Set<com.hcl.domino.data.CompactMode> mode)

Specified by:

compact in interface com.hcl.domino.DominoClient

createDatabase

public com.hcl.domino.data.Database createDatabase(java.lang.String serverName,
                                                   java.lang.String filePath,
                                                   boolean forceCreation,
                                                   boolean initDesign,
                                                   com.hcl.domino.DominoClient.Encryption encryption)

Specified by:

createDatabase in interface com.hcl.domino.DominoClient

createDatabase

public com.hcl.domino.data.Database createDatabase(java.lang.String serverName,
                                                   java.lang.String filePath,
                                                   boolean forceCreation,
                                                   boolean initDesign,
                                                   com.hcl.domino.DominoClient.Encryption encryption,
                                                   com.hcl.domino.data.DatabaseClass dbClass)

Specified by:

createDatabase in interface com.hcl.domino.DominoClient

createDatabaseFromTemplate

public com.hcl.domino.data.Database createDatabaseFromTemplate(java.lang.String sourceServerName,
                                                               java.lang.String sourceFilePath,
                                                               java.lang.String targetServerName,
                                                               java.lang.String targetFilePath,
                                                               com.hcl.domino.DominoClient.Encryption encryption)

Specified by:

createDatabaseFromTemplate in interface com.hcl.domino.DominoClient

createDatabaseReplica

public com.hcl.domino.data.Database createDatabaseReplica(java.lang.String sourceServerName,
                                                          java.lang.String sourceFilePath,
                                                          java.lang.String targetServerName,
                                                          java.lang.String targetFilePath,
                                                          com.hcl.domino.DominoClient.Encryption encryption)

Specified by:

createDatabaseReplica in interface com.hcl.domino.DominoClient

createDateRange

public com.hcl.domino.data.DominoDateRange createDateRange(java.time.temporal.TemporalAccessor start,
                                                           java.time.temporal.TemporalAccessor end)

Specified by:

createDateRange in interface com.hcl.domino.DominoClient

createDateTime

public com.hcl.domino.data.DominoDateTime createDateTime(java.time.temporal.TemporalAccessor temporal)

Specified by:

createDateTime in interface com.hcl.domino.DominoClient

createDxlExporter

public com.hcl.domino.dxl.DxlExporter createDxlExporter()

Specified by:

createDxlExporter in interface com.hcl.domino.DominoClient

createDxlImporter

public com.hcl.domino.dxl.DxlImporter createDxlImporter()

Specified by:

createDxlImporter in interface com.hcl.domino.DominoClient

createFormula

public com.hcl.domino.data.Formula createFormula(java.lang.String formula)
                                          throws com.hcl.domino.exception.FormulaCompilationException

Specified by:

createFormula in interface com.hcl.domino.DominoClient

Throws:

com.hcl.domino.exception.FormulaCompilationException

createIDTable

public com.hcl.domino.data.IDTable createIDTable()

Specified by:

createIDTable in interface com.hcl.domino.DominoClient

createUNID

public com.hcl.domino.data.DominoUniversalNoteId createUNID(java.lang.String unidStr)

Specified by:

createUNID in interface com.hcl.domino.DominoClient

deleteDatabase

public void deleteDatabase(java.lang.String serverName,
                           java.lang.String filePath)

Specified by:

deleteDatabase in interface com.hcl.domino.DominoClient

finalClose

public void finalClose()

Actually closes it

getAdapter

public <T> T getAdapter(java.lang.Class<T> clazz)

Specified by:

getAdapter in interface com.hcl.domino.data.IAdaptable

getAdministrationProcess

public com.hcl.domino.admin.AdministrationProcess getAdministrationProcess(java.lang.String serverName)

Specified by:

getAdministrationProcess in interface com.hcl.domino.DominoClient

getBuildVersion

public com.hcl.domino.BuildVersionInfo getBuildVersion(java.lang.String server)

Specified by:

getBuildVersion in interface com.hcl.domino.DominoClient

getCalendaring

public com.hcl.domino.calendar.Calendaring getCalendaring()

Specified by:

getCalendaring in interface com.hcl.domino.DominoClient

getDatabasePaths

public com.hcl.domino.data.DatabaseChangePathList getDatabasePaths(java.lang.String serverName,
                                                                   java.time.temporal.TemporalAccessor modifiedSince)

Specified by:

getDatabasePaths in interface com.hcl.domino.DominoClient

getDominoRuntime

public com.hcl.domino.runtime.DominoRuntime getDominoRuntime()

Specified by:

getDominoRuntime in interface com.hcl.domino.DominoClient

getEcl

public com.hcl.domino.security.Ecl getEcl(com.hcl.domino.DominoClient.ECLType eclType,
                                          java.util.List<java.lang.String> namesList)

Specified by:

getEcl in interface com.hcl.domino.DominoClient

getEcl

public com.hcl.domino.security.Ecl getEcl(com.hcl.domino.DominoClient.ECLType eclType,
                                          java.lang.String userName)

Specified by:

getEcl in interface com.hcl.domino.DominoClient

getEffectiveUserName

public java.lang.String getEffectiveUserName()

Specified by:

getEffectiveUserName in interface com.hcl.domino.DominoClient

getEffectiveUserNamesList

public com.hcl.domino.UserNamesList getEffectiveUserNamesList(java.lang.String server)

Specified by:

getEffectiveUserNamesList in interface com.hcl.domino.DominoClient

getFreeBusy

public com.hcl.domino.freebusy.FreeBusy getFreeBusy()

Specified by:

getFreeBusy in interface com.hcl.domino.DominoClient

getIDUserName

public java.lang.String getIDUserName()

Specified by:

getIDUserName in interface com.hcl.domino.DominoClient

getIdVault

public com.hcl.domino.admin.idvault.IdVault getIdVault()

Specified by:

getIdVault in interface com.hcl.domino.DominoClient

getKnownServers

public java.util.Collection<java.lang.String> getKnownServers(java.lang.String portName)

Specified by:

getKnownServers in interface com.hcl.domino.DominoClient

getMessageQueues

public com.hcl.domino.mq.MessageQueues getMessageQueues()

Specified by:

getMessageQueues in interface com.hcl.domino.DominoClient

getMimeReader

public com.hcl.domino.mime.MimeReader getMimeReader()

Specified by:

getMimeReader in interface com.hcl.domino.DominoClient

getMimeWriter

public com.hcl.domino.mime.MimeWriter getMimeWriter()

Specified by:

getMimeWriter in interface com.hcl.domino.DominoClient

getPerson

public com.hcl.domino.person.Person getPerson(java.lang.String username)

Specified by:

getPerson in interface com.hcl.domino.DominoClient

getReplication

public com.hcl.domino.admin.replication.Replication getReplication()

Specified by:

getReplication in interface com.hcl.domino.DominoClient

getRichTextHtmlConverter

public com.hcl.domino.html.RichTextHTMLConverter getRichTextHtmlConverter()

Specified by:

getRichTextHtmlConverter in interface com.hcl.domino.DominoClient

getServerAdmin

public com.hcl.domino.admin.ServerAdmin getServerAdmin()

Specified by:

getServerAdmin in interface com.hcl.domino.DominoClient

getThreadFactory

public java.util.concurrent.ThreadFactory getThreadFactory()

Specified by:

getThreadFactory in interface com.hcl.domino.DominoClient

isAdmin

public boolean isAdmin()

Specified by:

isAdmin in interface com.hcl.domino.DominoClient

isFullAccess

public boolean isFullAccess()

Specified by:

isFullAccess in interface com.hcl.domino.DominoClient

isOnServer

public boolean isOnServer()

Specified by:

isOnServer in interface com.hcl.domino.DominoClient

openDatabase

public com.hcl.domino.data.Database openDatabase(java.lang.String path)

Specified by:

openDatabase in interface com.hcl.domino.DominoClient

openDatabase

public com.hcl.domino.data.Database openDatabase(java.lang.String path,
                                                 java.util.Set<com.hcl.domino.DominoClient.OpenDatabase> options)

Specified by:

openDatabase in interface com.hcl.domino.DominoClient

openDatabase

public com.hcl.domino.data.Database openDatabase(java.lang.String serverName,
                                                 java.lang.String filePath)

Specified by:

openDatabase in interface com.hcl.domino.DominoClient

openDatabase

public com.hcl.domino.data.Database openDatabase(java.lang.String serverName,
                                                 java.lang.String filePath,
                                                 java.util.Set<com.hcl.domino.DominoClient.OpenDatabase> options)

Specified by:

openDatabase in interface com.hcl.domino.DominoClient

openDbDirectory

public com.hcl.domino.dbdirectory.DbDirectory openDbDirectory()

Specified by:

openDbDirectory in interface com.hcl.domino.DominoClient

openMailDatabase

public java.util.Optional<com.hcl.domino.data.Database> openMailDatabase()

Specified by:

openMailDatabase in interface com.hcl.domino.DominoClient

openMailDatabase

public java.util.Optional<com.hcl.domino.data.Database> openMailDatabase(java.util.Set<com.hcl.domino.DominoClient.OpenDatabase> options)

Specified by:

openMailDatabase in interface com.hcl.domino.DominoClient

openUserDirectory

public com.hcl.domino.naming.UserDirectory openUserDirectory(java.lang.String serverName)

Specified by:

openUserDirectory in interface com.hcl.domino.DominoClient

pingServer

public com.hcl.domino.server.ServerPingInfo pingServer(java.lang.String serverName,
                                                       boolean retrieveLoadIndex,
                                                       boolean retrieveClusterInfo)

Specified by:

pingServer in interface com.hcl.domino.DominoClient

replicateDbsWithServer

public com.hcl.domino.DominoClient.NotesReplicationStats replicateDbsWithServer(java.lang.String serverName,
                                                                                java.util.Set<com.hcl.domino.data.Database.ReplicateOption> options,
                                                                                java.util.List<java.lang.String> fileList,
                                                                                int timeLimitMin,
                                                                                com.hcl.domino.DominoClient.ReplicationStateListener progressListener)

Specified by:

replicateDbsWithServer in interface com.hcl.domino.DominoClient

resolveErrorCode

public java.util.Optional<com.hcl.domino.DominoException> resolveErrorCode(int code)

Specified by:

resolveErrorCode in interface com.hcl.domino.DominoClient

runAsync

public <T> java.util.concurrent.FutureTask<T> runAsync(java.util.concurrent.Callable<T> callable)

Specified by:

runAsync in interface com.hcl.domino.DominoClient

runAsync

public <T> java.util.concurrent.FutureTask<T> runAsync(java.util.concurrent.ExecutorService service,
                                                       java.util.concurrent.Callable<T> callable)

Specified by:

runAsync in interface com.hcl.domino.DominoClient

runInterruptable

public <T> T runInterruptable(java.util.concurrent.Callable<T> callable,
                              com.hcl.domino.DominoClient.IBreakHandler breakHandler)

Specified by:

runInterruptable in interface com.hcl.domino.DominoClient

runWithProgress

public <T> T runWithProgress(java.util.concurrent.Callable<T> callable,
                             com.hcl.domino.DominoClient.IProgressListener progressHandler)

Specified by:

runWithProgress in interface com.hcl.domino.DominoClient

validateCredentials

public java.lang.String validateCredentials(java.lang.String serverName,
                                            java.lang.String userName,
                                            java.lang.String password)
                                     throws javax.naming.NameNotFoundException,
                                            javax.naming.AuthenticationException,
                                            javax.naming.AuthenticationNotSupportedException

Specified by:

validateCredentials in interface com.hcl.domino.DominoClient

Throws:

javax.naming.NameNotFoundException

javax.naming.AuthenticationException

javax.naming.AuthenticationNotSupportedException

validateCredentialsWithToken

public java.lang.String validateCredentialsWithToken(java.lang.String serverName,
                                                     java.lang.Object token)
                                              throws javax.naming.NameNotFoundException,
                                                     javax.naming.AuthenticationException,
                                                     javax.naming.AuthenticationNotSupportedException

Specified by:

validateCredentialsWithToken in interface com.hcl.domino.DominoClient

Throws:

javax.naming.NameNotFoundException

javax.naming.AuthenticationException

javax.naming.AuthenticationNotSupportedException