com.adobe.idp.backup.dsc.client
Class BackupServiceClient

java.lang.Object
  com.adobe.idp.backup.dsc.client.BackupServiceClient

All Implemented Interfaces:

BackupService

public class BackupServiceClient
extends java.lang.Object
implements BackupService

Enables the creation of a Java client object that invokes operations that belong to the Backup and Restore service API. Using this object, you can put the server into backup mode, which permits you to perform activites to perform hot backups of the server while it is running. For information, see Preparing LiveCycle ES for Backup in Programming with LiveCycle ES4.

Field Summary

Fields inherited from interface com.adobe.idp.backup.dsc.service.BackupService

SERVICE_NAME

Constructor Summary

BackupServiceClient(ServiceClientFactory serviceClientFactory)
A constructor for creating a BackupServiceClient object.

Method Summary

BackupModeEntryResult	enterBackupMode(java.lang.String aLabel, int aBackupModeTimeout, boolean aContinuousCoverageMode) Enters backup mode on the server, which allows for hot backups to be performed while the server is running.
BackupModeResult	leaveBackupMode() Ends an existing backup mode session and returns the server to the normal purging of files from the Global Document Storage.
BackupModeResult	leaveContinuousBackupMode() Leave an existing backup mode, even if in continuous backup mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupServiceClient

public BackupServiceClient(ServiceClientFactory serviceClientFactory)

A constructor for creating a BackupServiceClient object.

Parameters:

serviceClientFactory - A com.adobe.idp.dsc.clientsdk.ServiceClientFactory that contains connection properties.

Method Detail

enterBackupMode

public BackupModeEntryResult enterBackupMode(java.lang.String aLabel,
                                             int aBackupModeTimeout,
                                             boolean aContinuousCoverageMode)
                                      throws BackupException

Enters backup mode on the server, which allows for hot backups to be performed while the server is running. Upon successfully entering backup mode, the server stops purging files from the Global Document Storage. To backup the server, you perform actions outside of the the API. When the server is in backup mode already, this method can be called again to extend the timeout value or to update the label. Each subsequent call returns a new unique backup mode session identifier.

Specified by:

enterBackupMode in interface BackupService

Parameters:

aLabel - A String value that represents a label for the backup mode session. This value is a human-readable value and must not contain any spaces in the name or characters that cannot be encoded as XML content.

aBackupModeTimeout - A int value that specifies the number of minutes to stand in backup mode before timing out. A value of 0 to 10800 (number of minutes for one week) is valid. A value of 0 means that there is no time-out. This value is not used when aContinuousCoverageMode is a value of True. Instead, it is assumed that continuous recovery coverage is used. After the timeout value, the server returns to the normal operation of deleting files from the Global Document Storage (GDS).

aContinuousCoverageMode - A boolean value that specifies whether to stand in continuous coverage mode. Continuous coverage mode means the server stays in backup mode necessary for rolling backup implementations. A value of True means to stay in continous backup mode. A value of False means that the server will leave backup mode after the time expires, or the leaveBackupMode is invoked.

Returns:

A BackupModeEntryResult object specifying the backup mode session information.

Throws:

BackupException

leaveBackupMode

public BackupModeResult leaveBackupMode()
                                 throws BackupException

Ends an existing backup mode session and returns the server to the normal purging of files from the Global Document Storage. Before you invoke this procedure, any backup activities being performed should be completed.

Specified by:

leaveBackupMode in interface BackupService

Returns:

A BackupModeResult with the backup mode session information that ended on the server.

Throws:

BackupException

leaveContinuousBackupMode

public BackupModeResult leaveContinuousBackupMode()
                                           throws BackupException

Leave an existing backup mode, even if in continuous backup mode. Use with caution: if continuous backup mode is interrupted, continuity of backup coverage cannot be re-established for the time the backup mode was off.

Specified by:

leaveContinuousBackupMode in interface BackupService

Returns:

BackupModeResult with methods to retrieve the backup information. Null is returned, if the method is called when no backup mode is active.

Throws:

BackupException - BackupException is thrown if the back-end document management system cannot leave the backup mode.