LiveSupport::Scheduler::RestoreBackupMethod Class Reference

#include <RestoreBackupMethod.h>

Inheritance diagram for LiveSupport::Scheduler::RestoreBackupMethod:

[legend]Collaboration diagram for LiveSupport::Scheduler::RestoreBackupMethod:

[legend]List of all members.

---

Detailed Description

An XML-RPC method object to restore a schedule backup.

The name of the method when called through XML-RPC is “restoreBackup”.

The expected parameter is an XML-RPC structure with these members:

• sessionId – string – the session ID obtained via the login() method of the authentication client;
• path – string – the local path and filename of the backup archive to be restored.

In case of an error, a standard XML-RPC fault response is generated, and a { faultCode, faultString } structure is returned. The possible errors are:

• 4501 – invalid argument format
• 4502 – missing path argument
• 4510 – error reported by the scheduler daemon
• 4520 – missing session ID argument

Author:

Author

fgerlits

Version:

Revision

2329

Definition at line 85 of file RestoreBackupMethod.h.

Public Member Functions
	RestoreBackupMethod (void) throw ()
	A default constructor, for testing purposes.
	RestoreBackupMethod (Ptr< XmlRpc::XmlRpcServer >::Ref xmlRpcServer) throw ()
	Constuctor that registers the method with the server right away.
void	execute (XmlRpc::XmlRpcValue &parameters, XmlRpc::XmlRpcValue &returnValue) throw (XmlRpc::XmlRpcException)
	Execute the createBackupOpen command on the Scheduler daemon.

---

Constructor & Destructor Documentation

LiveSupport::Scheduler::RestoreBackupMethod::RestoreBackupMethod

(

void

)

throw () [inline]

A default constructor, for testing purposes.

Definition at line 104 of file RestoreBackupMethod.h.

RestoreBackupMethod::RestoreBackupMethod

(

Ptr< XmlRpc::XmlRpcServer >::Ref

xmlRpcServer

)

throw ()

Constuctor that registers the method with the server right away.

Parameters:

xmlRpcServer

the XML-RPC server to register with.

Definition at line 68 of file RestoreBackupMethod.cxx.

---

Member Function Documentation

void RestoreBackupMethod::execute	(	XmlRpc::XmlRpcValue &	parameters,
		XmlRpc::XmlRpcValue &	returnValue
	)			throw (XmlRpc::XmlRpcException)

Execute the createBackupOpen command on the Scheduler daemon.

Parameters:

	parameters	XML-RPC function call parameters
	returnValue	the return value of the call (out parameter)

Definition at line 80 of file RestoreBackupMethod.cxx.

References LiveSupport::Core::XmlRpcException::what().

---

The documentation for this class was generated from the following files:

• RestoreBackupMethod.h
• RestoreBackupMethod.cxx

---