Package org.openstack4j.openstack.image.v2.internal

Class ImageServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

org.openstack4j.openstack.image.v2.internal.BaseImageServices

org.openstack4j.openstack.image.v2.internal.ImageServiceImpl

All Implemented Interfaces:

ImageService, RestService

public class ImageServiceImpl
extends BaseImageServices
implements ImageService

Implementation of Glance V2 Image Service

Author:

emjburns

Nested Class Summary

Nested classes/interfaces inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor	Description
ImageServiceImpl()

Method Summary

Modifier and Type	Method	Description
Image	create(Image image)	Creates a catalog record for an operating system disk image.
Member	createMember(String imageId, String memberId)	The image must exist, be private, and be owned by the author of the request.
ActionResponse	deactivate(String imageId)	Deactivate an image If you try to download a deactivated image, you will receive a 403 (Forbidden) response code.
ActionResponse	delete(String imageId)	Deletes an image.
ActionResponse	deleteMember(String imageId, String memberId)	You must be the owner of the image to delete the member
ActionResponse	deleteTag(String imageId, String tag)	Delete tag from image.
ActionResponse	download(String imageId, File filename)	Downloads binary image data
Image	get(String imageId)	Show details for an image by imageid.
Member	getMember(String imageId, String memberId)	Get details about a member
List<? extends Image>	list()	List all available operating system images
List<? extends Image>	list(Map<String,String> filteringParams)	Returns list of images filtered by parameters.
List<? extends CachedImage>	listCachedImages()	List images currently in the glance image cache.
List<? extends Member>	listMembers(String imageId)	List members of a particular image.
List<? extends Member>	listMembers(String imageId, Map<String,String> filteringParams)	List members of a particular image.
ActionResponse	reactivate(String imageId)	Reactivate an image
TaskService	tasks()
Image	update(String imageId, ImageUpdate imageUpdate)	Update an image by building the string of json operations that represent the json transformation instead of the building the whole image
Image	update(Image image)	Update image by providing the changed image object.
Member	updateMember(String imageId, String memberId, Member.MemberStatus memberStatus)	Change status of an image member For more details see http://specs.openstack.org/openstack/glance-specs/specs/api/v2/sharing-image-api-v2.html
ActionResponse	updateTag(String imageId, String tag)	Add tag to image.
ActionResponse	upload(String imageId, Payload<?> payload, Image image)	Uploads binary image data

Methods inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

delete, deleteWithResponse, get, getProvider, getServiceVersion, getWithResponse, getXOpenstackRequestId, head, patch, patchWithResponse, post, postWithResponse, put, putWithResponse, request, toList, uri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageServiceImpl

public ImageServiceImpl()

Method Detail

list

public List<? extends Image> list()

List all available operating system images

Specified by:

list in interface ImageService

Returns:

list of images

list

public List<? extends Image> list(Map<String,String> filteringParams)

Returns list of images filtered by parameters. For filtering guidelines, see http://developer.openstack.org/api-ref/image/v2/index.html#show-images To paginate, use "limit" and "marker" parameters

Specified by:

list in interface ImageService

Parameters:

filteringParams - map (name, value) of filtering parameters

Returns:

list of images fitered by filteringParams

listCachedImages

public List<? extends CachedImage> listCachedImages()

List images currently in the glance image cache.

Specified by:

listCachedImages in interface ImageService

Returns:

list of cached images or empty list if the cache is empty or null if the cache is not enabled.

get

public Image get(String imageId)

Show details for an image by imageid. The image must exist

Specified by:

get in interface ImageService

Returns:

the image

create

public Image create(Image image)

Creates a catalog record for an operating system disk image.

Specified by:

create in interface ImageService

Returns:

Image

update

public Image update(Image image)

Update image by providing the changed image object.

Specified by:

update in interface ImageService

Returns:

image

update

public Image update(String imageId,
                    ImageUpdate imageUpdate)

Update an image by building the string of json operations that represent the json transformation instead of the building the whole image

Specified by:

update in interface ImageService

Returns:

Image

delete

public ActionResponse delete(String imageId)

Deletes an image. You cannot delete images with the protected attribute set to true (boolean).

Specified by:

delete in interface ImageService

deactivate

public ActionResponse deactivate(String imageId)

Deactivate an image If you try to download a deactivated image, you will receive a 403 (Forbidden) response code. Additionally, only administrative users can view image locations for deactivated images.

Specified by:

deactivate in interface ImageService

reactivate

public ActionResponse reactivate(String imageId)

Reactivate an image

Specified by:

reactivate in interface ImageService

upload

public ActionResponse upload(String imageId,
                             Payload<?> payload,
                             @Nullable
                             Image image)

Uploads binary image data

Specified by:

upload in interface ImageService

download

public ActionResponse download(String imageId,
                               File filename)

Downloads binary image data

Specified by:

download in interface ImageService

updateTag

public ActionResponse updateTag(String imageId,
                                String tag)

Add tag to image. Can also be done with ImagesService#update(image)

Specified by:

updateTag in interface ImageService

deleteTag

public ActionResponse deleteTag(String imageId,
                                String tag)

Delete tag from image. Can also be done with ImagesService#update(image)

Specified by:

deleteTag in interface ImageService

listMembers

public List<? extends Member> listMembers(String imageId)

List members of a particular image. These members are projects or tenants that can see the image.

Specified by:

listMembers in interface ImageService

Returns:

List of members

listMembers

public List<? extends Member> listMembers(String imageId,
                                          Map<String,String> filteringParams)

List members of a particular image. These members are projects or tenants that can see the image.

Specified by:

listMembers in interface ImageService

Returns:

List of members

getMember

public Member getMember(String imageId,
                        String memberId)

Get details about a member

Specified by:

getMember in interface ImageService

Returns:

member

createMember

public Member createMember(String imageId,
                           String memberId)

The image must exist, be private, and be owned by the author of the request. Otherwise, this will fail.

Specified by:

createMember in interface ImageService

Parameters:

imageId - the image to share

Returns:

member

updateMember

public Member updateMember(String imageId,
                           String memberId,
                           Member.MemberStatus memberStatus)

Change status of an image member For more details see http://specs.openstack.org/openstack/glance-specs/specs/api/v2/sharing-image-api-v2.html

Specified by:

updateMember in interface ImageService

Returns:

member

deleteMember

public ActionResponse deleteMember(String imageId,
                                   String memberId)

You must be the owner of the image to delete the member

Specified by:

deleteMember in interface ImageService

tasks

public TaskService tasks()

Specified by:

tasks in interface ImageService

Returns:

the image v2 tasks service