com.siviam.bobup.handler
Interface IBackupRecoveryHandler

public interface IBackupRecoveryHandler

A handler specification that backups and recovers business object parts.

Author:

vishnu

Field Summary

static java.lang.String	NAME_PROPERTY
static java.lang.String	TYPE_PROPERTY

Method Summary

void	backup(IBackupPart part, java.io.OutputStream os) Backup the part.
java.util.Properties	describePart(IBackupPart part) Describes the part, typically in the form of property names and values.
java.lang.String	getType() The type that this handler is able to handle.
void	recover(java.io.InputStream is) Recovers the data that is sourced from the provided InputStream.

Field Detail

NAME_PROPERTY

public static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

TYPE_PROPERTY

public static final java.lang.String TYPE_PROPERTY

See Also:

Constant Field Values

Method Detail

describePart

public java.util.Properties describePart(IBackupPart part)
                                  throws java.lang.Exception

Describes the part, typically in the form of property names and values. This information gets recorded into the backup, so that it could be used during the recovery.

Each part description is a new section in the jar. The section must begin with a Name property and therefore one of the properties must be name. The value of the name attribute must be the corresponding entry in the jar file.

Parameters:

part -

Returns:

Throws:

java.lang.Exception

backup

public void backup(IBackupPart part,
                   java.io.OutputStream os)
            throws java.lang.Exception

Backup the part. The output stream to which this part must be backed up should NEVER be closed().

Parameters:

part -

os - should never be closed().

Throws:

java.lang.Exception

recover

public void recover(java.io.InputStream is)
             throws java.lang.Exception

Recovers the data that is sourced from the provided InputStream.

Parameters:

is -

Throws:

java.lang.Exception

getType

public java.lang.String getType()

The type that this handler is able to handle.

Returns: