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

DefaultRefyController

@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

Inheritors

CollectionsController

CustomLinksController

LinksController

TeamsController

Constructors

DefaultRefyController

@Autowired

protected constructor(linksService: LinksService, linksCollectionsService: LinksCollectionsService, teamsService: TeamsService)

Constructor used to init the controller

Properties

configuration

protected val configuration: EquinoxBackendConfiguration

jsonHelper

protected open var jsonHelper: JsonHelper

linksCollectionsService

protected val linksCollectionsService: LinksCollectionsService

linksCollectionsService helper to manage the LinksCollection database operations

linksService

protected val linksService: LinksService

linksService helper to manage the RefyLink database operations

protected open var me: T

messageSource

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

teamsService

protected val teamsService: TeamsService

teamsService helper to manage the Team database operations

userItem

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

create

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

Method to create a new item

delete

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

Method to delete an item

edit

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

Method to edit an existing item

failedResponse

protected open fun failedResponse(errorKey: String): String

generateIdentifier

open fun generateIdentifier(): String

getInternationalizedMessage

protected open fun getInternationalizedMessage(messageKey: String): String

getItem

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

Method to get an existing item

initEquinoxEnvironment

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

isMe

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

list

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

loadJsonHelper

protected open fun loadJsonHelper(payload: JSONObject)

notAuthorizedOrWrongDetailsResponse

protected open fun notAuthorizedOrWrongDetailsResponse(): String

plainResponse

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

DefaultRefyController

Author

See also

Inheritors

Constructors

Properties

Functions