com.abiquo.api.resources.FileSystemResource Class Reference

This class represents a FileSystemResource, and allows interaction with remote file systems. More...

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

List of all members.

Public Member Functions

FileSystemResource ()

Creates a new FileSystemResource with the default values.

FileSystemResource (ResourceInstance resourceInstance)

Creates a new FileSystemResource based on a generic ResourceInstance.

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

Creates a new FileSystemResource based on the parameters.

Job deploy (File file) throws IOException

Creates a new Job which once executed, deploys a file on the remote file system.

Job deploy (String name, String content, boolean isEncoded)

Creates a new Job which once executed, deploys ("upload") a file on the remote file system.

Job getStatus (String session)

Creates a new Job which once executed, returns the status of a file located on a remote file system.

Job list ()

Creates a new Job which once executed, returns a list of files on the remote file system.

Job remove (String session)

Creates a new Job which once executed, removes a file on the remote file systems.

Job retrieve (String session)

Creates a new Job which once executed, retrieves ("download") a file on the remote file system.

Static Public Member Functions

static FileSystemResource cast (ResourceInstance resourceInstance)

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

Static Public Attributes

static final String ID = "FileSystem"

String containing the identifier for this resource.

Detailed Description

This class represents a FileSystemResource, and allows interaction with remote file systems.

Note:

XML description of the resource:

 <?xml version="1.0" encoding="utf-8"?>
 <Resource xmlns="http://www.abiquo.com/schema/Domain.xsd" LocalId="FileSystemResource">
     <FunctionalityList >
       <Functionality LocalId="deploy" ReturnType="DataReference">
         <AttributeList>
           <Attribute Name="Input" Type="DataReference" />
         </AttributeList>
       </Functionality>
       <Functionality LocalId="retrieve" ReturnType="DataReference">
         <AttributeList>
           <Attribute Name="Session" Type="String" />
         </AttributeList>
       </Functionality>
       <Functionality LocalId="getStatus" ReturnType="DataReference">
         <AttributeList>
           <Attribute Name="Session" Type="String" />
         </AttributeList>
       </Functionality>
       <Functionality LocalId="remove" ReturnType="DataReference">
           <AttributeList>
             <Attribute Name="Session" Type="String" />
           </AttributeList>
       </Functionality>
       <Functionality LocalId="list" ReturnType="void"/>
     </FunctionalityList>
 </Resource>

Constructor & Destructor Documentation

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

Creates a new FileSystemResource based on a generic ResourceInstance.

Parameters:

resourceInstance

The generic ResourceInstance

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

Creates a new FileSystemResource based on the parameters.

Parameters:

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

Member Function Documentation

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

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

Parameters:

resourceInstance

The generic ResourceInstance

Returns:: The resultant FileSystemResource

Reimplemented in com.abiquo.api.resources.FlickrResource.

Job com.abiquo.api.resources.FileSystemResource.deploy ( File file ) throws IOException

Creates a new Job which once executed, deploys a file on the remote file system.

Parameters:

file

The file to deploy

Returns:: The Job to perform the demand

Exceptions:

IOException

Signals that an I/O exception has occurred.

Job com.abiquo.api.resources.FileSystemResource.deploy	(	String	name,
		String	content,
		boolean	isEncoded
	)

Creates a new Job which once executed, deploys ("upload") a file on the remote file system.

Parameters:

	name	The name of the file to deploy
	content	The content to deploy
	isEncoded	If the content is already on Base64

Returns:: The Job to perform the demand

Job com.abiquo.api.resources.FileSystemResource.getStatus ( String session )

Creates a new Job which once executed, returns the status of a file located on a remote file system.

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

Parameters:

session

The file session identifier

Returns:: The status for that file

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

Creates a new Job which once executed, returns a list of files on the remote file system.

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

Returns:: The Job to perform the demand

Reimplemented in com.abiquo.api.resources.FlickrResource.

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

Creates a new Job which once executed, removes a file on the remote file systems.

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

Parameters:

session

The file session identifier

Returns:: The Job to perform the demand

Reimplemented in com.abiquo.api.resources.FlickrResource.

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

Creates a new Job which once executed, retrieves ("download") a file on the remote file system.

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

Parameters:

sessio

The file session identifier

Returns:: The Job to perform the demand

Reimplemented in com.abiquo.api.resources.FlickrResource.

Member Data Documentation

final String com.abiquo.api.resources.FileSystemResource.ID = "FileSystem" [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 in com.abiquo.api.resources.FlickrResource.

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

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


Public Member Functions
	FileSystemResource ()
	Creates a new FileSystemResource with the default values.
	FileSystemResource (ResourceInstance resourceInstance)
	Creates a new FileSystemResource based on a generic ResourceInstance.
	FileSystemResource (String localId, InstanceName instanceName, List< Property > propertiesList)
	Creates a new FileSystemResource based on the parameters.
Job	deploy (File file) throws IOException
	Creates a new Job which once executed, deploys a file on the remote file system.
Job	deploy (String name, String content, boolean isEncoded)
	Creates a new Job which once executed, deploys ("upload") a file on the remote file system.
Job	getStatus (String session)
	Creates a new Job which once executed, returns the status of a file located on a remote file system.
Job	list ()
	Creates a new Job which once executed, returns a list of files on the remote file system.
Job	remove (String session)
	Creates a new Job which once executed, removes a file on the remote file systems.
Job	retrieve (String session)
	Creates a new Job which once executed, retrieves ("download") a file on the remote file system.
Static Public Member Functions
static FileSystemResource	cast (ResourceInstance resourceInstance)
	Converts a generic ResourceInstance into a new one of type FileSystemResource.
Static Public Attributes
static final String	ID = "FileSystem"
	String containing the identifier for this resource.