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

Class CMSMediaResource

java.lang.Object

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

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

CMSMediaResource class.

Author:

Florian Alpers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CMSMediaResource.MediaList

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.servlet.http.HttpServletRequest	servletRequest
protected jakarta.servlet.http.HttpServletResponse	servletResponse

Constructor Summary

Constructors

Constructor	Description
CMSMediaResource()

Method Summary

Modifier and Type	Method	Description
CMSMediaItem	createMediaItem(Path filePath)	createMediaItem.
void	deleteAllFiles()
void	deleteFile()
List<String>	getAllFiles()	List all uploaded media files.
CMSMediaResource.MediaList	getAllMedia(String tags, Integer maxItems, Integer prioritySlots, Boolean random)	getMediaByTag.
static jakarta.ws.rs.core.StreamingOutput	getIcoContent(String filename, jakarta.servlet.http.HttpServletResponse response)
MediaItem	getMediaItem(Long id)
static String	getMediaItemContent(String filename)	getMediaItemContent.
CMSMediaResource.MediaList	getMediaOfCategories(String tags, Integer maxItems, Integer prioritySlots, Boolean random)	getMediaByTag.
static jakarta.ws.rs.core.StreamingOutput	getPDFMediaItemContent(String filename, jakarta.servlet.http.HttpServletResponse response)	getPDFMediaItemContent.
static jakarta.ws.rs.core.StreamingOutput	getSvgContent(String filename, jakarta.servlet.http.HttpServletResponse response)
static void	removeFromImageCache(CMSMediaItem item)
String	serveAudioContent(String filename)
String	serveVideoContent(String filename)
jakarta.ws.rs.core.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.
jakarta.ws.rs.core.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 jakarta.servlet.http.HttpServletRequest servletRequest

servletResponse

@Context
protected jakarta.servlet.http.HttpServletResponse servletResponse

Constructor Details

CMSMediaResource

public CMSMediaResource()

Method Details

getMediaOfCategories

@GET
@Produces("application/json")
@Path("/category/{tags}")
public CMSMediaResource.MediaList getMediaOfCategories(@PathParam("tags")
 String tags,
 @QueryParam("max")
 Integer maxItems,
 @QueryParam("prioritySlots")
 Integer prioritySlots,
 @QueryParam("random")
 Boolean random)
                                                throws DAOException

getMediaByTag.

Parameters:

tags - a String object.

maxItems -

prioritySlots -

random -

Returns:

a CMSMediaResource.MediaList object.

Throws:

DAOException - if any.

getAllMedia

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

getMediaByTag.

Parameters:

tags -

maxItems -

prioritySlots -

random -

Returns:

a CMSMediaResource.MediaList object.

Throws:

DAOException - if any.

getMediaItem

@GET
@Path("/{id: \\d+}")
@Produces("application/json")
public MediaItem getMediaItem(@PathParam("id")
 Long id)
                       throws DAOException

Throws:

DAOException

getPDFMediaItemContent

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

getPDFMediaItemContent.

Parameters:

filename -

response - a HttpServletResponse object.

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 jakarta.ws.rs.core.StreamingOutput getSvgContent(@PathParam("filename")
 String filename,
 @Context
 jakarta.servlet.http.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 jakarta.ws.rs.core.StreamingOutput getIcoContent(@PathParam("filename")
 String filename,
 @Context
 jakarta.servlet.http.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,
jakarta.ws.rs.WebApplicationException

Throws:

PresentationException

jakarta.ws.rs.WebApplicationException

serveAudioContent

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

Throws:

PresentationException

jakarta.ws.rs.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 -

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 jakarta.ws.rs.core.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 - a String object.

Returns:

a Response object.

Throws:

DAOException - if any.

getAllFiles

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

List all uploaded media files.

Returns:

All CMS media files

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

uploadMediaFiles

@POST
@Path("/files")
@Consumes("multipart/form-data")
@Produces("application/json")
public jakarta.ws.rs.core.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 - a boolean.

filename - a String object.

uploadedInputStream - a InputStream object.

fileDetail - a FormDataContentDisposition object.

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)

Parameters:

item -

createMediaItem

public CMSMediaItem createMediaItem(Path filePath)

createMediaItem.

Parameters:

filePath - a Path object.

Returns:

a CMSMediaItem object.