Package org.opennebula.client.image
Class Image
java.lang.Object
org.opennebula.client.PoolElement
org.opennebula.client.image.Image
This class represents an OpenNebula image.
It also offers static XML-RPC call wrappers.
-
Field Summary
Fields inherited from class org.opennebula.client.PoolElement
client, id, xml, xpath
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic OneResponse
Allocates a new Image in OpenNebula.static OneResponse
Allocates a new Image in OpenNebula.chgrp
(int gid) Changes the groupchmod
(int octet) Changes the permissionschmod
(int owner_u, int owner_m, int owner_a, int group_u, int group_m, int group_a, int other_u, int other_m, int other_a) Changes the Image permissionsChanges the permissionsstatic OneResponse
Changes the permissionsstatic OneResponse
chmod
(Client client, int id, int owner_u, int owner_m, int owner_a, int group_u, int group_m, int group_a, int other_u, int other_m, int other_a) Changes the Image permissionsstatic OneResponse
Changes the permissionschown
(int uid) Changes the ownerchown
(int uid, int gid) Changes the owner/groupstatic OneResponse
Changes the owner/groupChanges the Image typestatic OneResponse
Changes the Image typeClones this Image into a new oneClones this Image into a new onestatic OneResponse
Clones this Image into a new onedelete
(boolean force) Deletes the image from OpenNebula.static OneResponse
Deletes an image from OpenNebula.disable()
Disables the image.enable()
Enables the image.enable
(boolean enable) Enables or disables the image.static OneResponse
Enables or disables an image.info()
Retrieves the information of the Image.static OneResponse
Retrieves the information of the given Image.static OneResponse
Retrieves the information of the given Image.boolean
Returns true if the image is enabled.lock
(int level) Lock this Imagestatic OneResponse
lock this ImageSets the Image as persistent or not persistent.Sets the Image as persistentpersistent
(boolean persistent) Sets the Image as persistent or not persistent.static OneResponse
persistent
(Client client, int id, boolean persistent) Sets the Image as persistent or not persistent.publish()
Publishes the image.publish
(boolean publish) Publishes or unpublishes the image.static OneResponse
Publishes or unpublishes an image.Renames this Imagestatic OneResponse
Renames this ImageReturns the short length string state of the Image.Returns the type of the Image as a short String.snapshotDelete
(int snapId) Deletes Image from snapshotstatic OneResponse
snapshotDelete
(Client client, int id, int snapId) Deletes Image from snapshotsnapshotFlatten
(int snapId) Flattens an image snapshotstatic OneResponse
snapshotFlatten
(Client client, int id, int snapId) Flattens an image snapshotsnapshotRevert
(int snapId) Reverts Image state to a previous snapshotstatic OneResponse
snapshotRevert
(Client client, int id, int snapId) Reverts Image state to a previous snapshotReturns the state of the Image.int
type()
Returns the type of the Image.typeStr()
Returns the type of the Image as a String.unlock()
Unlock this Imagestatic OneResponse
Unlock this ImageUnpublishes the image.Replaces the template contents.Replaces the template contents.static OneResponse
Replaces the template contents.
-
Constructor Details
-
Image
Creates a new Image representation.- Parameters:
id
- The image id.client
- XML-RPC Client.
-
Image
- See Also:
-
-
Method Details
-
allocate
Allocates a new Image in OpenNebula.- Parameters:
client
- XML-RPC Client.description
- A string containing the template of the image.datastoreId
- The Datastore ID- Returns:
- If successful the message contains the associated id generated for this Image.
-
allocate
public static OneResponse allocate(Client client, String description, int datastoreId, boolean no_check_capacity) Allocates a new Image in OpenNebula.- Parameters:
client
- XML-RPC Client.description
- A string containing the template of the image.datastoreId
- The Datastore IDno_check_capacity
- to check datastore capacity- Returns:
- If successful the message contains the associated id generated for this Image.
-
info
Retrieves the information of the given Image.- Parameters:
client
- XML-RPC Client.id
- The image id for the image to retrieve the information from- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
info
Retrieves the information of the given Image.- Parameters:
client
- XML-RPC Client.id
- The Image id for the Image to retrieve the information fromdecrypt
- If true decrypt sensitive attributes- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
delete
Deletes an image from OpenNebula.- Parameters:
client
- XML-RPC Client.id
- The image id of the target image we want to delete.force
- Ignore errors- Returns:
- A encapsulated response.
-
update
Replaces the template contents.- Parameters:
client
- XML-RPC Client.id
- The image id of the target image we want to modify.new_template
- New template contentsappend
- True to append new attributes instead of replace the whole template- Returns:
- If successful the message contains the image id.
-
enable
Enables or disables an image.- Parameters:
client
- XML-RPC Client.id
- The image id of the target image we want to modify.enable
- True for enabling, false for disabling.- Returns:
- If successful the message contains the image id.
-
persistent
Sets the Image as persistent or not persistent.- Parameters:
client
- XML-RPC Client.id
- The image id of the target image we want to modify.persistent
- True to make it persistent, false non-persistent- Returns:
- If successful the message contains the image id.
-
publish
Publishes or unpublishes an image.- Parameters:
client
- XML-RPC Client.id
- The image id of the target image we want to modify.publish
- True for publishing, false for unpublishing.- Returns:
- If successful the message contains the image id.
-
chown
Changes the owner/group- Parameters:
client
- XML-RPC Client.id
- The image id of the target image we want to modify.uid
- The new owner user ID. Set it to -1 to leave the current one.gid
- The new group ID. Set it to -1 to leave the current one.- Returns:
- If an error occurs the error message contains the reason.
-
chmod
public static OneResponse chmod(Client client, int id, int owner_u, int owner_m, int owner_a, int group_u, int group_m, int group_a, int other_u, int other_m, int other_a) Changes the Image permissions- Parameters:
client
- XML-RPC Client.id
- The image id of the target image we want to modify.owner_u
- 1 to allow, 0 deny, -1 do not changeowner_m
- 1 to allow, 0 deny, -1 do not changeowner_a
- 1 to allow, 0 deny, -1 do not changegroup_u
- 1 to allow, 0 deny, -1 do not changegroup_m
- 1 to allow, 0 deny, -1 do not changegroup_a
- 1 to allow, 0 deny, -1 do not changeother_u
- 1 to allow, 0 deny, -1 do not changeother_m
- 1 to allow, 0 deny, -1 do not changeother_a
- 1 to allow, 0 deny, -1 do not change- Returns:
- If an error occurs the error message contains the reason.
-
chmod
Changes the permissions- Parameters:
client
- XML-RPC Client.id
- The id of the target object.octet
- Permissions octed , e.g. 640- Returns:
- If an error occurs the error message contains the reason.
-
chmod
Changes the permissions- Parameters:
client
- XML-RPC Client.id
- The id of the target object.octet
- Permissions octed , e.g. 640- Returns:
- If an error occurs the error message contains the reason.
-
chtype
Changes the Image type- Parameters:
client
- XML-RPC Client.id
- The image id of the target image we want to modify.type
- The new Image type- Returns:
- If an error occurs the error message contains the reason.
-
clone
Clones this Image into a new one- Parameters:
client
- XML-RPC Client.id
- The Image id of the target Image.name
- Name for the new Image.targetDS
- The ID of the target datastore. Set to -1 to use the current one.- Returns:
- If successful the message contains the new Image ID.
-
rename
Renames this Image- Parameters:
client
- XML-RPC Client.id
- The Image id of the target Image.name
- New name for the Image.- Returns:
- If an error occurs the error message contains the reason.
-
snapshotDelete
Deletes Image from snapshot- Parameters:
client
- XML-RPC Client.id
- The Image id of the target Image.snapId
- ID of the snapshot to delete- Returns:
- If an error occurs the error message contains the reason.
-
snapshotRevert
Reverts Image state to a previous snapshot- Parameters:
client
- XML-RPC Client.id
- The Image id of the target Image.snapId
- ID of the snapshot to revert to- Returns:
- If an error occurs the error message contains the reason.
-
snapshotFlatten
Flattens an image snapshot- Parameters:
client
- XML-RPC Client.id
- The Image id of the target Image.snapId
- ID of the snapshot to flatten- Returns:
- If an error occurs the error message contains the reason.
-
lock
lock this Image- Parameters:
client
- XML-RPC Client.id
- The Image id.level
- Lock level.- Returns:
- If an error occurs the error message contains the reason.
-
unlock
Unlock this Image- Parameters:
client
- XML-RPC Client.id
- The Image id.- Returns:
- If an error occurs the error message contains the reason.
-
info
Retrieves the information of the Image.- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
delete
Deletes the image from OpenNebula.- Parameters:
force
- Ignore errors- Returns:
- A encapsulated response.
-
update
Replaces the template contents.- Parameters:
new_template
- New template contents- Returns:
- If successful the message contains the image id.
-
update
Replaces the template contents.- Parameters:
new_template
- New template contentsappend
- True to append new attributes instead of replace the whole template- Returns:
- If successful the message contains the image id.
-
enable
Enables or disables the image.- Parameters:
enable
- True for enabling, false for disabling.- Returns:
- If successful the message contains the image id.
-
enable
Enables the image.- Returns:
- If successful the message contains the image id.
-
disable
Disables the image.- Returns:
- If successful the message contains the image id.
-
persistent
Sets the Image as persistent or not persistent.- Parameters:
persistent
- True for enabling, false for disabling.- Returns:
- If successful the message contains the image id.
-
persistent
Sets the Image as persistent- Returns:
- If successful the message contains the image id.
-
nonpersistent
Sets the Image as persistent or not persistent.- Returns:
- If successful the message contains the image id.
-
publish
Publishes or unpublishes the image.- Parameters:
publish
- True for publishing, false for unpublishing.- Returns:
- If successful the message contains the image id.
-
publish
Publishes the image.- Returns:
- If successful the message contains the image id.
-
unpublish
Unpublishes the image.- Returns:
- If successful the message contains the image id.
-
chown
Changes the owner/group- Parameters:
uid
- The new owner user ID. Set it to -1 to leave the current one.gid
- The new group ID. Set it to -1 to leave the current one.- Returns:
- If an error occurs the error message contains the reason.
-
chown
Changes the owner- Parameters:
uid
- The new owner user ID.- Returns:
- If an error occurs the error message contains the reason.
-
chgrp
Changes the group- Parameters:
gid
- The new group ID.- Returns:
- If an error occurs the error message contains the reason.
-
chmod
public OneResponse chmod(int owner_u, int owner_m, int owner_a, int group_u, int group_m, int group_a, int other_u, int other_m, int other_a) Changes the Image permissions- Parameters:
owner_u
- 1 to allow, 0 deny, -1 do not changeowner_m
- 1 to allow, 0 deny, -1 do not changeowner_a
- 1 to allow, 0 deny, -1 do not changegroup_u
- 1 to allow, 0 deny, -1 do not changegroup_m
- 1 to allow, 0 deny, -1 do not changegroup_a
- 1 to allow, 0 deny, -1 do not changeother_u
- 1 to allow, 0 deny, -1 do not changeother_m
- 1 to allow, 0 deny, -1 do not changeother_a
- 1 to allow, 0 deny, -1 do not change- Returns:
- If an error occurs the error message contains the reason.
-
chmod
Changes the permissions- Parameters:
octet
- Permissions octed , e.g. 640- Returns:
- If an error occurs the error message contains the reason.
-
chmod
Changes the permissions- Parameters:
octet
- Permissions octed , e.g. 640- Returns:
- If an error occurs the error message contains the reason.
-
chtype
Changes the Image type- Parameters:
type
- The new Image type- Returns:
- If an error occurs the error message contains the reason.
-
clone
Clones this Image into a new one- Parameters:
name
- Name for the new Image.- Returns:
- If successful the message contains the new Image ID.
-
clone
Clones this Image into a new one- Parameters:
name
- Name for the new Image.targetDS
- The ID of the target datastore.- Returns:
- If successful the message contains the new Image ID.
-
rename
Renames this Image- Parameters:
name
- New name for the Image.- Returns:
- If an error occurs the error message contains the reason.
-
snapshotDelete
Deletes Image from snapshot- Parameters:
snapId
- ID of the snapshot to delete- Returns:
- If an error occurs the error message contains the reason.
-
snapshotRevert
Reverts Image state to a previous snapshot- Parameters:
snapId
- ID of the snapshot to revert to- Returns:
- If an error occurs the error message contains the reason.
-
snapshotFlatten
Flattens an image snapshot- Parameters:
snapId
- ID of the snapshot to flatten- Returns:
- If an error occurs the error message contains the reason.
-
lock
Lock this Image- Parameters:
level
- Lock level.- Returns:
- If an error occurs the error message contains the reason.
-
unlock
Unlock this Image- Returns:
- If an error occurs the error message contains the reason.
-
stateString
Returns the state of the Image.
The methodinfo()
must be called before.- Returns:
- The state of the Image.
-
shortStateStr
Returns the short length string state of the Image.
The methodinfo()
must be called before.- Returns:
- The short length string state of the Image.
-
type
public int type()Returns the type of the Image.- Returns:
- The type of the Image.
-
typeStr
Returns the type of the Image as a String.- Returns:
- The type of the Image as a String.
-
shortTypeStr
Returns the type of the Image as a short String.- Returns:
- The type of the Image as a short String.
-
isEnabled
public boolean isEnabled()Returns true if the image is enabled.- Returns:
- True if the image is enabled.
-