com.hcl.domino.runtime

Interface DominoRuntime

public interface DominoRuntime

Represents the configuration of the running Notes or Domino environment.

Method Summary

Modifier and Type	Method and Description
Optional<Path>	getDataDirectory() Retrieves the path of the data directory for the current Notes/Domino runtime.
Optional<Path>	getProgramDirectory() Retrieves the path of the program directory for the current Notes/Domino runtime.
int	getPropertyInt(String propertyName) Retrieves the value of a Notes configuration property as an integer.
String	getPropertyString(String propertyName) Retrieves the value of a Notes configuration property as a string.
Optional<Path>	getTempDirectory() Retrieves the path of the temporary-files directory used by the current Notes/Domino runtime.
Optional<Path>	getViewRebuildDirectory() Retrieves the path of the directory used by the current Notes/Domino runtime for temporary storage during view rebuilding.
void	invokeNSD(Collection<NSDMode> modes) Tells the local runtime to run NSD.
void	setProperty(String propertyName, int value) Sets a Notes configuration property to the specified integer.
void	setProperty(String propertyName, String value) Sets a Notes configuration property to the specified string.

Method Detail

getDataDirectory

Optional<Path> getDataDirectory()

Retrieves the path of the data directory for the current Notes/Domino runtime.

Returns:

an Optional describing a Path representing the data directory on the filesystem, or an empty one if the directory cannot be determined

getProgramDirectory

Optional<Path> getProgramDirectory()

Retrieves the path of the program directory for the current Notes/Domino runtime.

Returns:

an Optional describing a Path representing the program directory on the filesystem, or an empty one if the directory cannot be determined

getTempDirectory

Optional<Path> getTempDirectory()

Retrieves the path of the temporary-files directory used by the current Notes/Domino runtime.

Returns:

an Optional describing a Path representing the temp directory on the filesystem, or an empty one if the directory cannot be determined

getViewRebuildDirectory

Optional<Path> getViewRebuildDirectory()

Retrieves the path of the directory used by the current Notes/Domino runtime for temporary storage during view rebuilding.

Returns:

an Optional describing a Path representing the view-rebuild directory on the filesystem, or an empty one if the directory cannot be determined

setProperty

void setProperty(String propertyName,
                 String value)

Sets a Notes configuration property to the specified string.

These properties correspond to notes.ini settings.

Parameters:

propertyName - the property to set

value - the value to set

setProperty

void setProperty(String propertyName,
                 int value)

Sets a Notes configuration property to the specified integer.

These properties correspond to notes.ini settings.

Parameters:

propertyName - the property to set

value - the value to set

getPropertyString

String getPropertyString(String propertyName)

Retrieves the value of a Notes configuration property as a string.

These properties correspond to notes.ini settings.

Parameters:

propertyName - the name of the property to get

Returns:

the value of the property as a string

getPropertyInt

int getPropertyInt(String propertyName)

Retrieves the value of a Notes configuration property as an integer. When the property is not set, this returns 0.

These properties correspond to notes.ini settings.

Parameters:

propertyName - the name of the property to get

Returns:

the value of the property as an int

invokeNSD

void invokeNSD(Collection<NSDMode> modes)

Tells the local runtime to run NSD.

Parameters:

modes - configuration options for the NSD execution