org.rhq.enterprise.server.sync

Interface SynchronizationManagerRemote

All Known Implementing Classes:

SynchronizationManagerBean

public interface SynchronizationManagerRemote

Public API for synchronization manager.

Author:

Lukas Krejci

Method Summary

Methods

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

Method Detail

exportAllSubsystems

org.rhq.core.domain.sync.ExportReport exportAllSubsystems(org.rhq.core.domain.auth.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(org.rhq.core.domain.auth.Subject subject,
            byte[] exportFile)
              throws ValidationException

Parameters:

subject -

exportFile -

Throws:

ValidationException

getImportConfigurationDefinition

org.rhq.core.domain.sync.ImportConfigurationDefinition getImportConfigurationDefinition(String synchronizerClass)

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

Parameters:

synchronizerClass -

Returns:

null if class not found

getImportConfigurationDefinitionOfAllSynchronizers

List<org.rhq.core.domain.sync.ImportConfigurationDefinition> getImportConfigurationDefinitionOfAllSynchronizers()

Returns the configuration definitions of all known importers.

Returns:

not null

importAllSubsystems

org.rhq.core.domain.sync.ImportReport importAllSubsystems(org.rhq.core.domain.auth.Subject subject,
                                                        byte[] exportFile,
                                                        List<org.rhq.core.domain.sync.ImportConfiguration> importerConfigurations)
                                                          throws ValidationException,
                                                                 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:

ValidationException

ImportException