Package jetbrains.buildServer.serverSide

Interface ConfigurationErrors

All Superinterfaces:

ErrorsCollection

All Known Implementing Classes:

ConfigurationErrorsImpl

public interface ConfigurationErrors
extends ErrorsCollection

This interface should be used for critical errors associated with server configuration files.

Method Summary

Modifier and Type	Method	Description
void	clearError(File configFile)	Removes error associated with specified file
boolean	containsError(File configFile)	Returns true if there is an error associated with specified file
List<File>	getBrokenConfigFiles()
String	getErrorMessage(File configFile)	Returns error message associated with specified file or null
boolean	hasErrors()	Returns true if there are errors associated with configuration files
void	putError(File configFile, String message)	Stores error message associated with a file and logs it to a log file
void	putError(File configFile, String message, boolean logMessage)	Stores error message associated with a file and optionally logs it to a log file
org.jdom.Document	readConfigFile(File configFile)

Methods inherited from interface jetbrains.buildServer.serverSide.ErrorsCollection

getErrors

Method Detail

putError

void putError(@NotNull
              File configFile,
              @NotNull
              String message)

Stores error message associated with a file and logs it to a log file

Parameters:

configFile - file

message - message

putError

void putError(@NotNull
              File configFile,
              @NotNull
              String message,
              boolean logMessage)

Stores error message associated with a file and optionally logs it to a log file

Parameters:

configFile - file

message - error message

logMessage - if true then the log will be logged to a log file with warning log level

Since:

2023.11

getErrorMessage

@Nullable
String getErrorMessage(@NotNull
                       File configFile)

Returns error message associated with specified file or null

Parameters:

configFile -

Returns:

clearError

void clearError(@NotNull
                File configFile)

Removes error associated with specified file

Parameters:

key - key of the error

containsError

boolean containsError(@NotNull
                      File configFile)

Returns true if there is an error associated with specified file

Parameters:

configFile - file

Returns:

see above

hasErrors

boolean hasErrors()

Returns true if there are errors associated with configuration files

Returns:

see above

getBrokenConfigFiles

@NotNull
List<File> getBrokenConfigFiles()

Returns:

all configurations files for which errors were reported

readConfigFile

@Nullable
org.jdom.Document readConfigFile(@NotNull
                                 File configFile)