com.mambu.apisdk.services

Class DatabaseService

java.lang.Object

com.mambu.apisdk.services.DatabaseService

public class DatabaseService
extends java.lang.Object

Service class which handles the API operations available for the database management (e.g. backups)

Constructor Summary

Constructors

Constructor and Description
DatabaseService(MambuAPIService mambuAPIService) Create a new Database service

Method Summary

Modifier and Type	Method and Description
DatabaseBackupResponse	createDatabaseBackup(DatabaseBackupRequest databaseBackupRequest) Triggers the process of creating a DB backup.
DatabaseBackup	downloadLatestDbBackup() Downloads the last DB backup if there is one.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseService

@Inject
public DatabaseService(MambuAPIService mambuAPIService)

Create a new Database service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

createDatabaseBackup

public DatabaseBackupResponse createDatabaseBackup(DatabaseBackupRequest databaseBackupRequest)
                                            throws MambuApiException

Triggers the process of creating a DB backup. Be aware that creating a DB backup is a long running process and the response after calling this method is just a confirmation that the process started successfully to create the backup.

Parameters:

databaseBackupRequest - The request object for the database backup API containing the callback URL that will be used by webhooks to send the successful backup message after backup creation on S3 server. Callback URL must be valid if provided.

Returns:

A wrapper object containing the return status and code for the database backup trigger.

Throws:

MambuApiException

downloadLatestDbBackup

public DatabaseBackup downloadLatestDbBackup()
                                      throws MambuApiException

Downloads the last DB backup if there is one.

Returns:

A DatabaseBackup wrapper containing the DB backup as a ByteArrayOutputStream.

Throws:

MambuApiException