Package org.apache.juneau.examples.rest

Class PhotosResource

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.apache.juneau.rest.servlet.RestServlet

org.apache.juneau.rest.servlet.BasicRestServlet

org.apache.juneau.examples.rest.PhotosResource

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, BasicUniversalConfig, DefaultConfig, DefaultHtmlConfig, BasicRestOperations

public class PhotosResource
extends BasicRestServlet

Sample resource that allows images to be uploaded and retrieved.

See Also:

• REST Marshalling
• ImageSerializer
• ImageParser

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PhotosResource.Photo	Bean class for storing photos

Field Summary

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
PhotosResource()

Method Summary

Modifier and Type	Method	Description
Ok	addPhoto(int id, BufferedImage image)	[HTTP PUT /photos/{id}] PUT request handler.
Ok	deletePhoto(int id)	[HTTP DELETE /photos/{id}] DELETE request handler
Collection<PhotosResource.Photo>	getAllPhotos()	[HTTP GET /photos] GET request handler for list of all photos.
BufferedImage	getPhoto(int id)	[HTTP GET /photos/{id}] GET request handler for single photo.
PhotosResource.Photo	setPhoto(BufferedImage image)	[HTTP POST /photos] POST request handler.

Methods inherited from class org.apache.juneau.rest.servlet.BasicRestServlet

error, getFavIcon, getHtdoc, getStats, getSwagger

Methods inherited from class org.apache.juneau.rest.servlet.RestServlet

destroy, doLog, getContext, getPath, getRequest, getResponse, init, log, log, service, setContext

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class jakarta.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Details

PhotosResource

public PhotosResource()

Method Details

getAllPhotos

public Collection<PhotosResource.Photo> getAllPhotos()

[HTTP GET /photos] GET request handler for list of all photos.

Returns:

A list of photo beans.

getPhoto

public BufferedImage getPhoto(@Path("id")
 int id)
                       throws NotFound

[HTTP GET /photos/{id}] GET request handler for single photo.

Parameters:

id - The photo ID.

Returns:

The photo image.

Throws:

NotFound - If photo not found.

addPhoto

public Ok addPhoto(@Path("id")
 int id,
 @Content
 BufferedImage image)

[HTTP PUT /photos/{id}] PUT request handler.

Parameters:

id - The photo ID.

image - The photo image.

Returns:

OK.

setPhoto

public PhotosResource.Photo setPhoto(@Content
 BufferedImage image)

[HTTP POST /photos] POST request handler.

Parameters:

image - The photo image.

Returns:

The created photo bean.

deletePhoto

public Ok deletePhoto(@Path("id")
 int id)
               throws NotFound

[HTTP DELETE /photos/{id}] DELETE request handler

Parameters:

id - The photo ID.

Returns:

OK.

Throws:

NotFound - If photo not found.