org.rhq.enterprise.server.sync
Interface SynchronizationManagerRemote

All Known Subinterfaces:

WebservicesRemote

public interface SynchronizationManagerRemote

Method Summary

ExportReport	exportAllSubsystems(Subject subject) This exports the configuration data of all supported subsystems in RHQ.
ImportConfigurationDefinition	getImportConfigurationDefinition(String synchronizerClass) Returns the configuration definition of the import for synchronizer of given type.
List<ImportConfigurationDefinition>	getImportConfigurationDefinitionOfAllSynchronizers() Returns the configuration definitions of all known importers.
ImportReport	importAllSubsystems(Subject subject, byte[] exportFile, List<ImportConfiguration> importerConfigurations) Imports everything from the export file.
void	validate(Subject subject, byte[] exportFile)

Method Detail

exportAllSubsystems

ExportReport exportAllSubsystems(Subject subject)

This exports the configuration data of all supported subsystems in RHQ.

The returned report contains the data bytes themselves as well as a map of messages and notes produced by the different subsystem exporters so that the caller of this method is able to determine possible problems of the export file without needing to deserialize and read it (the same messages are also included in the export data).

The export data is a zipped XML.

The export requires the user to have Permission.MANAGE_INVENTORY permission.

Parameters:

subject - the logged in user

Returns:

the export report

validate

void validate(Subject subject,
              byte[] exportFile)
              throws org.rhq.enterprise.server.sync.ValidationException

Throws:

org.rhq.enterprise.server.sync.ValidationException

getImportConfigurationDefinition

ImportConfigurationDefinition getImportConfigurationDefinition(String synchronizerClass)

Returns the configuration definition of the import for synchronizer of given type.

Parameters:

synchronizerClass -

Returns:

getImportConfigurationDefinitionOfAllSynchronizers

List<ImportConfigurationDefinition> getImportConfigurationDefinitionOfAllSynchronizers()

Returns the configuration definitions of all known importers.

Returns:

importAllSubsystems

ImportReport importAllSubsystems(Subject subject,
                                 byte[] exportFile,
                                 List<ImportConfiguration> importerConfigurations)
                                 throws org.rhq.enterprise.server.sync.ValidationException,
                                        org.rhq.enterprise.server.sync.ImportException

Imports everything from the export file.

Parameters:

subject - the authenticated user

exportFile - the contents of the export file

importerConfigurations - the configurations of individual importers to be used when importing or null if the default configurations should be used for all the importers.

Returns:

the report describing the result of the import

Throws:

org.rhq.enterprise.server.sync.ValidationException

org.rhq.enterprise.server.sync.ImportException