Package dev.le_app.mcss_api_java

Class Backup

java.lang.Object

dev.le_app.mcss_api_java.Backup

public class Backup
extends Object

This class contains information about a server's backup

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Backup(MCSSApi api, String serverID, String backupID)	Creates a new Backup object - ONLY MADE BY THE SERVER OBJECT

Method Summary

Modifier and Type	Method	Description
void	deleteBackup()	Delete the backup - NOTE: This won't delete the backup files, just the backup information in MCSS
String	getBackupID()	Gets the backup ID
String	getBackupName()	Gets the backup name
LocalDateTime	getCompletedAt()	Gets the last completion date/time of the backup
BackupCompressionType	getCompressionType()	Gets the compression type of the backup
String	getDestination()	Gets the destination of the backup
ArrayList<String>	getFileBlacklist()	Gets the file blacklist of the backup
ArrayList<String>	getFolderBlacklist()	Gets the folder blacklist of the backup
LastBackupState	getLastBackupState()	Gets the last backup state of the backup This value is updated every time the method is run, hence why all the other exceptions
boolean	isDeleteOldBackups()	Gets whether the backup deletes old backups
boolean	isSuspended()	Gets whether the backup is suspended
void	runBackup()	Manually run a backup
void	setBackupName(String backupName)	Sets the backup name
void	setCompressionType(BackupCompressionType compressionType)	Sets the compression type of the backup
void	setDeleteOldBackups(boolean deleteOldBackups)	Sets if old backups should be deleted (following MCSS config)
void	setDestination(String destination)	Sets the destination of the backup
void	setFileBlacklist(String... fileBlacklist)	Sets the file blacklist for the backup
void	setFileBlacklist(ArrayList<String> fileBlacklist)	Sets the file blacklist for the backup
void	setFolderBlacklist(String... folderBlacklist)	Sets the folder blacklist for the backup
void	setFolderBlacklist(ArrayList<String> folderBlacklist)	Sets the folder blacklist for the backup
void	setSuspendServer(boolean suspendServer)	Sets if the backup should suspend the server (shutdown) before creating the backup
void	updateDetails()	Updates all details of the backup from the API

Methods inherited from class java.lang.Object

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

Constructor Details

Backup

protected Backup(MCSSApi api,
 String serverID,
 String backupID)
          throws APIUnauthorizedException,
IOException,
APINoServerAccessException,
APINotFoundException

Creates a new Backup object - ONLY MADE BY THE SERVER OBJECT

Parameters:

api - MCSS API instance

serverID - Server ID of the origin server

backupID - Backup ID of the backup

Throws:

APIUnauthorizedException - If the API key is invalid

IOException - If there is an error connecting to the API

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

Method Details

getBackupID

public String getBackupID()
                   throws IllegalStateException

Gets the backup ID

Returns:

STRING Backup ID

Throws:

IllegalStateException - If the backup has been deleted

getBackupName

public String getBackupName()
                     throws IllegalStateException

Gets the backup name

Returns:

STRING Backup name

Throws:

IllegalStateException - If the backup has been deleted

getDestination

public String getDestination()
                      throws IllegalStateException

Gets the destination of the backup

Returns:

STRING Destination of the backup

Throws:

IllegalStateException - If the backup has been deleted

isSuspended

public boolean isSuspended()
                    throws IllegalStateException

Gets whether the backup is suspended

Returns:

BOOLEAN Whether the backup is suspended

Throws:

IllegalStateException - If the backup has been deleted

isDeleteOldBackups

public boolean isDeleteOldBackups()
                           throws IllegalStateException

Gets whether the backup deletes old backups

Returns:

BOOLEAN Whether the backup deletes old backups

Throws:

IllegalStateException - If the backup has been deleted

getCompressionType

public BackupCompressionType getCompressionType()
                                         throws IllegalStateException

Gets the compression type of the backup

Returns:

BackupCompressionType Compression type of the backup

Throws:

IllegalStateException - If the backup has been deleted

getFileBlacklist

public ArrayList<String> getFileBlacklist()
                                   throws IllegalStateException

Gets the file blacklist of the backup

Returns:

ARRAYLIST File blacklist of the backup

Throws:

IllegalStateException - If the backup has been deleted

getFolderBlacklist

public ArrayList<String> getFolderBlacklist()
                                     throws IllegalStateException

Gets the folder blacklist of the backup

Returns:

ARRAYLIST Folder blacklist of the backup

Throws:

IllegalStateException - If the backup has been deleted

getCompletedAt

public LocalDateTime getCompletedAt()
                             throws IllegalStateException

Gets the last completion date/time of the backup

Returns:

LOCALDATETIME Completed at date of the backup

Throws:

IllegalStateException - If the backup has been deleted

getLastBackupState

public LastBackupState getLastBackupState()
                                   throws IllegalStateException,
APIUnauthorizedException,
IOException,
APINoServerAccessException,
APINotFoundException

Gets the last backup state of the backup This value is updated every time the method is run, hence why all the other exceptions

Returns:

LastBackupState Last backup state of the backup

Throws:

IllegalStateException - If the backup has been deleted

APIUnauthorizedException - If the API key is invalid

IOException - If there is an error connecting to the API

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

setBackupName

public void setBackupName(String backupName)
                   throws IllegalStateException,
APIUnauthorizedException,
IOException,
APINoServerAccessException,
APINotFoundException

Sets the backup name

Parameters:

backupName - Backup name

Throws:

IllegalStateException - If the backup has been deleted

APIUnauthorizedException - If the API key is invalid

IOException - If there is an error connecting to the API

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

setDestination

public void setDestination(String destination)
                    throws IllegalStateException,
APIUnauthorizedException,
IOException,
APINoServerAccessException,
APINotFoundException

Sets the destination of the backup

Parameters:

destination - Absolute PATH - destination of the backup - Use double \\ for folders

Throws:

IllegalStateException - If the backup has been deleted

APIUnauthorizedException - If the API key is invalid

IOException - If there is an error connecting to the API

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

setCompressionType

public void setCompressionType(BackupCompressionType compressionType)
                        throws IllegalStateException,
APIUnauthorizedException,
IOException,
APINoServerAccessException,
APINotFoundException

Sets the compression type of the backup

Parameters:

compressionType - Compression type of the backup

Throws:

IllegalStateException - If the backup has been deleted

APIUnauthorizedException - If the API key is invalid

IOException - If there is an error connecting to the API

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

setSuspendServer

public void setSuspendServer(boolean suspendServer)
                      throws IllegalStateException,
APIUnauthorizedException,
IOException,
APINoServerAccessException,
APINotFoundException

Sets if the backup should suspend the server (shutdown) before creating the backup

Parameters:

suspendServer - If the server should be suspended

Throws:

IllegalStateException - If the backup has been deleted

APIUnauthorizedException - If the API key is invalid

IOException - If there is an error connecting to the API

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

setDeleteOldBackups

public void setDeleteOldBackups(boolean deleteOldBackups)
                         throws IllegalStateException,
APIUnauthorizedException,
IOException,
APINoServerAccessException,
APINotFoundException

Sets if old backups should be deleted (following MCSS config)

Parameters:

deleteOldBackups - If old backups should be deleted

Throws:

IllegalStateException - If the backup has been deleted

APIUnauthorizedException - If the API key is invalid

IOException - If there is an error connecting to the API

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

setFileBlacklist

public void setFileBlacklist(ArrayList<String> fileBlacklist)
                      throws IOException,
APIUnauthorizedException,
APINoServerAccessException,
APINotFoundException

Sets the file blacklist for the backup

Parameters:

fileBlacklist - ArrayList of the new blacklist

Throws:

IOException - If there is an error connecting to the API

APIUnauthorizedException - If the API key is invalid

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

setFileBlacklist

public void setFileBlacklist(String... fileBlacklist)
                      throws IOException,
APIUnauthorizedException,
APINoServerAccessException,
APINotFoundException

Sets the file blacklist for the backup

Parameters:

fileBlacklist - collection of strings of the new blacklist

Throws:

IOException - If there is an error connecting to the API

APIUnauthorizedException - If the API key is invalid

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

setFolderBlacklist

public void setFolderBlacklist(ArrayList<String> folderBlacklist)
                        throws IOException,
APIUnauthorizedException,
APINoServerAccessException,
APINotFoundException

Sets the folder blacklist for the backup

Parameters:

folderBlacklist - ArrayList of the new folder blacklist

Throws:

IOException - If there is an error connecting to the API

APIUnauthorizedException - If the API key is invalid

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

setFolderBlacklist

public void setFolderBlacklist(String... folderBlacklist)
                        throws IOException,
APIUnauthorizedException,
APINoServerAccessException,
APINotFoundException

Sets the folder blacklist for the backup

Parameters:

folderBlacklist - Collection of strings of the new folder blacklist

Throws:

IOException - If there is an error connecting to the API

APIUnauthorizedException - If the API key is invalid

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

updateDetails

public void updateDetails()
                   throws IOException,
APIUnauthorizedException,
APINoServerAccessException,
APINotFoundException

Updates all details of the backup from the API

Throws:

IOException - If there is an error connecting to the API

APIUnauthorizedException - If the API key is invalid

APINoServerAccessException - If the API key does not have access to the server

APINotFoundException - If the server or backup does not exist

deleteBackup

public void deleteBackup()
                  throws APIUnauthorizedException,
APINotFoundException,
APINoServerAccessException,
IOException

Delete the backup - NOTE: This won't delete the backup files, just the backup information in MCSS

Throws:

APIUnauthorizedException - If the API key is invalid

APINotFoundException - If the server or backup does not exist

APINoServerAccessException - If the API key does not have access to the server

IOException - If there is an error connecting to the API

runBackup

public void runBackup()
               throws APIUnauthorizedException,
APINotFoundException,
APINoServerAccessException,
IOException

Manually run a backup

Throws:

APIUnauthorizedException - If the API key is invalid

APINotFoundException - If the server or backup does not exist

APINoServerAccessException - If the API key does not have access to the server

IOException - If there is an error connecting to the API