backend/com.tecknobit.refy.services.teams.controller/TeamsController

TeamsController

@RestController

@RequestMapping(value = "BASE_EQUINOX_ENDPOINT + USERS_KEY + "/{" + USER_IDENTIFIER_KEY + "}/" + TEAMS_KEY")

open class TeamsController : DefaultRefyController<I>

The TeamsController class is useful to manage all the Team operations

Author

N7ghtm4r3 - Tecknobit

Constructors

TeamsController

@Autowired

protected constructor(linksService: LinksService, linksCollectionsService: LinksCollectionsService, teamsService: TeamsService, refyUsersService: RefyUsersService)

Constructor used to init the controller

Properties

configuration

protected val configuration: EquinoxBackendConfiguration

jsonHelper

protected open var jsonHelper: JsonHelper

linksCollectionsService

protected val linksCollectionsService: LinksCollectionsService

linksCollectionsService helper to manage the LinksCollection database operations

linksService

protected val linksService: LinksService

linksService helper to manage the RefyLink database operations

protected open var me: T

messageSource

protected open var messageSource: MessageSource

NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE

val NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE: String = "not_authorized"

refyUsersService

private val refyUsersService: RefyUsersService

refyUsersService helper to manage the RefyUser database operations

resourcesProvider

open var resourcesProvider: ResourcesProvider

RESPONSE_SUCCESSFUL_MESSAGE

val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully"

serverProtector

protected open var serverProtector: ServerProtector

teamsService

protected val teamsService: TeamsService

teamsService helper to manage the Team database operations

userItem

protected open var userItem: I

userItem the current item requested by the user

usersRepository

protected open var usersRepository: R

WRONG_EMAIL_MESSAGE

val WRONG_EMAIL_MESSAGE: String = "wrong_email"

WRONG_LANGUAGE_MESSAGE

val WRONG_LANGUAGE_MESSAGE: String = "wrong_language"

WRONG_NAME_MESSAGE

val WRONG_NAME_MESSAGE: String = "wrong_name"

WRONG_PASSWORD_MESSAGE

val WRONG_PASSWORD_MESSAGE: String = "wrong_password"

WRONG_PROCEDURE_MESSAGE

val WRONG_PROCEDURE_MESSAGE: String = "wrong_procedure"

WRONG_SURNAME_MESSAGE

val WRONG_SURNAME_MESSAGE: String = "wrong_surname"

Functions

changeMemberRole

@PatchMapping(headers = "token", path = ""/{" + TEAM_IDENTIFIER_KEY + "}/" + MEMBERS_KEY + "/{" + MEMBER_IDENTIFIER_KEY + "}" + CHANGE_MEMBER_ROLE_ENDPOINT")

open fun changeMemberRole(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String, @PathVariable(value = "member_id") memberId: String, @RequestBody payload: Map<String, Any>): String

Method to change the role of a member

create

@PostMapping(headers = "token")

open fun create(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @ModelAttribute payload: TeamsService.TeamPayload): String

Method to create a new team

open fun create(token: String, userId: String, payload: Map<String, Any>): String

Method to create a new item

delete

@DeleteMapping(headers = "token", path = "/{" + TEAM_IDENTIFIER_KEY + "}")

open fun delete(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String): String

Method to delete a team

edit

@PostMapping(headers = "token", path = "/{" + TEAM_IDENTIFIER_KEY + "}")

open fun edit(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String, @ModelAttribute payload: TeamsService.TeamPayload): String

Method to edit a team

open fun edit(token: String, userId: String, itemId: String, payload: Map<String, Any>): String

Method to edit an existing item

failedResponse

protected open fun failedResponse(errorKey: String): String

generateIdentifier

open fun generateIdentifier(): String

getInternationalizedMessage

protected open fun getInternationalizedMessage(messageKey: String): String

getItem

@GetMapping(headers = "token", path = "/{" + TEAM_IDENTIFIER_KEY + "}")

open fun <T> getItem(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String): T

Method to get a team

getTeamCollections

@GetMapping(headers = "token", path = ""/{" + TEAM_IDENTIFIER_KEY + "}/" + COLLECTIONS_KEY")

open fun <T> getTeamCollections(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String, @RequestParam(name = "page", defaultValue = "0", required = false) page: Int, @RequestParam(name = "pageSize", defaultValue = "10", required = false) pageSize: Int): T

Method to get the list of the collections of a team

getTeamLinks

@GetMapping(headers = "token", path = ""/{" + TEAM_IDENTIFIER_KEY + "}/" + LINKS_KEY")

open fun <T> getTeamLinks(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: 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>): T

Method to get the list of the links of a team

hierarchyIsNotRespected

private open fun hierarchyIsNotRespected(userId: String, memberId: String): Boolean

Method to check whether the hierarchy of the members is respected in the request

initEquinoxEnvironment

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

isMe

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

isUserNotAuthorized

protected open fun isUserNotAuthorized(userId: String, token: String, teamId: String): Boolean

Method to get whether the user is or not authorized to operate with the team requested

leave

@DeleteMapping(headers = "token", path = ""/{" + TEAM_IDENTIFIER_KEY + "}" + LEAVE_ENDPOINT")

open fun leave(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String): String

Method to leave from a team

list

@GetMapping(headers = "token")

open fun <T> list(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @RequestParam(name = "owned_only") ownedOnly: Boolean, @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>): T

Method to get a list of teams

listPotentialMembers

@GetMapping(headers = "token", path = ""/" + MEMBERS_KEY")

open fun <T> listPotentialMembers(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @RequestParam(name = "page", defaultValue = "0", required = false) page: Int, @RequestParam(name = "pageSize", defaultValue = "10", required = false) pageSize: Int): T

Method to get the potential members to add in a team

loadJsonHelper

protected open fun loadJsonHelper(payload: JSONObject)

notAuthorizedOrWrongDetailsResponse

protected open fun notAuthorizedOrWrongDetailsResponse(): String

plainResponse

protected open fun plainResponse(status: ResponseStatus, message: String): String

removeCollectionFromTeam

@DeleteMapping(headers = "token", path = "/{" + TEAM_IDENTIFIER_KEY + "}/" + COLLECTIONS_KEY + "/{" + COLLECTION_IDENTIFIER_KEY + "}")

open fun removeCollectionFromTeam(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String, @PathVariable(value = "collection_id") collectionId: String): String

Method to remove a collection from a team

removeLinkFromTeam

@DeleteMapping(headers = "token", path = "/{" + TEAM_IDENTIFIER_KEY + "}/" + LINKS_KEY + "/{" + LINK_IDENTIFIER_KEY + "}")

open fun removeLinkFromTeam(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String, @PathVariable(value = "link_id") linkId: String): String

Method to remove a link from a team

removeMember

@DeleteMapping(headers = "token", path = "/{" + TEAM_IDENTIFIER_KEY + "}/" + MEMBERS_KEY + "/{" + MEMBER_IDENTIFIER_KEY + "}")

open fun removeMember(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String, @PathVariable(value = "member_id") memberId: String): String

Method to remove a member from a team

setSessionLocale

protected open fun setSessionLocale(locale: String)

shareCollectionsWithTeam

@PutMapping(headers = "token", path = ""/{" + TEAM_IDENTIFIER_KEY + "}/" + COLLECTIONS_KEY")

open fun shareCollectionsWithTeam(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String, @RequestBody payload: Map<String, Any>): String

Method to share the collections with the team

shareLinksWithTeam

@PutMapping(headers = "token", path = ""/{" + TEAM_IDENTIFIER_KEY + "}/" + LINKS_KEY")

open fun shareLinksWithTeam(@RequestHeader(value = "token") token: String, @PathVariable(value = "user_id") userId: String, @PathVariable(value = "team_id") teamId: String, @RequestBody payload: Map<String, Any>): String

Method to share the links with the team

successResponse

protected open fun successResponse(): String

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

userIsNotTheItemOwner

protected open fun userIsNotTheItemOwner(userId: String, token: String, itemId: String): Boolean

Method to get whether the user is or not the owner of the item requested

wrongProcedureResponse

protected open fun wrongProcedureResponse(): String

TeamsController

Author

See also

Constructors

Properties

Functions