rawsc.rase.service.RaseService Class Reference

Inherits rawsc.service.RawsService.

List of all members.

---

Detailed Description

RaseService extends RawsService to provide an interface for RASE requests.

Public Member Functions
def	__init__
def	delete
def	getPortFeed
def	getPort
def	createPort
def	updatePort
def	getWowappFeed
def	getWowapp
def	createWowsdp
def	getWowsdpFeed
def	getWowsdp
def	updateWowsdp
def	getWowsdpFile
def	createMpegts
def	getMpegts
def	getMpegtsFeed
def	updateMpegts
def	getSniffFeed
def	getSniffFeedForWowsdp

---

Member Function Documentation

def rawsc.rase.service.RaseService.__init__	(		self,
			username = None,
			password = None,
			source = None,
			server = SERVER_DEFAULT,
			port = None,
			additional_headers = None,
			handler = None,
			ssl = False
	)

Creates an object of type RawsService.

Args: username: string (optional) The username for authentication. password: string (optional) The user's password. source: string (optional) The name of the user's application. server: string (optional) The name of the server to which a connection will be opened. (eg 'rass.cdn01.rambla.be'). additional_headers: dictionary (optional) Any additional headers which should be included with CRUD operations. handler: module (optional) The module whose HttpRequest function should be used when making requests to the server. The default value is atom.service. ssl: bool (optional) Use SSL encryption.

Reimplemented from rawsc.service.RawsService.

def rawsc.rase.service.RaseService.delete	(		self,
			uri
	)

Deletes any resource, given the uri.

def rawsc.rase.service.RaseService.getPortFeed	(		self,
			query = None
	)

Retrieves a port feed.

Parameters:

query

rawsc.Query object that contains queryset args.

Returns:

PortFeed object

def rawsc.rase.service.RaseService.getPort	(		self,
			uri
	)

Retrieves a port entry.

Parameters:

uri

path (relative or absolute) to the port instance.

Returns:

PortEntry object

def rawsc.rase.service.RaseService.createPort	(		self,
			nr_of_ports,
			description = None
	)

Claim ports (= POST /port/).

Returns:

PortEntry object

def rawsc.rase.service.RaseService.updatePort	(		self,
			entry,
			uri = None
	)

Update an existing port resource, using a PUT request.

Parameters:

	entry,:	the complete entry, containing the changed params
	uri	location of the instance to be updated, if None it will be retrieved from the entry

def rawsc.rase.service.RaseService.getWowappFeed	(		self,
			query = None
	)

Retrieves a wowapp feed.

Parameters:

query

rawsc.Query object that contains queryset args.

Returns:

WowappFeed object

def rawsc.rase.service.RaseService.getWowapp	(		self,
			uri
	)

Retrieves a wowapp entry.

Parameters:

uri

path (relative or absolute) to the wowapp instance.

Returns:

WowappEntry object

def rawsc.rase.service.RaseService.createWowsdp	(		self,
			filename,
			local_path
	)

Tries to POST a new wowsdp resource to RASE.

Parameters:

	filename	filename to be given to the uploaded file on the RASE server.
	local_path	location of the file to be uploaded on the local machine

Returns:

WowsdpEntry object

def rawsc.rase.service.RaseService.getWowsdpFeed	(		self,
			query = None
	)

Retrieves a wowsdp feed.

Parameters:

query

rawsc.Query object that contains queryset args.

Returns:

WowsdpFeed object

def rawsc.rase.service.RaseService.getWowsdp	(		self,
			uri
	)

Retrieves a wowsdp entry.

Parameters:

uri

path (relative or absolute) to the wowsdp instance.

Returns:

WowsdpEntry object

def rawsc.rase.service.RaseService.updateWowsdp	(		self,
			entry,
			uri = None
	)

Update an existing wowsdp resource, using a PUT request.

Parameters:

	entry,:	the complete entry, containing the changed params
	uri	location of the instance to be updated, if None it will be retrieved from the entry

def rawsc.rase.service.RaseService.getWowsdpFile	(		self,
			uri,
			local_path = None
	)

Downloads a transc file and (optionally) saves it to a local file location.

If local_path is given, an attempt is made to save the downloaded file and an exception is thrown in case of failure. If local_path is None, the downloaded file is not stored. The caller should store it himself using the file_handle attribute of the returned MediaSource object.

Parameters:

	uri	path (relative or absolute) to the transc media item.
	local_path	full path, including the filename, to a location where the downloaded file can be stored.

Returns:

rawsc.MediaSource object

def rawsc.rase.service.RaseService.createMpegts	(		self,
			wowapp,
			ip_address = None,
			description = None
	)

Create a new mpegts resource by posting the params to RASE.

Parameters:

	wowapp	: ID of the wowza application to be used for streaming
	ip_address	: IP Address of the encoder

Returns:

MpegtsEntry object

def rawsc.rase.service.RaseService.getMpegts	(		self,
			uri
	)

Retrieves a mpegts entry.

Parameters:

uri

path (relative or absolute) to the mpegts instance.

Returns:

MpegtsEntry object

def rawsc.rase.service.RaseService.getMpegtsFeed	(		self,
			query = None
	)

Retrieves a mpegts feed.

Parameters:

query

rawsc.Query object that contains queryset args.

Returns:

MpegtsFeed object

def rawsc.rase.service.RaseService.updateMpegts	(		self,
			entry,
			uri = None
	)

Update an existing mpegts resource, using a PUT request.

Parameters:

	entry,:	the complete entry, containing the changed params
	uri	location of the instance to be updated, if None it will be retrieved from the entry

def rawsc.rase.service.RaseService.getSniffFeed	(		self,
			uri,
			query = None
	)

Retrieves a sniff feed.

Parameters:

	uri	Uri at which the sniff resource is located.
	query	rawsc.Query object that contains queryset args.

Returns:

SniffFeed object

def rawsc.rase.service.RaseService.getSniffFeedForWowsdp	(		self,
			id,
			query = None
	)

Retrieves a sniff feed.

Parameters:

	id	Id of the wowsdp to sniff for.
	query	rawsc.Query object that contains queryset args.

Returns:

SniffFeed object

---