Equinox/com.tecknobit.equinox.environment.controllers/EquinoxController

Equinox Controller

@RestController

@RequestMapping(value = "/api/v1/" )

abstract class EquinoxController<T : EquinoxUser?, R : EquinoxUsersRepository<T>?, H : EquinoxUsersHelper<T, R>?>

The EquinoxController class is useful to give the base behavior of the Equinox's controllers

Author

N7ghtm4r3 - Tecknobit

Since

1.0.1

Parameters

<T>

: the type of the EquinoxUser used in the system, is generic to avoid manual casts if it has been customized

<R>

: the type of the EquinoxUsersRepository used in the system, is generic to avoid manual casts if it has been customized

<H>

: the type of the EquinoxUsersHelper used in the system, is generic to avoid manual casts if it has been customized

Inheritors

DefaultEquinoxController

EquinoxUsersController

Constructors

EquinoxController

constructor()

Properties

jsonHelper

protected open var jsonHelper: JsonHelper

jsonHelper helper to work with JSON values

mantis

protected val mantis: Mantis

mantis the translations manager

protected open var me: T

me user representing the user who made a request on the server

NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE

val NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE: String = "not_authorized_key"

NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE message to use when the request is by a not authorized user or tried to fetch wrong details

resourcesProvider

open var resourcesProvider: ResourcesProvider

resourcesProvider the resources provider and manager

RESPONSE_SUCCESSFUL_MESSAGE

val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully_key"

RESPONSE_SUCCESSFUL_MESSAGE message to use when the request has been successful

serverProtector

protected open var serverProtector: ServerProtector

protector the instance to launch the server protector to manage the server accesses

usersRepository

@Autowired(required = false )

protected open var usersRepository: R

usersRepository instance for the user repository

WRONG_PROCEDURE_MESSAGE

val WRONG_PROCEDURE_MESSAGE: String = "wrong_procedure_key"

WRONG_PROCEDURE_MESSAGE message to use when the procedure is wrong

Functions

checkEnvironmentStatus

@PostConstruct

private open fun checkEnvironmentStatus()

Method to check if the status of the environment has been set up correctly based on the use or not of the usersRepository No-any params required

failedResponse

protected open fun failedResponse(error: String): String

Method to get the payload for a failed response

generateIdentifier

open fun generateIdentifier(): String

Method to generate an identifier of an item No-any params required

initEquinoxEnvironment

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

Method to init the serverProtector and create the resources directories correctly

isMe

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

Method to check whether the user who made a request is an authorized user If the user is authorized the me instance is loaded

loadJsonHelper

protected open fun loadJsonHelper(payload: String)

protected open fun <V> loadJsonHelper(payload: Map<String, V>)

Method to load the jsonHelper

plainResponse

private open fun plainResponse(responseCode: SocketManager.StandardResponseCode, message: String): String

Method to assemble the payload for a response

setBasicResourcesConfiguration

private open fun setBasicResourcesConfiguration(context: Class<out Any>, customSubDirectories: Array<String>)

Method to configure the resources folders required by the Equinox's environment and the beans classes to correctly serve the static resources and set the CORS policy

successResponse

protected open fun successResponse(): String

Method to get the payload for a successful response No-any params required

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

protected open fun successResponse(message: JSONObject): String

Method to get the payload for a successful response