org.jclouds.cloudstack.features
Interface ISOAsyncClient

public interface ISOAsyncClient

Author:

Richard Downer

See Also:

ISOClient, http://download.cloud.com/releases/2.2.12/api/TOC_User.html

Method Summary

com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse>	attachISO(String isoId, String vmId) Attaches an ISO to a virtual machine.
com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse>	copyISO(String isoId, String sourceZoneId, String destZoneId) Copies a template from one zone to another.
com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse>	deleteISO(String id, DeleteISOOptions... options) Deletes an ISO file.
com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse>	detachISO(String vmId) Detaches any ISO file (if any) currently attached to a virtual machine.
com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse>	extractISO(String id, ExtractMode mode, String zoneId, ExtractISOOptions... options) Extracts an ISO
com.google.common.util.concurrent.ListenableFuture<ISO>	getISO(String id) Gets information about an ISO by its ID.
com.google.common.util.concurrent.ListenableFuture<ISOPermissions>	listISOPermissions(String id, AccountInDomainOptions... options) List template visibility and all accounts that have permissions to view this template.
com.google.common.util.concurrent.ListenableFuture<Set<ISO>>	listISOs(ListISOsOptions... options) Lists all available ISO files.
com.google.common.util.concurrent.ListenableFuture<ISO>	registerISO(String name, String displayText, String url, String zoneId, RegisterISOOptions... options) Registers an existing ISO into the Cloud.com Cloud.
com.google.common.util.concurrent.ListenableFuture<ISO>	updateISO(String id, UpdateISOOptions... options)
com.google.common.util.concurrent.ListenableFuture<Void>	updateISOPermissions(String id, UpdateISOPermissionsOptions... options) Updates iso permissions

Method Detail

attachISO

@Named(value="attachIso")
com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse> attachISO(String isoId,
                                                                                        String vmId)

Attaches an ISO to a virtual machine.

Parameters:

isoId - the ID of the ISO file

vmId - the ID of the virtual machine

Returns:

an asynchronous job response.

detachISO

@Named(value="detachIso")
com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse> detachISO(String vmId)

Detaches any ISO file (if any) currently attached to a virtual machine.

Parameters:

vmId - The ID of the virtual machine

Returns:

an asynchronous job response.

getISO

@Named(value="listIsos")
com.google.common.util.concurrent.ListenableFuture<ISO> getISO(String id)

Gets information about an ISO by its ID.

Parameters:

id - the ID of the ISO file

Returns:

the ISO object matching the ID

listISOs

@Named(value="listIsos")
com.google.common.util.concurrent.ListenableFuture<Set<ISO>> listISOs(ListISOsOptions... options)

Lists all available ISO files.

Parameters:

options - optional arguments

Returns:

a set of ISO objects the match the filter

registerISO

@Named(value="registerIso")
com.google.common.util.concurrent.ListenableFuture<ISO> registerISO(String name,
                                                                          String displayText,
                                                                          String url,
                                                                          String zoneId,
                                                                          RegisterISOOptions... options)

Registers an existing ISO into the Cloud.com Cloud.

Parameters:

name - the name of the ISO

displayText - the display text of the ISO. This is usually used for display purposes.

url - the URL to where the ISO is currently being hosted

zoneId - the ID of the zone you wish to register the ISO to.

options - optional arguments

Returns:

the newly-added ISO

updateISO

@Named(value="updateIso")
com.google.common.util.concurrent.ListenableFuture<ISO> updateISO(String id,
                                                                        UpdateISOOptions... options)

Parameters:

id - the ID of the ISO file

options - optional arguments

Returns:

the ISO object matching the ID

deleteISO

@Named(value="deleteIso")
com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse> deleteISO(String id,
                                                                                        DeleteISOOptions... options)

Deletes an ISO file.

Parameters:

id - the ID of the ISO file

options - optional arguments

Returns:

an asynchronous job response.

copyISO

@Named(value="copyIso")
com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse> copyISO(String isoId,
                                                                                      String sourceZoneId,
                                                                                      String destZoneId)

Copies a template from one zone to another.

Parameters:

isoId - Template ID.

sourceZoneId - ID of the zone the template is currently hosted on.

destZoneId - ID of the zone the template is being copied to.

Returns:

an asynchronous job response.

updateISOPermissions

@Named(value="updateIsoPermissions")
com.google.common.util.concurrent.ListenableFuture<Void> updateISOPermissions(String id,
                                                                                    UpdateISOPermissionsOptions... options)

Updates iso permissions

Parameters:

id - the template ID

options - optional arguments

Returns:

listISOPermissions

@Named(value="listIsoPermissions")
com.google.common.util.concurrent.ListenableFuture<ISOPermissions> listISOPermissions(String id,
                                                                                            AccountInDomainOptions... options)

List template visibility and all accounts that have permissions to view this template.

Parameters:

id - the template ID

options - optional arguments

Returns:

A set of the permissions on this ISO

extractISO

@Named(value="extractIso")
com.google.common.util.concurrent.ListenableFuture<AsyncCreateResponse> extractISO(String id,
                                                                                         ExtractMode mode,
                                                                                         String zoneId,
                                                                                         ExtractISOOptions... options)

Extracts an ISO

Parameters:

id - the ID of the ISO file

mode - the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD

zoneId - the ID of the zone where the ISO is originally located

options - optional arguments

Returns:

an asynchronous job response.