Image (OpenNebula Cloud API)

Overview

Package

Class

Tree

Deprecated

Index

Help

OpenNebula
Cloud API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.opennebula.client.image
Class Image

java.lang.Object
  org.opennebula.client.PoolElement
      org.opennebula.client.image.Image

public class Image
extends PoolElement
extends PoolElement

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
	`Image(int id, Client client)` Creates a new Image representation.
`protected`	`Image(org.w3c.dom.Node xmlElement, Client client)`

Method Summary
`static OneResponse`	`allocate(Client client, java.lang.String description, int datastoreId)` Allocates a new Image in OpenNebula.
`OneResponse`	`chgrp(int gid)` Changes the group
`static OneResponse`	`chmod(Client client, int id, int octet)` Changes the permissions
`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
`static OneResponse`	`chmod(Client client, int id, java.lang.String octet)` Changes the permissions
`OneResponse`	`chmod(int octet)` Changes the permissions
`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
`OneResponse`	`chmod(java.lang.String octet)` Changes the permissions
`static OneResponse`	`chown(Client client, int id, int uid, int gid)` Changes the owner/group
`OneResponse`	`chown(int uid)` Changes the owner
`OneResponse`	`chown(int uid, int gid)` Changes the owner/group
`static OneResponse`	`chtype(Client client, int id, java.lang.String type)` Changes the Image type
`OneResponse`	`chtype(java.lang.String type)` Changes the Image type
`static OneResponse`	`clone(Client client, int id, java.lang.String name)` Clones this Image into a new one
`OneResponse`	`clone(java.lang.String name)` Clones this Image into a new one
`OneResponse`	`delete()` Deletes the image from OpenNebula.
`static OneResponse`	`delete(Client client, int id)` Deletes an image from OpenNebula.
`OneResponse`	`disable()` Disables the image.
`OneResponse`	`enable()` Enables the image.
`OneResponse`	`enable(boolean enable)` Enables or disables the image.
`static OneResponse`	`enable(Client client, int id, boolean enable)` Enables or disables an image.
`OneResponse`	`info()` Retrieves the information of the Image.
`static OneResponse`	`info(Client client, int id)` Retrieves the information of the given Image.
`boolean`	`isEnabled()` Returns true if the image is enabled.
`OneResponse`	`nonpersistent()` Sets the Image as persistent or not persistent.
`OneResponse`	`persistent()` Sets the Image as persistent
`OneResponse`	`persistent(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.
`OneResponse`	`publish()` Publishes the image.
`OneResponse`	`publish(boolean publish)` Publishes or unpublishes the image.
`static OneResponse`	`publish(Client client, int id, boolean publish)` Publishes or unpublishes an image.
`java.lang.String`	`shortStateStr()` Returns the short length string state of the Image.
`java.lang.String`	`shortTypeStr()` Returns the type of the Image as a short String.
`java.lang.String`	`stateString()` Returns the state of the Image.
`int`	`type()` Returns the type of the Image.
`java.lang.String`	`typeStr()` Returns the type of the Image as a String.
`OneResponse`	`unpublish()` Unpublishes the image.
`static OneResponse`	`update(Client client, int id, java.lang.String new_template)` Replaces the template contents.
`OneResponse`	`update(java.lang.String new_template)` Replaces the template contents.

Methods inherited from class org.opennebula.client.PoolElement
`chmod, chmod, chmod, getId, getName, gid, id, processInfo, state, uid, xpath`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Image

public Image(int id,
             Client client)

Creates a new Image representation.

Parameters:: id - The image id.; client - XML-RPC Client.

Image

protected Image(org.w3c.dom.Node xmlElement,
                Client client)

See Also:: PoolElement

Method Detail

allocate

public static OneResponse allocate(Client client,
                                   java.lang.String description,
                                   int datastoreId)

Allocates a new Image in OpenNebula.

Parameters:: client - XML-RPC Client.; description - A string containing the template of the image.; datastoreId - The cluster ID. If it is -1, this image won't be added to any cluster.
Returns:: If successful the message contains the associated id generated for this Image.

info

public static OneResponse info(Client client,
                               int id)

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.

delete

public static OneResponse delete(Client client,
                                 int id)

Deletes an image from OpenNebula.

Parameters:: client - XML-RPC Client.; id - The image id of the target image we want to delete.
Returns:: A encapsulated response.

update

public static OneResponse update(Client client,
                                 int id,
                                 java.lang.String new_template)

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 contents
Returns:: If successful the message contains the image id.

enable

public static OneResponse enable(Client client,
                                 int id,
                                 boolean 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

public static OneResponse persistent(Client client,
                                     int id,
                                     boolean 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

public static OneResponse publish(Client client,
                                  int id,
                                  boolean 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

public static OneResponse chown(Client client,
                                int id,
                                int uid,
                                int gid)

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 change; owner_m - 1 to allow, 0 deny, -1 do not change; owner_a - 1 to allow, 0 deny, -1 do not change; group_u - 1 to allow, 0 deny, -1 do not change; group_m - 1 to allow, 0 deny, -1 do not change; group_a - 1 to allow, 0 deny, -1 do not change; other_u - 1 to allow, 0 deny, -1 do not change; other_m - 1 to allow, 0 deny, -1 do not change; other_a - 1 to allow, 0 deny, -1 do not change
Returns:: If an error occurs the error message contains the reason.

chmod

public static OneResponse chmod(Client client,
                                int id,
                                java.lang.String octet)

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

public static OneResponse chmod(Client client,
                                int id,
                                int octet)

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

public static OneResponse chtype(Client client,
                                 int id,
                                 java.lang.String type)

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

public static OneResponse clone(Client client,
                                int id,
                                java.lang.String name)

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.
Returns:: If successful the message contains the new Image ID.

info

public OneResponse info()

Retrieves the information of the Image.

Returns:: If successful the message contains the string with the information returned by OpenNebula.

delete

public OneResponse delete()

Deletes the image from OpenNebula.

Returns:: A encapsulated response.

update

public OneResponse update(java.lang.String new_template)

Replaces the template contents.

Parameters:: new_template - New template contents
Returns:: If successful the message contains the image id.

enable

public OneResponse enable(boolean enable)

Enables or disables the image.

Parameters:: enable - True for enabling, false for disabling.
Returns:: If successful the message contains the image id.

enable

public OneResponse enable()

Enables the image.

Returns:: If successful the message contains the image id.

disable

public OneResponse disable()

Disables the image.

Returns:: If successful the message contains the image id.

persistent

public OneResponse persistent(boolean 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

public OneResponse persistent()

Sets the Image as persistent

Returns:: If successful the message contains the image id.

nonpersistent

public OneResponse nonpersistent()

Sets the Image as persistent or not persistent.

Returns:: If successful the message contains the image id.

publish

public OneResponse publish(boolean publish)

Publishes or unpublishes the image.

Parameters:: publish - True for publishing, false for unpublishing.
Returns:: If successful the message contains the image id.

publish

public OneResponse publish()

Publishes the image.

Returns:: If successful the message contains the image id.

unpublish

public OneResponse unpublish()

Unpublishes the image.

Returns:: If successful the message contains the image id.

chown

public OneResponse chown(int uid,
                         int gid)

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

public OneResponse chown(int uid)

Changes the owner

Parameters:: uid - The new owner user ID.
Returns:: If an error occurs the error message contains the reason.

chgrp

public OneResponse chgrp(int gid)

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 change; owner_m - 1 to allow, 0 deny, -1 do not change; owner_a - 1 to allow, 0 deny, -1 do not change; group_u - 1 to allow, 0 deny, -1 do not change; group_m - 1 to allow, 0 deny, -1 do not change; group_a - 1 to allow, 0 deny, -1 do not change; other_u - 1 to allow, 0 deny, -1 do not change; other_m - 1 to allow, 0 deny, -1 do not change; other_a - 1 to allow, 0 deny, -1 do not change
Returns:: If an error occurs the error message contains the reason.

chmod

public OneResponse chmod(java.lang.String octet)

Changes the permissions

Parameters:: octet - Permissions octed , e.g. 640
Returns:: If an error occurs the error message contains the reason.

chmod

public OneResponse chmod(int octet)

Changes the permissions

Parameters:: octet - Permissions octed , e.g. 640
Returns:: If an error occurs the error message contains the reason.

chtype

public OneResponse chtype(java.lang.String type)

Changes the Image type

Parameters:: type - The new Image type
Returns:: If an error occurs the error message contains the reason.

clone

public OneResponse clone(java.lang.String name)

Clones this Image into a new one

Parameters:: name - Name for the new Image.
Returns:: If successful the message contains the new Image ID.

stateString

public java.lang.String stateString()

Returns the state of the Image.
The method info() must be called before.

Returns:: The state of the Image.

shortStateStr

public java.lang.String shortStateStr()

Returns the short length string state of the Image.
The method info() 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

public java.lang.String typeStr()

Returns the type of the Image as a String.

Returns:: The type of the Image as a String.

shortTypeStr

public java.lang.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.

Overview

Package

Class

Tree

Deprecated

Index

Help

OpenNebula
Cloud API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.opennebula.client.image Class Image

Image

Image

allocate

info

delete

update

enable

persistent

publish

chown

chmod

chmod

chmod

chtype

clone

info

delete

update

enable

enable

disable

persistent

persistent

nonpersistent

publish

publish

unpublish

chown

chown

chgrp

chmod

chmod

chmod

chtype

clone

stateString

shortStateStr

type

typeStr

shortTypeStr

isEnabled

org.opennebula.client.image
Class Image