com.whizzosoftware.hobson.api.image

Interface ImageManager

public interface ImageManager

An manager interface for dealing with images.

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
ImageInputStream	getHubImage(HubContext ctx) Retrieves a Hub image.
java.util.List<ImageGroup>	getImageLibraryGroups(HubContext ctx) Retrieves all groups in the image library.
ImageInputStream	getImageLibraryImage(HubContext ctx, java.lang.String imageId) Retrieves binary representation of an image library image.
java.util.List<java.lang.String>	getImageLibraryImageIds(HubContext ctx, java.lang.String groupId) Retrieves all image IDs in a group.
void	setHubImage(HubContext ctx, ImageInputStream iis) Sets the current Hub image.

Method Detail

getHubImage

ImageInputStream getHubImage(HubContext ctx)

Retrieves a Hub image.

Parameters:

ctx - the hub context

Returns:

an ImageInputStream instance

Throws:

HobsonNotFoundException - if an image does not exist

setHubImage

void setHubImage(HubContext ctx,
                 ImageInputStream iis)

Sets the current Hub image.

Parameters:

ctx - the context of the target hub

iis - the image input stream

getImageLibraryGroups

java.util.List<ImageGroup> getImageLibraryGroups(HubContext ctx)

Retrieves all groups in the image library.

Parameters:

ctx - the context of the target hub

Returns:

a List of ImageGroup objects

getImageLibraryImageIds

java.util.List<java.lang.String> getImageLibraryImageIds(HubContext ctx,
                                                         java.lang.String groupId)

Retrieves all image IDs in a group.

Parameters:

ctx - the context of the target hub

groupId - the group ID

Returns:

a List of Strings

getImageLibraryImage

ImageInputStream getImageLibraryImage(HubContext ctx,
                                      java.lang.String imageId)

Retrieves binary representation of an image library image.

Parameters:

ctx - the context of the target hub

imageId - the ID of the image to retrieve

Returns:

an ImageInputStream object

Throws:

HobsonNotFoundException - if an image does not exist