Pandoro

backend/com.tecknobit.pandoro.services.users.controller/PandoroUsersController

Pandoro Users Controller

@RestController

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

The PandoroUsersController class is useful to manage all the user operations

Author

N7ghtm4r3 - Tecknobit

Since

1.0.5

See also

EquinoxController

Constructors

PandoroUsersController

constructor()

Properties

protected val configuration: EquinoxBackendConfiguration

protected open var jsonHelper: JsonHelper

protected val mantis: Mantis

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

usersRepository

protected open var usersRepository: R

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

Functions

assembleSignInSuccessResponse

protected open fun assembleSignInSuccessResponse(user: T): JSONObject

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

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

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

changeProfilePic

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

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

protected open fun failedResponse(errorKey: String): String

generateIdentifier

open fun generateIdentifier(): String

getCandidateMembers

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

open fun <T> getCandidateMembers( @PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @RequestParam(name = "members", required = false) membersToExcludeSize: Long): T

Method to count the candidate members availability

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

open fun <T> getCandidateMembers( @PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @RequestParam(name = "page", defaultValue = "0", required = false) page: Int, @RequestParam(name = "pageSize", defaultValue = "10", required = false) pageSize: Int, @RequestParam(name = "members") membersToExclude: ArrayList<String>): T

Method to get a list of candidates to be members of a group

getDynamicAccountData

open fun getDynamicAccountData(id: 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( storagePath: String, saveMessage: String, context: Class<out Any>, args: Array<String>, customSubDirectories: Array<String>)

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

protected open fun loadJsonHelper(payload: JSONObject)

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

setSessionLocale

protected open fun setSessionLocale(locale: String)

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

open fun signUp(payload: Map<String, String>): 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