LiveSupport::Scheduler::UploadPlaylistMethod Class Reference

#include <UploadPlaylistMethod.h>

Inheritance diagram for LiveSupport::Scheduler::UploadPlaylistMethod:

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

[legend]List of all members.

---

Detailed Description

An XML-RPC method object to accept a playlist for upload, and schedule it in the scheduler.

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

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
• playlistId – string – the id of the playlist to upload
• playtime – datetime – the time when the playlist should be scheduled, an ISO 8601 DateTime field

The playlistId parameter is a string containing the hexadecimal value of the playlist ID. It is up to 8 characters long, representing a value between 0 and 2^31-1, inclusive.

If the upload is successful, the method returns an XML-RPC structure with the following members:

• scheduleEntryId – string – the id of the schedule entry created by the upload

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

• 1401 – invalid argument format
• 1402 – missing playlist ID argument
• 1403 – missing playtime argument
• 1404 – playlist not found
• 1405 – timeframe not available
• 1406 – could not schedule playlist
• 1420 – missing session ID argument

Author:

Author

fgerlits

Version:

Revision

2645

Definition at line 112 of file UploadPlaylistMethod.h.

Public Member Functions
	UploadPlaylistMethod (void) throw ()
	A default constructor, for testing purposes.
	UploadPlaylistMethod (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 upload playlist command on the Scheduler daemon.

---

Constructor & Destructor Documentation

LiveSupport::Scheduler::UploadPlaylistMethod::UploadPlaylistMethod

(

void

)

throw () [inline]

A default constructor, for testing purposes.

Definition at line 131 of file UploadPlaylistMethod.h.

UploadPlaylistMethod::UploadPlaylistMethod

(

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 88 of file UploadPlaylistMethod.cxx.

---

Member Function Documentation

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

Execute the upload playlist command on the Scheduler daemon.

Parameters:

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

Definition at line 99 of file UploadPlaylistMethod.cxx.

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

---

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

• UploadPlaylistMethod.h
• UploadPlaylistMethod.cxx

---