Refy

backend/com.tecknobit.refy.services.shared.controllers/DefaultRefyController

Default Refy Controller

@RestController

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

abstract class DefaultRefyController<I : RefyItem?> : EquinoxController<T, R, H>

The DefaultRefyController class is useful to give the base behavior of the Refy's controllers

Author

N7ghtm4r3 - Tecknobit

See also

EquinoxController

Inheritors

CollectionsController

CustomLinksController

LinksController

TeamsController

Constructors

DefaultRefyController

constructor()

Properties

protected open var jsonHelper: JsonHelper

linksCollectionsService

@Autowired

protected open var linksCollectionsService: LinksCollectionsService

linksCollectionsService helper to manage the LinksCollection database operations

@Autowired

protected open var linksService: LinksService

linksService helper to manage the RefyLink database operations

protected val mantis: Mantis

protected open var me: T

NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE

val NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE: String = "not_authorized_key"

resourcesProvider

open var resourcesProvider: ResourcesProvider

RESPONSE_SUCCESSFUL_MESSAGE

val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully_key"

serverProtector

protected open var serverProtector: ServerProtector

@Autowired

protected open var 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_PROCEDURE_MESSAGE

val WRONG_PROCEDURE_MESSAGE: String = "wrong_procedure_key"

Functions

abstract fun create(token: String, userId: String, payload: Map<String, Any>): String

Method to create a new item

abstract fun delete(token: String, userId: String, itemId: String): String

Method to delete an item

abstract fun edit(token: String, userId: String, itemId: String, payload: Map<String, Any>): String

Method to edit an existing item

protected open fun failedResponse(error: String): String

generateIdentifier

open fun generateIdentifier(): String

open fun <T> getItem(token: String, userId: String, itemId: String): T

Method to get an existing item

initEquinoxEnvironment

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

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

isUserNotAuthorized

protected abstract fun isUserNotAuthorized(userId: String, token: String, itemId: String): Boolean

Method to get whether the user is or not authorized to operate with the item requested

abstract fun <T> list(token: String, userId: String, ownedOnly: Boolean, page: Int, pageSize: Int, keywords: Set<String>): T

Method to get a list of items

protected open fun <V> loadJsonHelper(payload: Map<String, V>)

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