com.ibm.portal.app.service.backup
Interface StreamBackupService

public interface StreamBackupService

The StreamBackupService can be used by a business component to write out arbitrary binary data during backup and read that data back in during restore. To use this service a business component needs to implement the StreamBackupServiceClient interface. During backup/restore operations the component can call this service to regiser itself. An asynchronous call back to the component will then be made to send out the actual data.

Since:

6.0.1.1

Field Summary

static java.lang.String

JNDI_NAME

Method Summary

java.lang.String	registerBackupData(java.lang.Object context, java.lang.String handback) This registers a data set during backup.
void	registerRestoreData(java.lang.Object context, java.lang.String backupHandle) This requests a data set to be restored.

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

See Also:

Constant Field Values

Method Detail

registerBackupData

java.lang.String registerBackupData(java.lang.Object context,
                                    java.lang.String handback)
                                    throws BackupServiceException

This registers a data set during backup.

Parameters:

context - during serialization a parameter Map is passed in. the object with the key "backupContext" needs to passed in. Must not be null.

handback - this is an arbitrary string used by the business component to identify the resource it wants to write out. this is required if the business component wants to send out multiple data sets. This string is later on returned to the business component. Must not be null.

Returns:

a string generated by the service to identify the data. this string must be stored by the business component in its object data and is used to identify the resource during restore again. Never null.

Throws:

BackupServiceException - in case the service encounters a problem

registerRestoreData

void registerRestoreData(java.lang.Object context,
                         java.lang.String backupHandle)
                         throws BackupServiceException

This requests a data set to be restored.

Parameters:

context - during deserialization a parameter Map is passed in. the object with the key "backupContext" needs to passed in. Must not be null.

backupHandle - The value registerBackupData returned. Must not be null.

Throws:

BackupServiceException - in case the service encounters a problem