com.abiquo.api.resources.FlickrResource Class Reference

This class represents a FlickrResource, and allows to interact with the Flickr Web service. More...

Inheritance diagram for com.abiquo.api.resources.FlickrResource:

List of all members.

Public Member Functions

FlickrResource ()

Creates a new FlickrResource with the default values.

FlickrResource (ResourceInstance resourceInstance)

Creates a new FlickrResource based on a generic ResourceInstance.

FlickrResource (String localId, InstanceName instanceName, List< Property > propertiesList)

Creates a new FlickrResource based on the parameters.

Job deploy (String localId)

Creates a new Job which once executed, uploads a photo to Flickr.

Job list ()

Creates a new Job which once executed, returns a list of the photos hosted at Flickr.

Job remove (String session)

Creates a new Job which once executed, removes a photo from Flickr.

Job retrieve (String session)

Creates a new Job which once executed, retrieves ("download") a photo from Flickr.

void setFlickrKey (String key)

Sets a new Flick user.

void setFlickrSecret (String secret)

Sets a new Flickr password.

Static Public Member Functions

static FlickrResource cast (ResourceInstance resourceInstance)

Converts a generic ResourceInstance into a new one of type FlickrResource.

Public Attributes

String key

Authentication id.

String secret

Authentication session token.

Static Public Attributes

static final String ID = "Flickr"

String containing the identifier for this resource.

Detailed Description

This class represents a FlickrResource, and allows to interact with the Flickr Web service.

Constructor & Destructor Documentation

com.abiquo.api.resources.FlickrResource.FlickrResource ( ResourceInstance resourceInstance )

Creates a new FlickrResource based on a generic ResourceInstance.

Parameters:

resourceInstance

The generic ResourceInstance

com.abiquo.api.resources.FlickrResource.FlickrResource	(	String	localId,
		InstanceName	instanceName,
		List< Property >	propertiesList
	)

Creates a new FlickrResource based on the parameters.

Parameters:

	name	The name of the resource
	instanceName	An InstanceName
	propertiesList	Properties list

Member Function Documentation

static FlickrResource com.abiquo.api.resources.FlickrResource.cast ( ResourceInstance resourceInstance ) [static]

Converts a generic ResourceInstance into a new one of type FlickrResource.

Parameters:

resourceInstance

The generic ResourceInstance

Returns:: The resultant FlickrResource

Reimplemented from com.abiquo.api.resources.FileSystemResource.

Job com.abiquo.api.resources.FlickrResource.deploy ( String localId )

Creates a new Job which once executed, uploads a photo to Flickr.

Parameters:

localId

The name of the photo to upload

Returns:: The Job containing information about the demand

Job com.abiquo.api.resources.FlickrResource.list ( )

Creates a new Job which once executed, returns a list of the photos hosted at Flickr.

<Functionality Name="list" ReturnType="">.
	 *

Returns:: The Job to perform the demand

Reimplemented from com.abiquo.api.resources.FileSystemResource.

Job com.abiquo.api.resources.FlickrResource.remove ( String session )

Creates a new Job which once executed, removes a photo from Flickr.

<Functionality Name="remove" ReturnType=""> <Attribute Name="Session" Type="string" />.
	 *

Parameters:

session

The file session identifier

Returns:: The Job to perform the demand

Reimplemented from com.abiquo.api.resources.FileSystemResource.

Job com.abiquo.api.resources.FlickrResource.retrieve ( String session )

Creates a new Job which once executed, retrieves ("download") a photo from Flickr.

<Functionality Name="retrieve" ReturnType=""> <Attribute Name="Session" Type="string" />.
	 *

Parameters:

session

The file session identifier

@return The Job to perform the demand

Reimplemented from com.abiquo.api.resources.FileSystemResource.

void com.abiquo.api.resources.FlickrResource.setFlickrKey ( String key )

Sets a new Flick user.

Parameters:

key

The new Flickr user

void com.abiquo.api.resources.FlickrResource.setFlickrSecret ( String secret )

Sets a new Flickr password.

Parameters:

secret

The new Flickr password

Member Data Documentation

final String com.abiquo.api.resources.FlickrResource.ID = "Flickr" [static]

String containing the identifier for this resource.

Note:: To avoid misspellings when provision a resource, you should use this constant ID instead of a manually typed string.

Reimplemented from com.abiquo.api.resources.FileSystemResource.

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

src/com/abiquo/api/resources/FlickrResource.java


Public Member Functions
	FlickrResource ()
	Creates a new FlickrResource with the default values.
	FlickrResource (ResourceInstance resourceInstance)
	Creates a new FlickrResource based on a generic ResourceInstance.
	FlickrResource (String localId, InstanceName instanceName, List< Property > propertiesList)
	Creates a new FlickrResource based on the parameters.
Job	deploy (String localId)
	Creates a new Job which once executed, uploads a photo to Flickr.
Job	list ()
	Creates a new Job which once executed, returns a list of the photos hosted at Flickr.
Job	remove (String session)
	Creates a new Job which once executed, removes a photo from Flickr.
Job	retrieve (String session)
	Creates a new Job which once executed, retrieves ("download") a photo from Flickr.
void	setFlickrKey (String key)
	Sets a new Flick user.
void	setFlickrSecret (String secret)
	Sets a new Flickr password.
Static Public Member Functions
static FlickrResource	cast (ResourceInstance resourceInstance)
	Converts a generic ResourceInstance into a new one of type FlickrResource.
Public Attributes
String	key
	Authentication id.
String	secret
	Authentication session token.
Static Public Attributes
static final String	ID = "Flickr"
	String containing the identifier for this resource.