Package com.morpheusdata.core.backup
Interface BackupProvider
-
- All Superinterfaces:
PluginProvider
- All Known Implementing Classes:
AbstractBackupProvider
public interface BackupProvider extends PluginProvider
This is the main entrypoint for registering a backup provider. Morpheus models backup integrations as a tree. A BackupProvider can have many backup types and therefore needs backup type providers scoped to specific types. Typically, it is best to extend theAbstractBackupProvider
rather than directly implementing some of these methods.- Since:
- 0.12.2
- See Also:
AbstractBackupProvider
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.Collection<BackupIntegration>
scopedProviders
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addScopedProvider(BackupTypeProvider backupTypeProvider, java.lang.String provisionTypeCode, java.lang.String containerTypeCode)
Used to registerBackupTypeProvider
implementations by backup typevoid
addScopedProvider(BackupIntegration backupIntegration)
ServiceResponse
addToBackupJob(BackupJob backupJobModel, java.util.Map opts)
ServiceResponse
cloneBackupJob(BackupJob sourceBackupJobModel, BackupJob backupJobModel, java.util.Map opts)
ServiceResponse
configureBackupJob(BackupJob backupJobModel, java.util.Map config, java.util.Map opts)
ServiceResponse
configureBackupProvider(BackupProvider backupProviderModel, java.util.Map config, java.util.Map opts)
ServiceResponse
createBackupJob(BackupJob backupJobModel, java.util.Map opts)
ServiceResponse
deleteBackupJob(BackupJob backupJobModel, java.util.Map opts)
ServiceResponse
deleteBackupProvider(BackupProvider backupProviderModel, java.util.Map opts)
ServiceResponse
executeBackupJob(BackupJob backupJobModel, java.util.Map opts)
java.util.Collection<OptionType>
getBackupJobOptionTypes()
java.util.Collection<OptionType>
getBackupOptionTypes()
java.lang.Boolean
getCreatable()
Is this backup provider creatable by the end user.java.lang.String
getDefaultJobType()
java.lang.Boolean
getDownloadEnabled()
Does this provider allow the end user to download a backup.java.lang.Boolean
getEnabled()
Sets the enabled state of the provider for consumer use.java.lang.Boolean
getHasAddToJob()
java.lang.Boolean
getHasBackups()
java.lang.Boolean
getHasCloneJob()
java.lang.Boolean
getHasCopyToStore()
java.lang.Boolean
getHasCreateJob()
java.lang.Boolean
getHasJobs()
java.lang.Boolean
getHasOptionalJob()
java.lang.Boolean
getHasReplication()
java.lang.Boolean
getHasReplicationGroups()
java.lang.Boolean
getHasRepositories()
java.lang.Boolean
getHasRetentionCount()
java.lang.Boolean
getHasSchedule()
java.lang.Boolean
getHasServers()
java.lang.Boolean
getHasSites()
java.lang.Boolean
getHasStreamToStore()
Icon
getIcon()
Returns the integration logo for display when a user needs to view or add this integrationjava.util.Collection<OptionType>
getInstanceReplicationGroupOptionTypes()
java.util.Collection<OptionType>
getOptionTypes()
java.util.Collection<OptionType>
getReplicationGroupOptionTypes()
java.util.Collection<OptionType>
getReplicationOptionTypes()
java.lang.Boolean
getRestoreExistingEnabled()
java.lang.Boolean
getRestoreNewEnabled()
java.util.Collection<BackupIntegration>
getScopedProviders()
java.lang.String
getViewSet()
Deprecated.java.lang.Boolean
hasCancelBackup()
java.lang.Boolean
hasStorageProvider()
ServiceResponse
initializeBackupProvider(BackupProvider backupProviderModel, java.util.Map opts)
ServiceResponse
refresh(BackupProvider backupProvider)
The main refresh method called periodically by Morpheus to sync any necessary objects from the integration.ServiceResponse
updateBackupProvider(BackupProvider backupProviderModel, java.util.Map opts)
ServiceResponse
validateBackupJob(BackupJob backupJobModel, java.util.Map config, java.util.Map opts)
ServiceResponse
validateBackupProvider(BackupProvider backupProviderModel, java.util.Map opts)
-
Methods inherited from interface com.morpheusdata.core.PluginProvider
getCode, getMorpheus, getName, getPlugin, isPlugin
-
-
-
-
Field Detail
-
scopedProviders
static final java.util.Collection<BackupIntegration> scopedProviders
-
-
Method Detail
-
getIcon
Icon getIcon()
Returns the integration logo for display when a user needs to view or add this integration- Returns:
- Icon representation of assets stored in the src/assets of the project.
-
getViewSet
java.lang.String getViewSet()
Deprecated.Returns a viewset for reference custom inputs when setting up a backup provider during add instance. This is the old way and is no longer being used- Returns:
-
getEnabled
java.lang.Boolean getEnabled()
Sets the enabled state of the provider for consumer use. NOTE: This may go away as this should be implied by the installation state of the plugin- Returns:
- if this provider is usable.
-
getCreatable
java.lang.Boolean getCreatable()
Is this backup provider creatable by the end user. This could be false for providers that may be forced by specific CloudProvider plugins, for example.- Returns:
- the creatable state
-
getDownloadEnabled
java.lang.Boolean getDownloadEnabled()
Does this provider allow the end user to download a backup. Some backup providers can allow the user to download the backup archive file.- Returns:
- whether the backup can be downloaded.
-
getHasAddToJob
java.lang.Boolean getHasAddToJob()
-
getHasBackups
java.lang.Boolean getHasBackups()
-
hasCancelBackup
java.lang.Boolean hasCancelBackup()
-
getHasCloneJob
java.lang.Boolean getHasCloneJob()
-
getHasCopyToStore
java.lang.Boolean getHasCopyToStore()
-
getHasCreateJob
java.lang.Boolean getHasCreateJob()
-
getHasJobs
java.lang.Boolean getHasJobs()
-
getDefaultJobType
java.lang.String getDefaultJobType()
-
getHasOptionalJob
java.lang.Boolean getHasOptionalJob()
-
getHasReplication
java.lang.Boolean getHasReplication()
-
getHasReplicationGroups
java.lang.Boolean getHasReplicationGroups()
-
getHasRepositories
java.lang.Boolean getHasRepositories()
-
getHasRetentionCount
java.lang.Boolean getHasRetentionCount()
-
getHasSchedule
java.lang.Boolean getHasSchedule()
-
getHasServers
java.lang.Boolean getHasServers()
-
getHasSites
java.lang.Boolean getHasSites()
-
hasStorageProvider
java.lang.Boolean hasStorageProvider()
-
getHasStreamToStore
java.lang.Boolean getHasStreamToStore()
-
getRestoreExistingEnabled
java.lang.Boolean getRestoreExistingEnabled()
-
getRestoreNewEnabled
java.lang.Boolean getRestoreNewEnabled()
-
getOptionTypes
java.util.Collection<OptionType> getOptionTypes()
-
getReplicationGroupOptionTypes
java.util.Collection<OptionType> getReplicationGroupOptionTypes()
-
getReplicationOptionTypes
java.util.Collection<OptionType> getReplicationOptionTypes()
-
getBackupJobOptionTypes
java.util.Collection<OptionType> getBackupJobOptionTypes()
-
getBackupOptionTypes
java.util.Collection<OptionType> getBackupOptionTypes()
-
getInstanceReplicationGroupOptionTypes
java.util.Collection<OptionType> getInstanceReplicationGroupOptionTypes()
-
addScopedProvider
void addScopedProvider(BackupIntegration backupIntegration)
-
addScopedProvider
void addScopedProvider(BackupTypeProvider backupTypeProvider, java.lang.String provisionTypeCode, java.lang.String containerTypeCode)
Used to registerBackupTypeProvider
implementations by backup type- Parameters:
backupTypeProvider
- the current backup type provider instanceprovisionTypeCode
- the provision type code unique to the specific types of workloads this is scoped tocontainerTypeCode
- optional workload type code in the event the backup type is very specific to a workload type.
-
getScopedProviders
java.util.Collection<BackupIntegration> getScopedProviders()
-
configureBackupProvider
ServiceResponse configureBackupProvider(BackupProvider backupProviderModel, java.util.Map config, java.util.Map opts)
-
validateBackupProvider
ServiceResponse validateBackupProvider(BackupProvider backupProviderModel, java.util.Map opts)
-
initializeBackupProvider
ServiceResponse initializeBackupProvider(BackupProvider backupProviderModel, java.util.Map opts)
-
updateBackupProvider
ServiceResponse updateBackupProvider(BackupProvider backupProviderModel, java.util.Map opts)
-
deleteBackupProvider
ServiceResponse deleteBackupProvider(BackupProvider backupProviderModel, java.util.Map opts)
-
refresh
ServiceResponse refresh(BackupProvider backupProvider)
The main refresh method called periodically by Morpheus to sync any necessary objects from the integration. This can call sub services for better organization, and it is recommended thatSyncTask
is used.- Parameters:
backupProvider
- the current instance of the backupProvider being refreshed- Returns:
- the success state of the refresh
-
configureBackupJob
ServiceResponse configureBackupJob(BackupJob backupJobModel, java.util.Map config, java.util.Map opts)
-
validateBackupJob
ServiceResponse validateBackupJob(BackupJob backupJobModel, java.util.Map config, java.util.Map opts)
-
createBackupJob
ServiceResponse createBackupJob(BackupJob backupJobModel, java.util.Map opts)
-
cloneBackupJob
ServiceResponse cloneBackupJob(BackupJob sourceBackupJobModel, BackupJob backupJobModel, java.util.Map opts)
-
addToBackupJob
ServiceResponse addToBackupJob(BackupJob backupJobModel, java.util.Map opts)
-
deleteBackupJob
ServiceResponse deleteBackupJob(BackupJob backupJobModel, java.util.Map opts)
-
executeBackupJob
ServiceResponse executeBackupJob(BackupJob backupJobModel, java.util.Map opts)
-
-