Package com.atlassian.confluence.plugins.restapi.resources

Class BackupRestoreResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.BackupRestoreResource

@Consumes("application/json")
@Produces("application/json")
@Path("/backup-restore")
public class BackupRestoreResource
extends Object

Constructor Summary

Constructors

Constructor	Description
BackupRestoreResource(BackupRestoreService backupRestoreService)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	cancelAllQueuedJobs()
jakarta.ws.rs.core.Response	cancelJob(Long jobId)
jakarta.ws.rs.core.Response	createSiteBackupJob(SiteBackupSettings settings)
jakarta.ws.rs.core.Response	createSiteRestoreJob(SiteRestoreSettings settings)
jakarta.ws.rs.core.Response	createSiteRestoreJobForUploadedBackupFile(com.atlassian.plugins.rest.api.multipart.FilePart file)
jakarta.ws.rs.core.Response	createSpaceBackupJob(SpaceBackupSettings settings)
jakarta.ws.rs.core.Response	createSpaceRestoreJob(SpaceRestoreSettings settings)
jakarta.ws.rs.core.Response	createSpaceRestoreJobForUploadedBackupFile(com.atlassian.plugins.rest.api.multipart.FilePart file)
jakarta.ws.rs.core.Response	downloadBackupFile(Long jobId)
jakarta.ws.rs.core.Response	findJobs(Integer limit, String fromDate, String toDate, JobScope jobScope, JobOperation jobOperation, List<JobState> jobStates, String spaceKey, String owner)
jakarta.ws.rs.core.Response	getFiles(JobScope jobScope)
jakarta.ws.rs.core.Response	getJob(Long jobId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BackupRestoreResource

@Inject
public BackupRestoreResource(BackupRestoreService backupRestoreService)

Method Details

createSpaceBackupJob

@POST
@Path("/backup/space")
public jakarta.ws.rs.core.Response createSpaceBackupJob(SpaceBackupSettings settings)

createSiteBackupJob

@POST
@Path("/backup/site")
public jakarta.ws.rs.core.Response createSiteBackupJob(SiteBackupSettings settings)

createSpaceRestoreJob

@POST
@Path("/restore/space")
public jakarta.ws.rs.core.Response createSpaceRestoreJob(SpaceRestoreSettings settings)

createSiteRestoreJob

@POST
@Path("/restore/site")
public jakarta.ws.rs.core.Response createSiteRestoreJob(SiteRestoreSettings settings)

createSpaceRestoreJobForUploadedBackupFile

@POST
@Consumes("multipart/form-data")
@Path("/restore/space/upload")
public jakarta.ws.rs.core.Response createSpaceRestoreJobForUploadedBackupFile(com.atlassian.plugins.rest.api.multipart.FilePart file)
                                                                       throws IOException

Throws:

IOException

createSiteRestoreJobForUploadedBackupFile

@POST
@Consumes("multipart/form-data")
@Path("/restore/site/upload")
public jakarta.ws.rs.core.Response createSiteRestoreJobForUploadedBackupFile(com.atlassian.plugins.rest.api.multipart.FilePart file)
                                                                      throws IOException

Throws:

IOException

getJob

@GET
@Path("/jobs/{jobId}")
public jakarta.ws.rs.core.Response getJob(@PathParam("jobId")
 Long jobId)

findJobs

@GET
@Path("/jobs")
public jakarta.ws.rs.core.Response findJobs(@QueryParam("limit") @DefaultValue("25")
 Integer limit,
 @QueryParam("fromDate")
 String fromDate,
 @QueryParam("toDate")
 String toDate,
 @QueryParam("jobScope")
 JobScope jobScope,
 @QueryParam("jobOperation")
 JobOperation jobOperation,
 @QueryParam("jobStates")
 List<JobState> jobStates,
 @QueryParam("spaceKey")
 String spaceKey,
 @QueryParam("owner")
 String owner)

getFiles

@GET
@Path("/restore/files")
public jakarta.ws.rs.core.Response getFiles(@QueryParam("jobScope")
 JobScope jobScope)

cancelJob

@PUT
@Path("/jobs/{jobId}/cancel")
public jakarta.ws.rs.core.Response cancelJob(@PathParam("jobId")
 Long jobId)

downloadBackupFile

@GET
@Path("/jobs/{jobId}/download")
public jakarta.ws.rs.core.Response downloadBackupFile(@PathParam("jobId")
 Long jobId)

cancelAllQueuedJobs

@PUT
@Path("/jobs/clear-queue")
public jakarta.ws.rs.core.Response cancelAllQueuedJobs()