Brownie

backend/com.tecknobit.brownie.services.session.controller/BrownieSessionController

Brownie Session Controller

@RestController

@RequestMapping(value = "BASE_EQUINOX_ENDPOINT + SESSIONS_KEY" )

open class BrownieSessionController : DefaultBrownieController

The BrownieSessionController class is useful to manage all the BrownieSession operations

Author

N7ghtm4r3 - Tecknobit

See also

EquinoxController

DefaultEquinoxController

DefaultBrownieController

Constructors

BrownieSessionController

@Autowired

constructor(sessionsService: BrownieSessionsService, hostsService: HostsService)

Constructor used to init the controller

Properties

brownieServerProtector

open var brownieServerProtector: ServerProtector

brownieServerProtector instance of the ServerProtector used to protect the accesses to a private backend instance

protected val configuration: EquinoxBackendConfiguration

currentBrownieSession

protected open var currentBrownieSession: BrownieSession

currentBrownieSession the current Brownie's session used in the request

protected val hostsService: HostsService

hostsService the support service used to manage the hosts data

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

sessionsService

protected val sessionsService: BrownieSessionsService

sessionsService the support service used to manage the sessions data

SOMETHING_WENT_WRONG_MESSAGE

val SOMETHING_WENT_WRONG_MESSAGE: String = "something_went_wrong"

SOMETHING_WENT_WRONG_MESSAGE the key of the message sent to the clients when a remote SSH connection failed

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

connectToSession

@PutMapping(path = "/connect" )

open fun <T> connectToSession(@RequestBody payload: Map<String, String>): T

Endpoint used to connect to an existing session

@PostMapping

open fun <T> createSession(@RequestBody payload: Map<String, String>): T

Endpoint used to create a new session

@DeleteMapping(path = "/{" + IDENTIFIER_KEY + "}" )

open fun deleteSession(@PathVariable(value = "id") sessionId: String, @RequestParam(value = "language", required = false, defaultValue = "en") language: String, @RequestBody payload: Map<String, String>): String

Endpoint used to delete an existing session

protected open fun failedResponse(errorKey: String): String

generateIdentifier

open fun generateIdentifier(): String

getBrownieHostIfAllowed

protected open fun getBrownieHostIfAllowed(sessionId: String, hostId: String): BrownieHost

Method to retrieve a BrownieHost checking the identifier of the session and its identifier

getInternationalizedMessage

protected open fun getInternationalizedMessage(messageKey: String): String

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

protected open fun sessionExists(sessionId: String): Boolean

Method to check whether a session exists by its id

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