backend/com.tecknobit.refy.services.users.controller/RefyUsersController

RefyUsersController

@RestController

open class RefyUsersController : EquinoxUsersController<T, R, H>

The RefyUsersController class is useful to manage all the Refy users operations

Author

N7ghtm4r3 - Tecknobit

See also

EquinoxController

EquinoxUsersController

Constructors

RefyUsersController

@Autowired

constructor(usersService: RefyUsersService, settingsService: RefyUserSettingsService)

Constructor to init the controller

Properties

protected val configuration: EquinoxBackendConfiguration

protected open var jsonHelper: JsonHelper

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

settingsService

private val settingsService: RefyUserSettingsService

settingsService The service used to manage the settings of the user

usersRepository

protected open var usersRepository: R

protected val usersService: H

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"

WRONG_TAG_NAME_MESSAGE

private val WRONG_TAG_NAME_MESSAGE: String = "wrong_tag_name"

WRONG_TAG_NAME_MESSAGE message to use when the tag name of the user is not valid

Functions

assembleSignInSuccessResponse

protected open fun assembleSignInSuccessResponse(user: RefyUser): JSONObject

open fun changeEmail(userId: String, token: String, payload: Map<String, String>): String

open fun changeLanguage(userId: String, token: String, payload: Map<String, String>): String

open fun changePassword(userId: String, token: String, payload: Map<String, String>): String

changeProfilePic

open fun changeProfilePic(userId: String, token: String, profilePic: MultipartFile): String

@PatchMapping(path = "USERS_KEY + "/{" + IDENTIFIER_KEY + "}" + CHANGE_TAG_NAME_ENDPOINT", headers = [])

open fun changeTagName(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @RequestBody payload: Map<String, String>): String

Method to change the tag name of the user

changeUserSettings

@PatchMapping(path = "USERS_KEY + "/{" + IDENTIFIER_KEY + "}/" + SETTINGS_KEY", headers = [])

open fun changeUserSettings(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @RequestBody payload: Map<String, Any>): String

Method to change the settings of the yser

open fun deleteAccount(userId: String, token: String): String

protected open fun failedResponse(errorKey: String): String

generateIdentifier

open fun generateIdentifier(): String

getDynamicAccountData

open fun getDynamicAccountData(userId: String, token: String): String

getInternationalizedMessage

protected open fun getInternationalizedMessage(messageKey: String): String

getSignInCustomParams

protected open fun getSignInCustomParams(): Array<Any>

getSignUpCustomParams

protected open fun getSignUpCustomParams(): Array<Any>

initEquinoxEnvironment

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

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

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)

open fun signIn(payload: Map<String, Any>): String

open fun signUp(payload: Map<String, Any>): String

successResponse

protected open fun successResponse(): String

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

protected open fun validateSignIn(email: String, password: String, language: String, custom: Array<Any>): String

protected open fun validateSignUp(name: String, surname: String, email: String, password: String, language: String, custom: Array<Any>): String

wrongProcedureResponse

protected open fun wrongProcedureResponse(): String