backend/com.tecknobit.pandoro.services.overview.controller/OverviewController

Overview Controller

@RestController

@RequestMapping(path = "BASE_EQUINOX_ENDPOINT + USERS_KEY + "/{" + IDENTIFIER_KEY + "}/" + OVERVIEW_ENDPOINT" )

open class OverviewController : DefaultPandoroController

The OverviewController class is useful to manage all the overview operations

Author

N7ghtm4r3 - Tecknobit

Constructors

OverviewController

@Autowired

constructor(overviewService: OverviewService)

Constructor used to init the controller

Properties

configuration

protected val configuration: EquinoxBackendConfiguration

jsonHelper

protected open var jsonHelper: JsonHelper

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"

overviewService

private val overviewService: OverviewService

overviewService instance to manage the overview database operations

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

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

failedResponse

protected open fun failedResponse(errorKey: String): String

generateIdentifier

open fun generateIdentifier(): String

getInternationalizedMessage

protected open fun getInternationalizedMessage(messageKey: String): String

getOverview

@GetMapping(headers = [] )

open fun <T> getOverview(@PathVariable(value = "id") userId: String, @RequestHeader(value = "token") token: String): T

Method to get the overview analysis for the requested user

initEquinoxEnvironment

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

isMe

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

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>

wrongProcedureResponse

protected open fun wrongProcedureResponse(): String

Overview Controller

Author

See also

Constructors

Properties

Functions