Package org.exoplatform.addons.documents.cleanup.rest

Class CleanupItemRest

java.lang.Object

org.exoplatform.addons.documents.cleanup.rest.CleanupItemRest

@RestController
@RequestMapping("/cleanup/items")
public class CleanupItemRest
extends Object

Constructor Summary

Constructors

Constructor	Description
CleanupItemRest()

Method Summary

Modifier and Type	Method	Description
void	keepItem(jakarta.servlet.http.HttpServletRequest request, long id)
KeepItemsResultRestEntity	keepItems(jakarta.servlet.http.HttpServletRequest request, KeepItemsRestEntity keepItemsEntity)	Answers 200 with the per-item outcomes, NEVER a blanket 204: a bulk keep continues past individual failures, so the UI has to be able to warn instead of reporting a success when nothing was actually kept.
void	unkeepItem(jakarta.servlet.http.HttpServletRequest request, long id)
KeepItemsResultRestEntity	unkeepItems(jakarta.servlet.http.HttpServletRequest request, KeepItemsRestEntity keepItemsEntity)	Answers 200 with the per-item outcomes, mirroring keepItems(HttpServletRequest, KeepItemsRestEntity).

Methods inherited from class java.lang.Object

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

Constructor Details

CleanupItemRest

public CleanupItemRest()

Method Details

keepItem

@Secured("users")
@PostMapping("{id}/keep")
@ResponseStatus(NO_CONTENT)
public void keepItem(jakarta.servlet.http.HttpServletRequest request,
 @PathVariable("id")
 long id)

keepItems

@Secured("users")
@PostMapping(path="keep",
             consumes="application/json",
             produces="application/json")
public KeepItemsResultRestEntity keepItems(jakarta.servlet.http.HttpServletRequest request,
 @RequestBody
 KeepItemsRestEntity keepItemsEntity)

Answers 200 with the per-item outcomes, NEVER a blanket 204: a bulk keep continues past individual failures, so the UI has to be able to warn instead of reporting a success when nothing was actually kept.

unkeepItem

@Secured("users")
@PostMapping("{id}/unkeep")
@ResponseStatus(NO_CONTENT)
public void unkeepItem(jakarta.servlet.http.HttpServletRequest request,
 @PathVariable("id")
 long id)

unkeepItems

@Secured("users")
@PostMapping(path="unkeep",
             consumes="application/json",
             produces="application/json")
public KeepItemsResultRestEntity unkeepItems(jakarta.servlet.http.HttpServletRequest request,
 @RequestBody
 KeepItemsRestEntity keepItemsEntity)

Answers 200 with the per-item outcomes, mirroring keepItems(HttpServletRequest, KeepItemsRestEntity).