com.hcl.domino

Interface DominoProcess

public interface DominoProcess

This service interface allows access to initialization and termination of the Domino runtime for the process.

This service is not guaranteed to be provided by every implementation.

Author:

Jesse Gallagher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DominoProcess.DominoThreadContext

Method Summary

Modifier and Type	Method and Description
static DominoProcess	get()
void	initializeProcess(String[] initArgs) Initializes the Domino runtime for the process.
DominoProcess.DominoThreadContext	initializeThread() Initializes the current thread for Domino API use.
String	switchToId(Path idPath, String password, boolean dontSetEnvVar) This function switches to the specified ID file and returns the user name associated with it. Multiple passwords are not supported. NOTE: This function should only be used in a C API stand alone application.
void	terminateProcess() Destroys the Domino runtime for the entire process.
void	terminateThread() Terminates the current thread for Domino API use.

Method Detail

get

static DominoProcess get()

Returns:

an implementation of DominoProcess

Throws:

IllegalStateException - if the active API implementation does not provide one

initializeProcess

void initializeProcess(String[] initArgs)

Initializes the Domino runtime for the process.

In implementations that require it, this method should be called once per process, before any other API operations.

Parameters:

initArgs - the arguments to pass to the initialization call

switchToId

String switchToId(Path idPath,
                  String password,
                  boolean dontSetEnvVar)

This function switches to the specified ID file and returns the user name associated with it.

Multiple passwords are not supported.

NOTE: This function should only be used in a C API stand alone application.

Parameters:

idPath - path to the ID file that is to be switched to; if null/empty, we read the ID file path from the Notes.ini (KeyFileName)

password - password of the ID file that is to be switched to

dontSetEnvVar - If specified, the notes.ini file (either ServerKeyFileName or KeyFileName) is modified to reflect the ID change.

Returns:

user name, in the ID file that is to be switched to

terminateProcess

void terminateProcess()

Destroys the Domino runtime for the entire process.

This method should be called only when all Domino operations are finished for the running application.

initializeThread

DominoProcess.DominoThreadContext initializeThread()

Initializes the current thread for Domino API use.

Note: it is preferable to use threads spawned by DominoClient.getThreadFactory().

Returns:

AutoCloseable to terminate thread, same as calling terminateThread()

terminateThread

void terminateThread()

Terminates the current thread for Domino API use.

Note: it is preferable to use threads spawned by DominoClient.getThreadFactory().