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

public interface StreamBackupServiceClient

A business component needs to implement this interface if it wants to work with the StreamBackupService.

Since:

6.0.1.1

Method Summary

void	java.io.OutputStream, java.lang.String, java.lang.String)">backupData(java.io.OutputStream out, java.lang.String componentID, java.lang.String handback) This is called by the StreamBackupService to get the actual data from the business component.
void	java.io.InputStream, java.lang.String, java.lang.String)">restoreData(java.io.InputStream in, java.lang.String componentID, java.lang.String backupHandle) This is called by the StreamBackupService to allow the business component to read the stored data back in.

Method Detail

java.io.OutputStream, java.lang.String, java.lang.String)">

backupData

void backupData(java.io.OutputStream out,
                java.lang.String componentID,
                java.lang.String handback)
                throws ComponentException

This is called by the StreamBackupService to get the actual data from the business component.

Parameters:

out - the stream to write the data to, never null

componentID - component instance identifier, never null

handback - the handback passed in during the registerBackupData call, never null

Throws:

ComponentException - in case the component encounters a problem

java.io.InputStream, java.lang.String, java.lang.String)">

restoreData

void restoreData(java.io.InputStream in,
                 java.lang.String componentID,
                 java.lang.String backupHandle)
                 throws ComponentException

This is called by the StreamBackupService to allow the business component to read the stored data back in.

Parameters:

in - the stream the data can be read from again, never null

componentID - component instance identifier, never null

backupHandle - the backupHandle passed in during the registerRestoreData call, never null

Throws:

ComponentException - in case the component encounters a problem