DefaultEquinoxController
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
}
Content copied to clipboard
Author
N7ghtm4r3 - Tecknobit
Since
1.0.2
Properties
Link copied to clipboard
configuration
the current configuration of the Equinox's backend instanceLink copied to clipboard
jsonHelper
helper to work with JSON valuesLink copied to clipboard
messageSource
the message source used to manage the resources messages bundleLink copied to clipboard
NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE
message to use when the request is by a not authorized user or tried to fetch wrong detailsLink copied to clipboard
resourcesProvider
the resources provider and managerLink copied to clipboard
RESPONSE_SUCCESSFUL_MESSAGE
message to use when the request has been successfulLink copied to clipboard
protector
the instance to launch the server protector to manage the server accessesLink copied to clipboard
usersRepository
instance for the user repositoryLink copied to clipboard
WRONG_EMAIL_MESSAGE
error message used when the email inserted is not validLink copied to clipboard
WRONG_LANGUAGE_MESSAGE
error message used when the language inserted is not validLink copied to clipboard
WRONG_NAME_MESSAGE
error message used when the name inserted is not validLink copied to clipboard
WRONG_PASSWORD_MESSAGE
error message used when the password inserted is not validLink copied to clipboard
WRONG_PROCEDURE_MESSAGE
message to use when the procedure is wrongLink copied to clipboard
WRONG_SURNAME_MESSAGE
error message used when the surname inserted is not validFunctions
Link copied to clipboard
Method used to get the payload for a failed response
Link copied to clipboard
Method used to generate an identifier of an item
Link copied to clipboard
protected open fun getInternationalizedMessage(messageKey: String, @Nullable args: Array<Any>): String
Method used to get the international message
Link copied to clipboard
open fun initEquinoxEnvironment( storagePath: String, saveMessage: String, context: Class<out Any>, args: Array<String>, customSubDirectories: Array<String>)
Method used to init the serverProtector and create the resources directories correctly
Link copied to clipboard
Method used to load the jsonHelper
Link copied to clipboard
Method used to assemble the payload for a response
Link copied to clipboard
Method used to change the current locale of the session
Link copied to clipboard
Method used to get the payload for a successful response