com.botronsoft.cmj.spi.configuration.gadget

Interface DashboardGadgetHandler

@PublicSpi
public interface DashboardGadgetHandler

Implement this interface to handle export/import of user preferences in a dashboard gadget or item.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	transformUserPreferencesForExport(String uriOrModuleKey, Map<String,String> userPreferences, ExportContext exportContext) Invoked when a configuration is being exported.
Map<String,String>	transformUserPreferencesForImport(String uriOrModuleKey, Map<String,String> userPreferences, ImportContext importContext) Invoked when a configuration is being imported.

Method Detail

transformUserPreferencesForExport

Map<String,String> transformUserPreferencesForExport(String uriOrModuleKey,
                                                     Map<String,String> userPreferences,
                                                     ExportContext exportContext)

Invoked when a configuration is being exported. This method will be called by Configuration Manager for each dashboard gadget or item which is handled by this handler.

Implementers may call ConfigurationReferenceCollector methods to handle references to other configuration objects.

Parameters:

uriOrModuleKey - the URI of the currently exported dashboard gadget or the module key of the currently exported dashboard item

userPreferences - a map of user preferences that are configured for the currently exported dashboard gadget.

exportContext - the context of the export operation.

Returns:

a map of the transformed user preferences - these can be the same user preferences which were passed to this method or enhanced set of user preferences. This map will be passed to transformUserPreferencesForImport(String, Map, ImportContext) when the configuration is being deployed.

See Also:

ExportContext

transformUserPreferencesForImport

Map<String,String> transformUserPreferencesForImport(String uriOrModuleKey,
                                                     Map<String,String> userPreferences,
                                                     ImportContext importContext)

Invoked when a configuration is being imported. This method will be called by Configuration Manager for each dashboard gadget or item which is handled by this handler.

Implementers can call ConfigurationReferenceLookup methods to retrieve the respective matching configuration objects referred with ConfigurationReferenceCollector.

Parameters:

uriOrModuleKey - the URI of the currently exported dashboard gadget or the module key of the currently exported dashboard item

userPreferences - the map which was returned by the invocation of transformUserPreferencesForExport(String, Map, ExportContext).

importContext - the context of the import operation.

Returns:

a map of the transformed user preferences - these are the user preferences that will be effectively stored for the corresponding dashboard gadget.

See Also:

ImportContext