Package com.google.appengine.api.images.dev

Class LocalImagesService

java.lang.Object

com.google.appengine.tools.development.AbstractLocalRpcService

com.google.appengine.api.images.dev.LocalImagesService

All Implemented Interfaces:

LocalRpcService

@AutoService(LocalRpcService.class)
public final class LocalImagesService
extends AbstractLocalRpcService

Java stub implementation of the images api backend using Image 2D. Depends on ImageIO being able to load and save in the correct image formats.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.appengine.tools.development.LocalRpcService

LocalRpcService.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PACKAGE	The package name for this service.

Constructor Summary

Constructors

Constructor	Description
LocalImagesService()

Method Summary

Modifier and Type	Method	Description
ImagesServicePb.ImagesCompositeResponse	composite(LocalRpcService.Status status, ImagesServicePb.ImagesCompositeRequest request)
ImagesServicePb.ImagesDeleteUrlBaseResponse	deleteUrlBase(LocalRpcService.Status status, ImagesServicePb.ImagesDeleteUrlBaseRequest request)
Integer	getMaxApiRequestSize()	Returns the maximum size of an encoded API request in bytes, or null for the default size.
String	getMimeType(ImagesServicePb.ImageData imageData)	Obtains the mime type of the image data.
String	getPackage()	Returns the package for the service, for example, "datastore_v3".
ImagesServicePb.ImagesGetUrlBaseResponse	getUrlBase(LocalRpcService.Status status, ImagesServicePb.ImagesGetUrlBaseRequest request)	Gets a Local image URL.
ImagesServicePb.ImagesHistogramResponse	histogram(LocalRpcService.Status status, ImagesServicePb.ImagesHistogramRequest request)	Calculate the histogram of the supplied image.
void	init(LocalServiceContext context, Map<String,String> properties)	Initializes the service with a set of configuration properties.
BufferedImage	openImage(ImagesServicePb.ImageData imageData, LocalRpcService.Status status)	Loads an image represented by a byte array into a BufferedImage.
BufferedImage	processTransform(BufferedImage image, ImagesServicePb.Transform transform, LocalRpcService.Status status)	Apply an individual transform to the provided image.
byte[]	saveImage(BufferedImage image, ImagesServicePb.OutputSettings.MIME_TYPE mimeType, LocalRpcService.Status status)	Saves a BufferedImage into a byte array using the mimeType encoding.
void	start()	Puts a new service into "serving" mode.
void	stop()	Stops the service, releasing all of its resources.
ImagesServicePb.ImagesTransformResponse	transform(LocalRpcService.Status status, ImagesServicePb.ImagesTransformRequest request)	Apply the transform request to the contained image.

Methods inherited from class com.google.appengine.tools.development.AbstractLocalRpcService

getDefaultDeadline, getMaximumDeadline

Methods inherited from class java.lang.Object

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

Field Details

PACKAGE

public static final String PACKAGE

The package name for this service.

See Also:

• Constant Field Values

Constructor Details

LocalImagesService

public LocalImagesService()

Method Details

getPackage

public String getPackage()

Returns the package for the service, for example, "datastore_v3".

Returns:

a not null package name.

init

public void init(LocalServiceContext context,
 Map<String,String> properties)

Initializes the service with a set of configuration properties. Must be called before a service is started.

Specified by:

init in interface LocalRpcService

Overrides:

init in class AbstractLocalRpcService

Parameters:

context - A context object for the application

properties - A read-only Map of properties.

start

public void start()

Puts a new service into "serving" mode. Aside from setting properties, the service is not functional until after having been started.

Specified by:

start in interface LocalRpcService

Overrides:

start in class AbstractLocalRpcService

stop

public void stop()

Stops the service, releasing all of its resources.

Specified by:

stop in interface LocalRpcService

Overrides:

stop in class AbstractLocalRpcService

transform

public ImagesServicePb.ImagesTransformResponse transform(LocalRpcService.Status status,
 ImagesServicePb.ImagesTransformRequest request)

Apply the transform request to the contained image.

Parameters:

status - RPC status

request - request to be processed

Returns:

a transform response containing the processed image

composite

public ImagesServicePb.ImagesCompositeResponse composite(LocalRpcService.Status status,
 ImagesServicePb.ImagesCompositeRequest request)

Parameters:

status - RPC status

request - request to be processed

Returns:

a transform response containing the processed image

getMimeType

public String getMimeType(ImagesServicePb.ImageData imageData)

Obtains the mime type of the image data.

Parameters:

imageData - a reference to the image

Returns:

a string representing the mime type. Valid return values include inputFormats in LocalImagesService.init().

Throws:

ApiProxy.ApplicationException - If the image cannot be opened

openImage

public BufferedImage openImage(ImagesServicePb.ImageData imageData,
 LocalRpcService.Status status)

Loads an image represented by a byte array into a BufferedImage.

Parameters:

imageData - A byte array representing an image

status - RPC status

Returns:

a BufferedImage of the image.

Throws:

ApiProxy.ApplicationException - If the image cannot be opened.

saveImage

public byte[] saveImage(BufferedImage image,
 ImagesServicePb.OutputSettings.MIME_TYPE mimeType,
 LocalRpcService.Status status)

Saves a BufferedImage into a byte array using the mimeType encoding.

Parameters:

image - the image to be encoded.

status - RPC status.

Returns:

A byte array representing an image.

Throws:

ApiProxy.ApplicationException - If the image cannot be encoded.

histogram

public ImagesServicePb.ImagesHistogramResponse histogram(LocalRpcService.Status status,
 ImagesServicePb.ImagesHistogramRequest request)

Calculate the histogram of the supplied image.

Parameters:

status - RPC status

request - request to be processed

Returns:

a histogram response containing the histogram of the image

getUrlBase

public ImagesServicePb.ImagesGetUrlBaseResponse getUrlBase(LocalRpcService.Status status,
 ImagesServicePb.ImagesGetUrlBaseRequest request)

Gets a Local image URL.

Parameters:

status - RPC status

request - request containing the blobkey to be served

Returns:

a response containing the Local image Url

deleteUrlBase

public ImagesServicePb.ImagesDeleteUrlBaseResponse deleteUrlBase(LocalRpcService.Status status,
 ImagesServicePb.ImagesDeleteUrlBaseRequest request)

getMaxApiRequestSize

public Integer getMaxApiRequestSize()

Description copied from interface: LocalRpcService

Returns the maximum size of an encoded API request in bytes, or null for the default size.

Specified by:

getMaxApiRequestSize in interface LocalRpcService

Overrides:

getMaxApiRequestSize in class AbstractLocalRpcService

processTransform

public BufferedImage processTransform(BufferedImage image,
 ImagesServicePb.Transform transform,
 LocalRpcService.Status status)

Apply an individual transform to the provided image.

Parameters:

image - image to be processed

transform - transform to be applied to the image

status - RPC status

Returns:

processed image