equinox-backend/com.tecknobit.equinoxbackend.environment.services/DefaultEquinoxController

Default Equinox Controller

abstract class DefaultEquinoxController : EquinoxController<T, R, H>

The DefaultEquinoxController class is useful to give the base behavior of the Equinox's controllers with the default EquinoxUser class and for a greater clarity during your own implementation:



    
    public SomeCustomController extends EquinoxController<EquinoxUser> {
         // rest of the class
    }

    
    public SomeCustomControllerTwo extends EquinoxController<EquinoxUser> {
         // rest of the class
    }

    // wrap the declaration for a better readability
    
    public SomeCustomController extends DefaultEquinoxController {
         // rest of the class
    }

     // wrap the declaration for a better readability
    
    public SomeCustomControllerTwo extends DefaultEquinoxController {
         // rest of the class
    }

Author

N7ghtm4r3 - Tecknobit

Since

1.0.2

Constructors

DefaultEquinoxController

constructor()

Properties

protected open var jsonHelper: JsonHelper

jsonHelper helper to work with JSON values

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

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

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

protected open fun loadJsonHelper(payload: String)

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

Method to load the jsonHelper

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: String): String

protected open fun successResponse(message: JSONObject): String

Method to get the payload for a successful response