Skip to content
This repository was archived by the owner on Jul 18, 2022. It is now read-only.

Plugin metadata

Jump to bottom
fschoeppl edited this page Jun 12, 2012 · 1 revision

The plugin-metadata describe meta-information of a plugin. E. g. quotas, the fastest backup frequency or file size limitations can be defined.

Generating meta information

To generate metadata for a plugin, a developer has to implement the Describable interface. The getMetadata method returns a key/value-Map with all metadata entries. The map may contain plugin specific metadata about the plugin. Some metadata properties must be calculated based on a users account. Therefore, the access data of the users account will be passed to the getMetadata method.

Predefined metadata tags

BackMeUp consists of predefined metadata-keys which should be specified by a plugin. The following keys are in the class org.backmeup.model.Metadata defined:

  • The frequency of creating a backup per user (META_BACKUP_FREQUENCY). Possible values are: 'DAILY', 'MONTHLY', 'WEEKLY'.

  • The maximal file size that can be uploaded to this service (META_FILE_SIZE_LIMIT).

  • The current quota (usage) of the service for a specific user in MB (META_QUOTA).

  • The maximum quota of a service in MB (META_QUOTA_LIMIT).

Examples

Clone this wiki locally