BackupSettings

Inheritance: java.lang.Object

public class BackupSettings

Class contains options for backup operation

Constructors

Constructor Description
BackupSettings() Initializes a new instance of the BackupSettings class
BackupSettings(int options) Initializes a new instance of the BackupSettings class
BackupSettings(boolean executeRecursively, boolean restoreConnection, int numberOfAttempts, int timeoutBetweenAttempts) Initializes a new instance of the BackupSettings class

Methods

Method Description
getDefault() Gets BackupSettings class with settings by default
to_BackupSettings(int options) Converts enumerable options to class
getExecuteRecursively() Gets or sets value which defines if backup should be executed recursively
setExecuteRecursively(boolean value) Gets or sets value which defines if backup should be executed recursively
getRestoreConnection() Gets or sets value which defines if connection has to be restored in case if server closes connection forcibly This option has to be used together with NumberOfAttemptsToRrepeat option.
setRestoreConnection(boolean value) Gets or sets value which defines if connection has to be restored in case if server closes connection forcibly This option has to be used together with NumberOfAttemptsToRrepeat option.
getNumberOfAttemptsToRrepeat() Gets or sets value which defines number of attempts to repeat failed operation In case of some IMAP command inside backup operation returns failed result, IMAP client tries to repeat this operation again according to defined quantity of times.
setNumberOfAttemptsToRrepeat(int value) Gets or sets value which defines number of attempts to repeat failed operation In case of some IMAP command inside backup operation returns failed result, IMAP client tries to repeat this operation again according to defined quantity of times.
getTimeoutBetweenAttempts() Gets or sets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option.
setTimeoutBetweenAttempts(int value) Gets or sets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option.

BackupSettings()

public BackupSettings()

Initializes a new instance of the BackupSettings class

BackupSettings(int options)

public BackupSettings(int options)

Initializes a new instance of the BackupSettings class

Parameters:

Parameter Type Description
options int enumerates backup options

BackupSettings(boolean executeRecursively, boolean restoreConnection, int numberOfAttempts, int timeoutBetweenAttempts)

public BackupSettings(boolean executeRecursively, boolean restoreConnection, int numberOfAttempts, int timeoutBetweenAttempts)

Initializes a new instance of the BackupSettings class

Parameters:

Parameter Type Description
executeRecursively boolean defines if backup should be executed recursively
restoreConnection boolean defines if connection has to be restored in case if server closes connection forcibly
numberOfAttempts int defines number of attempts to repeat failed operation
timeoutBetweenAttempts int defines timeout (in milliseconds) between attemptions to execute operation again

getDefault()

public static BackupSettings getDefault()

Gets BackupSettings class with settings by default

Returns: BackupSettings

to_BackupSettings(int options)

public static BackupSettings to_BackupSettings(int options)

Converts enumerable options to class

Parameters:

Parameter Type Description
options int Options to convert

Returns: BackupSettings

getExecuteRecursively()

public final boolean getExecuteRecursively()

Gets or sets value which defines if backup should be executed recursively

Returns: boolean

setExecuteRecursively(boolean value)

public final void setExecuteRecursively(boolean value)

Gets or sets value which defines if backup should be executed recursively

Parameters:

Parameter Type Description
value boolean

getRestoreConnection()

public final boolean getRestoreConnection()

Gets or sets value which defines if connection has to be restored in case if server closes connection forcibly This option has to be used together with NumberOfAttemptsToRrepeat option.

Returns: boolean

setRestoreConnection(boolean value)

public final void setRestoreConnection(boolean value)

Gets or sets value which defines if connection has to be restored in case if server closes connection forcibly This option has to be used together with NumberOfAttemptsToRrepeat option.

Parameters:

Parameter Type Description
value boolean

getNumberOfAttemptsToRrepeat()

public final int getNumberOfAttemptsToRrepeat()

Gets or sets value which defines number of attempts to repeat failed operation In case of some IMAP command inside backup operation returns failed result, IMAP client tries to repeat this operation again according to defined quantity of times. For instance if FETCH operation returns error AE_1_1_0243 FETCH 219 (BODY) AE_1_1_0243 NO[UNAVAILABLE] FETCH Service is temporarily not available Client tries to execute it again.

Returns: int

setNumberOfAttemptsToRrepeat(int value)

public final void setNumberOfAttemptsToRrepeat(int value)

Gets or sets value which defines number of attempts to repeat failed operation In case of some IMAP command inside backup operation returns failed result, IMAP client tries to repeat this operation again according to defined quantity of times. For instance if FETCH operation returns error AE_1_1_0243 FETCH 219 (BODY) AE_1_1_0243 NO[UNAVAILABLE] FETCH Service is temporarily not available Client tries to execute it again.

Parameters:

Parameter Type Description
value int

getTimeoutBetweenAttempts()

public final int getTimeoutBetweenAttempts()

Gets or sets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option.

Returns: int

setTimeoutBetweenAttempts(int value)

public final void setTimeoutBetweenAttempts(int value)

Gets or sets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option.

Parameters:

Parameter Type Description
value int