org.mycontroller.standalone.api

Class BackupApi

java.lang.Object

org.mycontroller.standalone.api.BackupApi

public class BackupApi
extends Object

This class used to call system backup and restore functions.

Like list of available backup files, run new backup, to restore a backup

Since:

0.0.3

Author:

Jeeva Kandasamy (jkandasa)

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	BACKUP_FILE_SUFFIX_FILTER
static String	KEY_NAME

Constructor Summary

Constructors

Constructor and Description
BackupApi()

Method Summary

Modifier and Type	Method and Description
String	backupNow() Call this method to run immediate system backup
String	backupNow(String backupFilePrefix) Call this method to run immediate system backup
void	deleteBackupFiles(List<String> backupFiles) Call this method to delete list of backup files
QueryResponse	getBackupFiles(HashMap<String,Object> filters) Call this method to get list of available backup files.
void	restore(String fileName) Call this method to restore a backup file

Methods inherited from class java.lang.Object

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

Field Detail

KEY_NAME

public static final String KEY_NAME

See Also:

Constant Field Values

BACKUP_FILE_SUFFIX_FILTER

public static final String[] BACKUP_FILE_SUFFIX_FILTER

Constructor Detail

BackupApi

public BackupApi()

Method Detail

getBackupFiles

public QueryResponse getBackupFiles(HashMap<String,Object> filters)
                             throws IOException

Call this method to get list of available backup files.

Filter(s):

name - List of backup file names

Page filter(s):

pageLimit - Set number of items per page

page - Request page number

order - Set order. Option: asc, desc

orderBy - column name for order. Option: name

Parameters:

filters - Supports various filter options.

Returns:

QueryResponse Contains input filter and response

Throws:

IOException - throws when problem with backup location

deleteBackupFiles

public void deleteBackupFiles(List<String> backupFiles)
                       throws IOException

Call this method to delete list of backup files

Parameters:

backupFiles - List of backup file names with extension

Throws:

IOException - throws when problem with backup location

backupNow

public String backupNow(String backupFilePrefix)
                 throws McException,
                        IOException

Call this method to run immediate system backup

Parameters:

backupFilePrefix - backup file prefix name

Returns:

backed up file name

Throws:

IOException - throws when problem with backup location

McException - internal issue

backupNow

public String backupNow()
                 throws McException,
                        IOException

Call this method to run immediate system backup

calls backupNow(String) with 'on-demand' string

Returns:

backed up file name

Throws:

IOException - throws when problem with backup location

McException - internal issue

restore

public void restore(String fileName)
             throws IOException,
                    McBadRequestException

Call this method to restore a backup file

Parameters:

fileName - backup file name to restore

Warning: After successful restore you have to start the server manually

Throws:

IOException - throws when problem with backup location

McBadRequestException - given file name not available