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

Class CampaignItemLogResource

java.lang.Object

io.goobi.viewer.api.rest.v1.crowdsourcing.CampaignItemLogResource

@Path("/crowdsourcing/campaigns/{campaignId}")
public class CampaignItemLogResource
extends Object

REST resource for retrieving activity logs and progress statistics for crowdsourcing campaign items.

Author:

Florian Alpers

Field Summary

Fields

Modifier and Type	Field	Description
protected AnnotationsResourceBuilder	annoBuilder
protected AbstractApiUrlManager	urls

Constructor Summary

Constructors

Constructor	Description
CampaignItemLogResource(HttpServletRequest servletRequest, AbstractApiUrlManager urls, Long campaignId)
CampaignItemLogResource(HttpServletRequest servletRequest, Long campaignId)	Creates a new CampaignItemResource instance.

Method Summary

Modifier and Type	Method	Description
LogMessage	addMessage(LogMessage message, String pi, HttpServletRequest servletRequest)
void	deleteMessage(String pi, Long messageId)
List<LogMessage>	getLogForManifest(String pi, HttpServletRequest servletRequest)
LogMessage	getMessage(String pi, Long messageId, HttpServletRequest servletRequest)

Methods inherited from class java.lang.Object

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

Field Details

urls

protected AbstractApiUrlManager urls

annoBuilder

protected AnnotationsResourceBuilder annoBuilder

Constructor Details

CampaignItemLogResource

public CampaignItemLogResource(@Context
 HttpServletRequest servletRequest,
 @PathParam("campaignId")
 Long campaignId)

Creates a new CampaignItemResource instance.

Parameters:

servletRequest - HTTP servlet request

campaignId - identifier of the crowdsourcing campaign

CampaignItemLogResource

public CampaignItemLogResource(HttpServletRequest servletRequest,
 AbstractApiUrlManager urls,
 @PathParam("campaignId")
 Long campaignId)

Parameters:

servletRequest - HTTP servlet request

urls - API URL manager for path construction

campaignId - identifier of the crowdsourcing campaign

Method Details

getLogForManifest

@GET
@Path("/{pi}/log")
@Produces("application/json")
public List<LogMessage> getLogForManifest(@PathParam("pi")
 String pi,
 @Context
 HttpServletRequest servletRequest)
                                   throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

DAOException

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

addMessage

@POST
@Path("/{pi}/log")
@Produces("application/json")
public LogMessage addMessage(LogMessage message,
 @PathParam("pi")
 String pi,
 @Context
 HttpServletRequest servletRequest)
                      throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

DAOException

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

deleteMessage

@DELETE
@Path("/{pi}/log/{id}")
@Produces("application/json")
public void deleteMessage(@PathParam("pi")
 String pi,
 @PathParam("id")
 Long messageId)
                   throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

DAOException

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

getMessage

@GET
@Path("/{pi}/log/{id}")
@Produces("application/json")
public LogMessage getMessage(@PathParam("pi")
 String pi,
 @PathParam("id")
 Long messageId,
 @Context
 HttpServletRequest servletRequest)
                      throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

DAOException

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