LiveSupport::Scheduler::CreateBackupOpenMethod Class Reference

#include <CreateBackupOpenMethod.h>

Inheritance diagram for LiveSupport::Scheduler::CreateBackupOpenMethod:

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

[legend]List of all members.

---

Detailed Description

An XML-RPC method object to start a backup creation process.

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

The expected parameter is an XML-RPC structure, with the following members:

• sessionId – string – the session ID obtained via the login() method of the authentication client
• criteria – struct – the criteria to use for backing up the storage
• fromTime – datetime – entries are included in the schedule export starting from this time
• toTime – datetime – entries are included in the schedule export up to but not including this time

For the format of the criteria parameter, see the documentation of XR_LocStor::xr_searchMetadata().

On success, returns an XML-RPC struct with a single field:

• token – string – a token, which can be used to query the backup process

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

• 4001 – invalid argument format
• 4002 – missing criteria argument
• 4003 – missing fromTime argument
• 4004 – missing toTime argument
• 4010 – error reported by the scheduler daemon
• 4020 – missing session ID argument

Author:

Author

fgerlits

Version:

Revision

2329

Definition at line 110 of file CreateBackupOpenMethod.h.

Public Member Functions
	CreateBackupOpenMethod (void) throw ()
	A default constructor, for testing purposes.
	CreateBackupOpenMethod (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::CreateBackupOpenMethod::CreateBackupOpenMethod

(

void

)

throw () [inline]

A default constructor, for testing purposes.

Definition at line 129 of file CreateBackupOpenMethod.h.

CreateBackupOpenMethod::CreateBackupOpenMethod

(

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 84 of file CreateBackupOpenMethod.cxx.

---

Member Function Documentation

void CreateBackupOpenMethod::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 96 of file CreateBackupOpenMethod.cxx.

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

---

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

• CreateBackupOpenMethod.h
• CreateBackupOpenMethod.cxx

---