backend/com.tecknobit.refy.services.customlinks.controllers/CustomLinksController

CustomLinksController

@RestController

@RequestMapping(value = "BASE_EQUINOX_ENDPOINT + USERS_KEY + "/{" + USER_IDENTIFIER_KEY + "}" + CUSTOM_LINKS_ENDPOINT")

open class CustomLinksController : DefaultRefyController<I>

The LinksController class is useful to manage all the RefyLink operations

Author

N7ghtm4r3 - Tecknobit

See also

EquinoxController

DefaultRefyController

Constructors

CustomLinksController

@Autowired

constructor(linksService: LinksService, linksCollectionsService: LinksCollectionsService, teamsService: TeamsService, customLinksService: CustomLinksService)

Constructor used to init the controller

Properties

protected val configuration: EquinoxBackendConfiguration

customLinksService

private val customLinksService: CustomLinksService

customLinksService helper to manage the CustomRefyLink database operations

protected open var jsonHelper: JsonHelper

linksCollectionsService

protected val linksCollectionsService: LinksCollectionsService

linksCollectionsService helper to manage the LinksCollection database operations

protected val linksService: LinksService

linksService helper to manage the RefyLink database operations

protected open var me: T

protected open var messageSource: MessageSource

NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE

val NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE: String = "not_authorized"

resourcesProvider

open var resourcesProvider: ResourcesProvider

RESPONSE_SUCCESSFUL_MESSAGE

val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully"

serverProtector

protected open var serverProtector: ServerProtector

protected val teamsService: TeamsService

teamsService helper to manage the Team database operations

protected open var userItem: I

userItem the current item requested by the user

usersRepository

protected open var usersRepository: R

WRONG_EMAIL_MESSAGE

val WRONG_EMAIL_MESSAGE: String = "wrong_email"

WRONG_LANGUAGE_MESSAGE

val WRONG_LANGUAGE_MESSAGE: String = "wrong_language"

WRONG_NAME_MESSAGE

val WRONG_NAME_MESSAGE: String = "wrong_name"

WRONG_PASSWORD_MESSAGE

val WRONG_PASSWORD_MESSAGE: String = "wrong_password"

WRONG_PROCEDURE_MESSAGE

val WRONG_PROCEDURE_MESSAGE: String = "wrong_procedure"

WRONG_SURNAME_MESSAGE

val WRONG_SURNAME_MESSAGE: String = "wrong_surname"

Functions

@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 custom link

@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 custom link

@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 custom link

protected open fun failedResponse(errorKey: String): String

generateIdentifier

open fun generateIdentifier(): String

getInternationalizedMessage

protected open fun getInternationalizedMessage(messageKey: String): String

@GetMapping(headers = "token", path = "/{" + LINK_IDENTIFIER_KEY + "}")

open fun <T> getItem(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "link_id") linkId: String): T

Method to get an existing custom link

initEquinoxEnvironment

open fun initEquinoxEnvironment(context: Class<out Any>, args: Array<String>)

protected open fun isMe(id: String, token: String): Boolean

isUserNotAuthorized

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 custom link requested

@GetMapping(headers = "token")

open fun <T> list(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, ownedOnly: Boolean, @RequestParam(name = "page", defaultValue = "0", required = false) page: Int, @RequestParam(name = "pageSize", defaultValue = "10", required = false) pageSize: Int, @RequestParam(name = "keywords", defaultValue = "", required = false) keywords: Set<String>): T

Method to get a list of custom links

protected open fun loadJsonHelper(payload: JSONObject)

notAuthorizedOrWrongDetailsResponse

protected open fun notAuthorizedOrWrongDetailsResponse(): String

protected open fun plainResponse(status: ResponseStatus, message: String): String

setSessionLocale

protected open fun setSessionLocale(locale: String)

successResponse

protected open fun successResponse(): String

protected open fun <V> successResponse(value: V): HashMap<String, V>

userIsNotTheItemOwner

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

wrongProcedureResponse

protected open fun wrongProcedureResponse(): String