Package io.goobi.viewer.api.rest.v1.cms

Class CMSMediaResource

java.lang.Object

io.goobi.viewer.api.rest.v1.cms.CMSMediaResource

@Path("/cms/media")
public class CMSMediaResource
extends Object

REST resource for accessing CMS media files with filtering by category and type.

Author:

Florian Alpers

Field Summary

Fields

Modifier and Type	Field	Description
protected HttpServletRequest	servletRequest
protected HttpServletResponse	servletResponse

Constructor Summary

Constructors

Constructor	Description
CMSMediaResource()
CMSMediaResource(IDAO dao)

Method Summary

Modifier and Type	Method	Description
CMSMediaItem	createMediaItem(Path filePath)	createMediaItem.
void	deleteAllFiles()
void	deleteFile()
List<String>	getAllFiles()	List all uploaded media files.
MediaList	getAllMedia(String tags, Integer maxItems, Integer prioritySlots, Boolean random)	getMediaByTag.
static StreamingOutput	getIcoContent(String filename, HttpServletResponse response)
Response	getInvalidFilename(String filename)	Fallback GET handler for filenames that do NOT match the image extension pattern handled by CMSMediaImageResource.
MediaItem	getMediaItem(Long id)
static String	getMediaItemContent(String filename)	getMediaItemContent.
MediaList	getMediaOfCategories(String tags, Integer maxItems, Integer prioritySlots, Boolean random)	getMediaByTag.
static StreamingOutput	getPDFMediaItemContent(String filename, HttpServletResponse response)	getPDFMediaItemContent.
static StreamingOutput	getSvgContent(String filename, HttpServletResponse response)
static void	removeFromImageCache(CMSMediaItem item, de.unigoettingen.sub.commons.cache.ContentServerCacheManager cacheManager)
String	serveAudioContent(String filename)
String	serveVideoContent(String filename)
Response	uploadMediaFiles(boolean enabled, String filename, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail)	May receive a file from a multipart form and saves the file in the cms media folder.
Response	validateUploadMediaFiles(String filename)	Return the media item for the given filename.

Methods inherited from class java.lang.Object

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

Field Details

servletRequest

@Context
protected HttpServletRequest servletRequest

servletResponse

@Context
protected HttpServletResponse servletResponse

Constructor Details

CMSMediaResource

public CMSMediaResource()

CMSMediaResource

public CMSMediaResource(IDAO dao)

Method Details

getMediaOfCategories

@GET
@Produces("application/json")
@Path("/category/{tags}")
public MediaList getMediaOfCategories(@PathParam("tags")
 String tags,
 @QueryParam("max")
 Integer maxItems,
 @QueryParam("prioritySlots")
 Integer prioritySlots,
 @QueryParam("random")
 Boolean random)
                               throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getMediaByTag.

Parameters:

tags - category name(s) separated by '...'

maxItems - maximum number of items to return

prioritySlots - number of high-priority items guaranteed in result

random - if true, return items in random order

Returns:

a MediaList containing the CMS media items matching the given category tags

Throws:

DAOException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getAllMedia

@GET
@Produces("application/json")
public MediaList getAllMedia(@QueryParam("tags")
 String tags,
 @QueryParam("max")
 Integer maxItems,
 @QueryParam("prioritySlots")
 Integer prioritySlots,
 @QueryParam("random")
 Boolean random)
                      throws DAOException

getMediaByTag.

Parameters:

tags - comma-separated list of category tag names

maxItems - maximum number of items to return

prioritySlots - number of high-priority items guaranteed in result

random - if true, return items in random order

Returns:

a MediaList containing all CMS media items optionally filtered by the given tags

Throws:

DAOException - if any.

getMediaItem

@GET
@Path("/{id: \\d+}")
@Produces("application/json")
public MediaItem getMediaItem(@PathParam("id")
 Long id)
                       throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

getPDFMediaItemContent

@GET
@Path("/files/{filename: (?i)[^\\/]*\\.(pdf)}")
@Produces("application/pdf")
public static StreamingOutput getPDFMediaItemContent(@PathParam("filename")
 String filename,
 @Context
 HttpServletResponse response)
                                              throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

getPDFMediaItemContent.

Parameters:

filename - name of the PDF file to serve

response - HTTP response used to set headers

Returns:

File contents as HTML

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException - if any.

DAOException - if any.

getSvgContent

@GET
@Path("/files/{filename: (?i)[^\\/]*\\.(svg)}")
@Produces("image/svg+xml")
public static StreamingOutput getSvgContent(@PathParam("filename")
 String filename,
 @Context
 HttpServletResponse response)
                                     throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

getIcoContent

@GET
@Path("/files/{filename: (?i)[^\\/]*\\.(ico)}")
@Produces("image/x-icon")
public static StreamingOutput getIcoContent(@PathParam("filename")
 String filename,
 @Context
 HttpServletResponse response)
                                     throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

serveVideoContent

@GET
@Path("/files/{filename: (?i).*\\.(mp4|mpeg4|avi|mov|wmv)}")
public String serveVideoContent(@PathParam("filename")
 String filename)
                         throws PresentationException,
WebApplicationException

Throws:

PresentationException

WebApplicationException

serveAudioContent

@GET
@Path("/files/{filename: (?i).*\\.(mp3|mpeg|wav|ogg|wma)}")
public String serveAudioContent(@PathParam("filename")
 String filename)
                         throws PresentationException,
WebApplicationException

Throws:

PresentationException

WebApplicationException

getMediaItemContent

@GET
@Path("/files/{filename: (?i)[^\\/]*\\.(html)}")
@Produces("text/html")
public static String getMediaItemContent(@PathParam("filename")
 String filename)
                                  throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

getMediaItemContent.

Parameters:

filename - name of the HTML file to serve

Returns:

File contents as HTML

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException - if any.

DAOException - if any.

validateUploadMediaFiles

@GET
@Path("/{filename: [^\\/]*\\.\\w{1,4}}")
@Produces("application/json")
public Response validateUploadMediaFiles(@PathParam("filename")
 String filename)
                                  throws DAOException

Return the media item for the given filename. If no matching media item exists, return a not-found status code

Parameters:

filename - name of the CMS media file to look up

Returns:

an HTTP response containing the CMS media item metadata as JSON, or a 404 response if no item was found for the given filename

Throws:

DAOException - if any.

getAllFiles

@GET
@Path("/files")
@Produces("application/json")
public List<String> getAllFiles()
                         throws PresentationException

List all uploaded media files.

Returns:

List of media file names

Throws:

PresentationException

deleteAllFiles

@DELETE
@Path("/files")
@Produces("application/json")
public void deleteAllFiles()
                    throws de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

deleteFile

@DELETE
@Path("/files/{filename}")
@Produces("application/json")
public void deleteFile()
                throws de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getInvalidFilename

@GET
@Path("/files/{filename}")
@Produces("application/json")
public Response getInvalidFilename(@PathParam("filename")
 String filename)
                            throws de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Fallback GET handler for filenames that do NOT match the image extension pattern handled by CMSMediaImageResource. CMSMediaImageResource only matches filenames with image extensions (jpg, png, tif, gif, jp2); any other filename reaches this handler.

Returns 400 so that schemathesis receives the correct error code instead of 405 Method Not Allowed (which JAX-RS would return if no GET handler existed for this path).

Parameters:

filename - the requested filename

Returns:

never returns normally; always throws IllegalRequestException

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

uploadMediaFiles

@POST
@Path("/files")
@Consumes("multipart/form-data")
@Produces("application/json")
public Response uploadMediaFiles(@DefaultValue("true")
 boolean enabled,
 String filename,
 InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail)
                          throws DAOException

May receive a file from a multipart form and saves the file in the cms media folder.

Parameters:

enabled - whether the uploaded media item should be enabled

filename - target filename for the uploaded file

uploadedInputStream - input stream carrying the file content

fileDetail - multipart form metadata for the uploaded file

Returns:

an ACCEPTED response if the upload was successful, a FORBIDDEN response if no user is registered in the html session or the user does not have rights to upload media, or a CONFLICT response if a file of the same name already exists in the cms media foler

Throws:

DAOException - if any.

removeFromImageCache

public static void removeFromImageCache(CMSMediaItem item,
 de.unigoettingen.sub.commons.cache.ContentServerCacheManager cacheManager)

Parameters:

item - the CMS media item to evict from cache

cacheManager - the content server cache manager to use

createMediaItem

public CMSMediaItem createMediaItem(Path filePath)

createMediaItem.

Parameters:

filePath - path to the uploaded media file

Returns:

a new CMSMediaItem initialized with the filename and empty metadata for all configured locales