backend/com.tecknobit.refy.controllers.links/LinksController

LinksController

@RestController
@RequestMapping(value = "BASE_EQUINOX_ENDPOINT + USERS_KEY + "/{" + USER_IDENTIFIER_KEY + "}/" + LINKS_KEY")
open class LinksController : DefaultRefyController<I>

The LinksController class is useful to manage all the RefyLink operations

Author

N7ghtm4r3 - Tecknobit

See also

EquinoxController

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@Autowired
protected open var collectionsHelper: LinksCollectionsHelper
collectionsHelper helper to manage the LinksCollection database operations
Link copied to clipboard
protected open var jsonHelper: JsonHelper
Link copied to clipboard
@Autowired
protected open var linksHelper: LinksHelper
linksHelper helper to manage the RefyLink database operations
Link copied to clipboard
protected val mantis: Mantis
Link copied to clipboard
protected open var me: T
Link copied to clipboard
val NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE: String = "not_authorized_key"
Link copied to clipboard
val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully_key"
Link copied to clipboard
protected open var serverProtector: ServerProtector
Link copied to clipboard
@Autowired
protected open var teamsHelper: TeamsHelper
teamsHelper helper to manage the Team database operations
Link copied to clipboard
protected open var userItem: I
userItem the current item requested by the user
Link copied to clipboard
protected open var usersRepository: EquinoxUsersRepository<T>
Link copied to clipboard
val WRONG_PROCEDURE_MESSAGE: String = "wrong_procedure_key"

Functions

Link copied to clipboard
@PostMapping(headers = "token")
open fun create(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @RequestBody payload: Map<String, Any>): String
Method to create a new link
Link copied to clipboard
@DeleteMapping(headers = "token", path = "/{" + LINK_IDENTIFIER_KEY + "}")
open fun delete(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "link_id") linkId: String): String
Method to delete a link
Link copied to clipboard
@PatchMapping(headers = "token", path = "/{" + LINK_IDENTIFIER_KEY + "}")
open fun edit(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "link_id") linkId: String, @RequestBody payload: Map<String, Any>): String
Method to edit an existing link
Link copied to clipboard
open fun editAttachmentsList(payload: Map<String, Any>, attachmentsKey: String, management: DefaultRefyController.AttachmentsManagement): String
open fun editAttachmentsList(payload: Map<String, Any>, itemsListCanBeEmpty: Boolean, attachmentsKey: String, management: DefaultRefyController.AttachmentsManagement): String
Method to edit the attachments list of an item
Link copied to clipboard
protected open fun failedResponse(error: String): String
Link copied to clipboard
Link copied to clipboard
open fun <T> getItem(token: String, userId: String, itemId: String): T
Method to get an existing item
Link copied to clipboard
private open fun getLinkTitle(referenceLink: String): String
Method to get from the reference link the real title from the related web page
Link copied to clipboard
open fun initEquinoxEnvironment(storagePath: String, saveMessage: String, context: Class<out Any>, args: Array<String>)
Link copied to clipboard
protected open fun isMe(id: String, token: String): Boolean
Link copied to clipboard
protected open fun isUserNotAuthorized(userId: String, token: String, linkId: String): Boolean
Method to get whether the user is or not authorized to operate with the link requested
Link copied to clipboard
@GetMapping(headers = "token")
open fun <T> list(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @RequestParam(name = "owned_only") ownedOnly: Boolean): T
Method to get a list of links
Link copied to clipboard
protected open fun <V> loadJsonHelper(payload: Map<String, V>)
Link copied to clipboard
@PutMapping(headers = "token", path = ""/{" + LINK_IDENTIFIER_KEY + "}/" + COLLECTIONS_KEY")
open fun manageLinkCollections(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "link_id") linkId: String, @RequestBody payload: Map<String, Any>): String
Method to manage the collections where the link is shared
Link copied to clipboard
@PutMapping(headers = "token", path = ""/{" + LINK_IDENTIFIER_KEY + "}/" + TEAMS_KEY")
open fun manageLinkTeams(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "link_id") linkId: String, @RequestBody payload: Map<String, Any>): String
Method to manage the teams where the link is shared
Link copied to clipboard
protected open fun successResponse(): String
protected open fun <V> successResponse(value: V): HashMap<String, V>
Link copied to clipboard
protected open fun userIsNotTheItemOwner(userId: String, token: String, itemId: String): Boolean
Method to get whether the user is or not the owner of the item requested