General

Infrascale Online Backup Recovery Manager (OBRM) includes SDK to provide reliable integration with external systems in scope of client PC.

It supports direct calls like start jobs, getting statistics etc.

Also client can subscribe callbacks to receive notifications   

OBRM SDK Components

• OBRM 7.X.X.X and higher  - implements direct/callbacks operations as WCF service based .net pipes binding
• SOS.SDK.dll - standalone library without external dependencies that defines contracts and DTOs, provides mail class InfrascaleClient to connect to OBRM Agent Service
• SOS.SDK.Console - demo client to show how integration works

Client prerequisites

• .NET 4.5 or higher
• OBRM 7.X.X.X and higher 
• SOS.SDK.dll should be used by client application as contracts definitions, 
• Infrascale extends SDK contracts by keeping compatibility with old clients 
• SDK does not support non Windows OS    
  
  

Contract: IInfrascaleSdk 

Service contract that supports direct calls. Supported operations:  

Operation: SingIn 

Creates session for specific backup account.

Returns  Identity that must be used for all further operations

Input fields: 

Output  fields: 

Faults: 

• InvalidUsernameOrPassword
• AccountNotActive
• MethodCallFailed 
  
  

Operation: GetAccountInfo

Returns information about signed in account.

Input fields:

Output fields:

Faults: 

• IsNotSignedIn
• MethodCallFailed

      [Test]
        public void GetAccountInfo_Ok()
        {
            _client = new InfrascaleClient();
            _client.Connect();
            var signInResponse = _client.SignIn(new SignInRequest { Credentials = new CredentialsContract { Login = _testAccount, Password = _testAccountPassword } });

            var accountInfo = _client.GetAccountInfo(new GetAccountInfoRequest { Identity = signInResponse.Identity});
            Tools.PrintAccountInfo(accountInfo.AccountInfo);

            _client.SignOut(new SignOutRequest { Identity = signInResponse.Identity });
            _client.Disconnect();
        }

Login: sdk.test@sosonlinebackup.com
Account Size: 10737418240
UsedSpace: 0
Email: sdk.test@sosonlinebackup.com
Is blocked by overquota: False
SecurityType: Regular
Send backup report by email: False

Operation: SubscribeCallback

Allows to receive notification about events are occurred in scope of specific backup account   

 Input fields: 

Output  fields: N/A

Faults: 

• MethodCallFailed 

Operation: UnsubscribeCallback

 Stops receiving notification about events are occurred in scope of specific backup account   

 Input fields: 

Output  fields: N/A

Faults: 

• MethodCallFailed 

Operation: GetJobSession

Retrieves job's state by JobId  

 Input fields: 

 Output  fields: 

 Faults:

•  MethodCallFailed 

Operation: RunRefreshRecoveryInfoJob

Operation: GetRecoveryItems

        [Test]
        public void ExtarctAllRecoveryTree_Ok()
        {
            //Init SDK
            _client = new InfrascaleClient();
            _client.Connect();
            
            var signInResponse = _client.SignIn(new SignInRequest { Credentials = new CredentialsContract { Login = _testAccount, Password = _testAccountPassword } });

            RefreshRecoveryInfo(signInResponse.Identity);

            //Extract metadata items
            var request = new GetRecoveryItemsRequest
            {
                Identity = signInResponse.Identity,
                Path = Environment.MachineName
            };
            var output = _client.GetRecoveryItems(request);
            
            //Handle files tree
            PrintTree(output);

            //Detach client 
            _client.SignOut(new SignOutRequest { Identity = signInResponse.Identity });
            _client.Disconnect();
        }

        public static void PrintTree(GetRecoveryItemsResponse response)
        {
            Action<RecoveryItemContract, int> handleLevel = null;
            handleLevel = (treeItem, level) =>
            {
                var padding = Enumerable.Range(0, level).Aggregate(new StringBuilder(), (sb, i) => sb.Append(" "));
                var dir = treeItem as RecoveryDirectoryContract;
                if (dir != null)
                {
                    foreach (var dirItem in dir.Children)
                    {
                        if (dirItem is RecoveryDirectoryContract)
                            Console.WriteLine(padding + dirItem.Path);
                        else
                            Console.WriteLine(padding + Path.GetFileName(dirItem.Path));
                        handleLevel(dirItem, level + 1);
                    }
                }
            };

            foreach (var item in response.Items)
            {
                Console.WriteLine(item.Path);
                handleLevel(item, 0);
            }
        }

         public static void RefreshRecoveryInfo(IdentityContract identity)
        {
            _client.SubscribeCallback(new SubscribeCallbackRequest
            {
                Identity = identity
            });

            bool isCompleted = false;

            Action<JobSessionContract> isCompletedFunc = contract =>
                isCompleted = contract.JobType == JobTypeContract.RefreshRecoveryInfo;

            _client.JobCompleted += isCompletedFunc;

            _client.RunRefreshRecoveryInfoJob(new RunRefreshRecoveryInfoJobRequest { Identity = identity });

            while (!isCompleted)
            {
                Thread.Sleep(100);
            }

            _client.JobCompleted -= isCompletedFunc;
        }

ALEXK\C:
ALEXK\D:

Sample filter to get items  for the last 7 days where filename contains "123", size between 1 byte and 1 megabyte and located on disc C:


var filter = new RecoveryFilterContract
                {
                    DateFrom = DateTime.Today.AddDays(-7),
                    DateTo = DateTime.Today,
                    FileName = "123",
                    FileSizeInKbFrom = 1,
                    FileSizeInKbTo = 1024,
                    PathFilter = "C:\\"
                }

Event: JobStarted

Occurs when new job starts executing

Fields: 

Event: JobProgress

Occurs when job progress is updated

 Fields: 

Event: JobCompleted

Occurs when job is completed 

 Fields: 

Event: JobEvents

Occurs when something is happened during backup 

 Fields: 

        [Test]
        public void ListenBackupEvents_Ok()
        {
            _client = new InfrascaleClient();
            _client.Connect();
            var signInResponse = _client.SignIn(new SignInRequest { Credentials = new CredentialsContract { Login = _testAccount, Password = _testAccountPassword } });

            _client.JobStarted += s => Tools.PrintBackupSession("Backup Started", s as BackupJobSessionContract);
            _client.JobProgress += s => Tools.PrintBackupSession("Backup Progress", s as BackupJobSessionContract);
            _client.JobCompleted += s => Tools.PrintBackupSession("Backup Completed", s as BackupJobSessionContract);

            _client.SubscribeCallback(new SubscribeCallbackRequest { Identity = signInResponse.Identity});

            _backupProcess = Tools.EmulateBackup(_testStorageDb, _storageDbBackupPath, _storageDbPath, _testAccount, _testAccountPassword, _obrmFolder);
            _backupProcess.WaitForExit(300000);

            _client.SignOut(new SignOutRequest { Identity = signInResponse.Identity });
            _client.Disconnect();
        }

Event: Backup Started
JobType: Backup
ProgressPercentage: 0
CreatedUtc: 01.01.0001 0:00:00
StartedUtc: 
CompletedUtc: 
AccountLogin: 
State: Undefined
ErrorMessage: 


Event: Backup Completed
JobType: Backup
ProgressPercentage: 0
CreatedUtc: 01.01.0001 0:00:00
StartedUtc: 
CompletedUtc: 
AccountLogin: 
State: Undefined
ErrorMessage: 
Processed Files Count: 0
Processed Files Size: 0
Remaining Files Count: 0
Remaining Files Size: 0
Uploaded Files Count: 0
Uploaded Files Size: 0
Unchanged Files Count: 120
Unchanged Files Size: 3972
Failed Files Size: 0
Failed Files Size: 0

Data Contracts

JobSessionContract

Represents the job state

Fields: 

CountAndSizeContract

Represents couint and size of files

Fields: 

Operation: SetOnlineBackupSettings

Save Online Backup settings to the settings storage

 Input fields: 

Output fields (SetOnlineBackupSettingsResponse): 

Faults:
  MethodCallFailed 

Data Contracts

FileSetContract

FilesetDirContract

FilesetFileContract

FilesetExcludeItemContract

NetShareContract

Operation: GetOnlineBackupSettings

Get Online Backup settings from the settings storage

 Input fields: 

 Output fields (GetOnlineBackupSettingsResponse): 

Faults:
  MethodCallFailed 

Operation: RemoveOnlineBackupSettings

Remove existing Online Backup settings from the settings storage

 Input fields: 

 Output fields (RemoveOnlineBackupSettingsResponse): 

Faults:
  MethodCallFailed 

Operation: RunOnlineBackupJobRequest

Add new Online Backup job request using existing settings

 Input fields: 

 Output fields: RunOnlineBackupJobResponse (Nested from JobSessionContract)

Faults:
  MethodCallFailed 

Data Contracts

OnlineBackupJobContract

BackupJobEventContract

Backup engine reports about some operations, such as new backup request, starting of the calculation of the files hashes, skipping excluded files, issues etc.

This events is collected in the engine and after that SDK reports. Due to report threshold SDK can report about several events in the one callback.

BackupJobProgressContract

This event is sent in the BackupStarted and BackupProgress callbacks.

In the BackupCompleted callback this event include whole backup summary report.

FileStateContract

Operation: PauseOnlineBackupJobRequest

Pause the current backup session.

Pausing the current backup session, regardless of who launched it.

If there are other requests for backup in the queue, they will be paused too.

In the absence of active sessions, the Pause does nothing.

Operation: ResumeOnlineBackupJobRequest

Resume the current backup session (if paused).

Resume the current backup session after pausing, regardless of who launched/paused it.

In the absence of active sessions, the Resume does nothing.

Operation: CancelOnlineBackupJobRequest

Cancel the current backup session.

Cancels the current backup session, regardless of who launched it.

If there are other requests for backup in the queue, they will be executed immediately after the current session is canceled.

In the absence of active sessions, the Cancel does nothing.