BackupContainerReader (Atlassian Confluence 8.8.0 API)

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

XMLBackupContainerReader
```
public interface BackupContainerReader
extends AutoCloseable
```
Reader that allows to read files from the container.

Since:

7.20.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`close()`
`BackupProperties`	`getBackupProperties()`
`Properties`	`getLegacyBackupProperties()`	Deprecated. since 8.2.0
`void`	`readObjects(BackupRestoreConsumer<ImportedObjectV2> objectConsumer)`
`void`	`readPluginModuleData()`

- Method Detail
  - getBackupProperties
```
BackupProperties getBackupProperties()
                              throws BackupRestoreException
```
    Returns:
    
    properties of the backup
    
    Throws:
    
    BackupRestoreException
  - getLegacyBackupProperties
```
@Deprecated
Properties getLegacyBackupProperties()
                              throws BackupRestoreException
```
    Deprecated.
    since 8.2.0
    
    This method was introduced to support the all legacy actions that work with Properties. Please do not use it. It will be removed in the future when all usages are got rid of.
    
    Returns:
    
    properties of the backup
    
    Throws:
    
    BackupRestoreException
    
    Since:
    
    8.2.0
  - readObjects
```
void readObjects(BackupRestoreConsumer<ImportedObjectV2> objectConsumer)
          throws BackupRestoreException
```
    Throws:
    
    BackupRestoreException
  - readPluginModuleData
```
void readPluginModuleData()
                   throws BackupRestoreException
```
    Throws:
    
    BackupRestoreException
  - close
```
void close()
    throws BackupRestoreException
```
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    BackupRestoreException