Equinox/com.tecknobit.equinox.environment.helpers.services/EquinoxUsersHelper

Equinox Users Helper

@Service

open class EquinoxUsersHelper<T : EquinoxUser?, R : EquinoxUsersRepository<T>?> : EquinoxItemsHelper<T> , ResourcesManager

The EquinoxUsersHelper class is useful to manage all the user database operations

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

Constructors

EquinoxUsersHelper

constructor()

Constructor to init the EquinoxUsersHelper controller No-any params required

Properties

_DROP_COLUMN_

protected val _DROP_COLUMN_: String = " DROP COLUMN "

_DROP_COLUMN_ query command

_IN_CLAUSE_

private val _IN_CLAUSE_: String = " IN "

IN_CLAUSE in clause query part

_VALUES_

val _VALUES_: String = " VALUES "

VALUES values query part

_WHERE_

val _WHERE_: String = " WHERE "

WHERE where query part

ALTER_TABLE_

protected val ALTER_TABLE_: String = "ALTER TABLE "

ALTER_TABLE_ query command

BASE_SIGN_UP_QUERY

protected val BASE_SIGN_UP_QUERY: String = "INSERT INTO users("

BASE_SIGN_UP_QUERY base part of the insertion query

CLOSED_ROUND_BRACKET

val CLOSED_ROUND_BRACKET: String = ")"

CLOSED_ROUND_BRACKET closed round bracket character

COMMA

val COMMA: String = ","

COMMA comma character

DEFAULT_USER_VALUES_KEYS

protected val DEFAULT_USER_VALUES_KEYS: List<String>

DEFAULT_USER_VALUES_KEYS the default keys of the values to use in the BASE_SIGN_UP_QUERY

DELETE_FROM_

val DELETE_FROM_: String = "DELETE FROM "

DELETE_FROM_ delete from query command

discriminatorValue

protected open var discriminatorValue: String

discriminatorValue value of the discriminator to use to save the users in the related table

entityManager

protected open var entityManager: EntityManager

entityManager entity manager helper

OPENED_ROUND_BRACKET

val OPENED_ROUND_BRACKET: String = "("

OPENED_ROUND_BRACKET opened round bracket character

PROFILES_DIRECTORY

val PROFILES_DIRECTORY: String = "profiles"

PROFILES_DIRECTORY the folder where the profile pics will be saved

QUESTION_MARK

val QUESTION_MARK: String = "?"

QUESTION_MARK question mark character

RESOURCES_KEY

val RESOURCES_KEY: String = "resources"

RESOURCES_KEY the key of the resources folder where the resources will be saved

RESOURCES_PATH

val RESOURCES_PATH: String = "resources/"

RESOURCES_PATH the folder where the resources will be saved

SINGLE_QUOTE

val SINGLE_QUOTE: String = "'"

SINGLE_QUOTE single quote character

usersRepository

@Autowired

protected open var usersRepository: R

usersRepository instance for the users repository

VALUES_QUERY_PART

protected val VALUES_QUERY_PART: String = " VALUES ("

VALUES_QUERY_PART values query part

Functions

arrangeQuery

private open fun <E> arrangeQuery(queryBuilder: StringBuilder, list: List<E>, escape: Boolean)

Method to arrange the BASE_SIGN_UP_QUERY with dynamic list of values to use in that query

batchDelete

protected open fun batchDelete(table: String, values: List<List<out Any>>, columns: Array<String>)

Method to execute a batch delete of a list of data simultaneously

batchInsert

protected open fun batchInsert(command: EquinoxItemsHelper.InsertCommand, table: String, values: List<out Any>, batchQuery: EquinoxItemsHelper.BatchQuery, columns: Array<String>)

Method to execute a batch insert of a list of data simultaneously

changeEmail

open fun changeEmail(newEmail: String, userId: String)

Method to change the email of the EquinoxUser

changeLanguage

open fun changeLanguage(newLanguage: String, userId: String)

Method to change the language of the EquinoxUser

changePassword

open fun changePassword(newPassword: String, userId: String)

Method to change the password of the EquinoxUser

changeProfilePic

open fun changeProfilePic(profilePic: MultipartFile, userId: String): String

Method to change the profile pic of the EquinoxUser

createProfileResource

open fun createProfileResource(resource: MultipartFile, resourceId: String): String

Method to create the pathname for a profile pic

createResource

open fun createResource(resource: MultipartFile, resourcesDirectory: String, resourceId: String): String

Method to create the pathname of a resource file

deleteProfileResource

open fun deleteProfileResource(userId: String): Boolean

Method to delete a profile pic

deleteResource

open fun deleteResource(resourcesDirectory: String, resourceId: String): Boolean

Method to delete a resource file

deleteUser

open fun deleteUser(id: String)

Method to delete a user

getQueryValuesKeys

protected open fun getQueryValuesKeys(): List<String>

Method to get the list of keys to use in the BASE_SIGN_UP_QUERY No-any params required

getSuffixResource

open fun getSuffixResource(resource: MultipartFile): String

Method to get the suffix of a resource file

hash

protected open fun hash(secret: String): String

Method to hash a sensitive user data

saveResource

open fun saveResource(resource: MultipartFile, path: String)

Method to save a resource file

signInUser

open fun signInUser(email: String, password: String, custom: Array<Any>): T

Method to sign in an existing user

signUpUser

open fun signUpUser(id: String, token: String, name: String, surname: String, email: String, password: String, language: String, custom: Array<Any>)

Method to sign up a new user in the system

syncBatch

protected open fun <V> syncBatch(container: EquinoxItemsHelper.SyncBatchContainer, table: String, targetId: String, updatedData: List<V>, batchQuery: EquinoxItemsHelper.BatchQuery)

Method to execute a batch synchronization of a list of data simultaneously

validateSignIn

protected open fun validateSignIn(user: T, password: String, custom: Array<Any>): Boolean

Method to validate the sign in request