backend/com.tecknobit.glider.services.passwords.controller/PasswordsController

Passwords Controller

@RestController
@RequestMapping(path = "BASE_EQUINOX_ENDPOINT + USERS_KEY + "/{" + IDENTIFIER_KEY + "}/" + PASSWORDS_KEY" )
open class PasswordsController : DefaultGliderController

The PasswordsController class is useful to handle the requests to operate with Password entities

Author

N7ghtm4r3 - Tecknobit

See also

EquinoxController

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
protected open var jsonHelper: JsonHelper
Link copied to clipboard
protected val mantis: Mantis
Link copied to clipboard
protected open var me: T
Link copied to clipboard
protected open var messageSource: MessageSource
Link copied to clipboard
Link copied to clipboard
@Autowired
private open var passwordsService: PasswordsService
passwordsService helper to manage the passwords database operations
Link copied to clipboard
open var resourcesProvider: ResourcesProvider
Link copied to clipboard
val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully"
Link copied to clipboard
protected open var serverProtector: ServerProtector
Link copied to clipboard
protected open var usersRepository: R
Link copied to clipboard
val WRONG_EMAIL_MESSAGE: String = "wrong_email"
Link copied to clipboard
val WRONG_LANGUAGE_MESSAGE: String = "wrong_language"
Link copied to clipboard
val WRONG_NAME_MESSAGE: String = "wrong_name"
Link copied to clipboard
val WRONG_PASSWORD_MESSAGE: String = "wrong_password"
Link copied to clipboard
val WRONG_PROCEDURE_MESSAGE: String = "wrong_procedure"
Link copied to clipboard
val WRONG_SCOPES_MESSAGE: String = "wrong_scopes"
WRONG_SCOPES_MESSAGE message to use when the scopes of a password are wrong
Link copied to clipboard
val WRONG_SURNAME_MESSAGE: String = "wrong_surname"
Link copied to clipboard
val WRONG_TAIL_MESSAGE: String = "wrong_tail"
WRONG_TAIL_MESSAGE message to use when the tail of a password is wrong

Functions

Link copied to clipboard
@DeleteMapping(path = "/{" + PASSWORD_IDENTIFIER_KEY + "}", headers = [] )
open fun deletePassword(    @PathVariable(value = "id") userId: String,     @RequestHeader(value = "token") token: String,     @RequestHeader(value = "device_id") deviceId: String,     @PathVariable(value = "password_id") passwordId: String): String
Endpoint used to delete a password
Link copied to clipboard
@PatchMapping(path = "/{" + PASSWORD_IDENTIFIER_KEY + "}", headers = [] )
open fun editPassword(    @PathVariable(value = "id") userId: String,     @RequestHeader(value = "token") token: String,     @RequestHeader(value = "device_id") deviceId: String,     @PathVariable(value = "password_id") passwordId: String,     @RequestBody payload: Map<String, Any>): String
Endpoint used to edit an existing password of a user
Link copied to clipboard
protected open fun failedResponse(errorKey: String): String
Link copied to clipboard
Link copied to clipboard
@PutMapping(headers = [] )
open fun generatePassword(    @PathVariable(value = "id") userId: String,     @RequestHeader(value = "token") token: String,     @RequestHeader(value = "device_id") deviceId: String,     @RequestBody payload: Map<String, Any>): String
Endpoint used to generate a new password for a user
Link copied to clipboard
protected open fun getInternationalizedMessage(messageKey: String): String
Link copied to clipboard
@GetMapping(path = ""/" + KEYCHAIN_ENDPOINT", headers = [] )
open fun <T> getKeychain(    @PathVariable(value = "id") userId: String,     @RequestHeader(value = "token") token: String,     @RequestHeader(value = "device_id") deviceId: String,     @RequestParam(name = "page", defaultValue = "0", required = false) page: Int,     @RequestParam(name = "pageSize", defaultValue = "10", required = false) pageSize: Int,     @RequestParam(name = "keywords", defaultValue = "", required = false) keywords: Set<String>,     @RequestParam(name = "type", defaultValue = "GENERATED, INSERTED", required = false) types: Set<String>): T
Endpoint used to retrieve the keychain owned by the user
Link copied to clipboard
@GetMapping(path = "/{" + PASSWORD_IDENTIFIER_KEY + "}", headers = [] )
open fun <T> getPassword(    @PathVariable(value = "id") userId: String,     @RequestHeader(value = "token") token: String,     @RequestHeader(value = "device_id") deviceId: String,     @PathVariable(value = "password_id") passwordId: String): T
Endpoint used to retrieve a password owned by the user
Link copied to clipboard
open fun initEquinoxEnvironment(    storagePath: String,     saveMessage: String,     context: Class<out Any>,     args: Array<String>,     customSubDirectories: Array<String>)
Link copied to clipboard
@PostMapping(headers = [] )
open fun insertPassword(    @PathVariable(value = "id") userId: String,     @RequestHeader(value = "token") token: String,     @RequestHeader(value = "device_id") deviceId: String,     @RequestBody payload: Map<String, Any>): String
Endpoint used to insert a password owned by a user
Link copied to clipboard
protected open fun isMe(id: String, token: String): Boolean
Link copied to clipboard
protected open fun loadJsonHelper(payload: JSONObject)
Link copied to clipboard
@PutMapping(path = "/{" + PASSWORD_IDENTIFIER_KEY + "}", headers = [] )
open fun notifyCopiedPassword(    @PathVariable(value = "id") userId: String,     @RequestHeader(value = "token") token: String,     @RequestHeader(value = "device_id") deviceId: String,     @PathVariable(value = "password_id") passwordId: String): String
Endpoint used to notify the copy of a password
Link copied to clipboard
protected open fun plainResponse(status: ResponseStatus, message: String): String
Link copied to clipboard
@PatchMapping(path = ""/{" + PASSWORD_IDENTIFIER_KEY + "}" + REFRESH_ENDPOINT", headers = [] )
open fun refreshGeneratedPassword(    @PathVariable(value = "id") userId: String,     @RequestHeader(value = "token") token: String,     @RequestHeader(value = "device_id") deviceId: String,     @PathVariable(value = "password_id") passwordId: String): String
Endpoint used to refresh a GENERATED password
Link copied to clipboard
protected open fun setSessionLocale(locale: String)
Link copied to clipboard
protected open fun successResponse(): String
protected open fun <V> successResponse(value: V): HashMap<String, V>
Link copied to clipboard
private open fun validPasswordRequest(userId: String, token: String, deviceId: String, passwordId: String): Boolean
Method used to validate a request related to a Password's operation
Link copied to clipboard
protected open fun validRequester(userId: String, token: String, deviceId: String): Boolean
Method used to validate the requester's identifier, token and the device id from requested an operation