com.almworks.jira.structure.api.backup.StructureBackupManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of structure-api Show documentation

Public API for the Structure Plugin for JIRA

There is a newer version: 17.25.3

package com.almworks.jira.structure.api.backup;

import org.jetbrains.annotations.NotNull;

/**
 * The backup manager is responsible for backup and restore of the structure data. You use it by
 * creating an instance of a corresponding operation (for example, {@link BackupOperation},
 * setting up the parameters and running the job.
 *
 * Only Structure plugin's data is saved and restored.
 *
 * This manager does not check permissions of the current user. If operation is started
 * by the user, the calling code should check for permissions on its own.
 *
 * @author Igor Sereda
 */
public interface StructureBackupManager {
  /**
   * Creates an instance of backup operation.
   *
   * @return backup operation
   */
  @NotNull
  BackupOperation backup();

  /**
   * Creates an instance of restore operation.
   *
   * @return restore operation
   */
  @NotNull
  RestoreOperation restore();

}