backend/com.tecknobit.pandoro.services.groups.controller/GroupsController

Groups Controller

@RestController

@RequestMapping(path = "BASE_EQUINOX_ENDPOINT + USERS_KEY + "/{" + IDENTIFIER_KEY + "}/" + GROUPS_KEY" )

open class GroupsController : DefaultPandoroController

The GroupsController class is useful to manage all the group operations

Author

N7ghtm4r3 - Tecknobit

Constructors

GroupsController

constructor()

Properties

CANNOT_EXECUTE_ACTION_ON_OWN_ACCOUNT_MESSAGE

val CANNOT_EXECUTE_ACTION_ON_OWN_ACCOUNT_MESSAGE: String = "action_executed_on_own_account_error_key"

CANNOT_EXECUTE_ACTION_ON_OWN_ACCOUNT_MESSAGE message to use when the user tried to execute an action on its account wrong

groupsHelper

@Autowired

private open var groupsHelper: GroupsHelper

groupsHelper instance to manage the groups database operations

jsonHelper

protected open var jsonHelper: JsonHelper

mantis

protected val mantis: Mantis

protected open var me: T

NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE

val NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE: String = "not_authorized_key"

resourcesProvider

open var resourcesProvider: ResourcesProvider

RESPONSE_SUCCESSFUL_MESSAGE

val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully_key"

serverProtector

protected open var serverProtector: ServerProtector

usersRepository

protected open var usersRepository: R

WRONG_GROUP_ALREADY_EXISTS_ERROR_MESSAGE

val WRONG_GROUP_ALREADY_EXISTS_ERROR_MESSAGE: String = "group_name_already_exists_key"

WRONG_GROUP_ALREADY_EXISTS_ERROR_MESSAGE message to use when the name of the group is already used

WRONG_GROUP_DESCRIPTION_ERROR_MESSAGE

val WRONG_GROUP_DESCRIPTION_ERROR_MESSAGE: String = "wrong_group_description_key"

WRONG_GROUP_DESCRIPTION_ERROR_MESSAGE message to use when the description of the group is not a valid description

WRONG_GROUP_NAME_ERROR_MESSAGE

val WRONG_GROUP_NAME_ERROR_MESSAGE: String = "wrong_group_name_key"

WRONG_GROUP_NAME_ERROR_MESSAGE message to use when the name of the group is not a valid name

WRONG_PROCEDURE_MESSAGE

val WRONG_PROCEDURE_MESSAGE: String = "wrong_procedure_key"

Functions

acceptInvitation

@PatchMapping(path = ""/{" + GROUP_IDENTIFIER_KEY + "}" + ACCEPT_GROUP_INVITATION_ENDPOINT", headers = [] )

open fun acceptInvitation(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "group_id") groupId: String, @RequestBody payload: Map<String, String>): String

Method to accept a group invitation

addMembers

@PutMapping(path = ""/{" + GROUP_IDENTIFIER_KEY + "}" + ADD_MEMBERS_ENDPOINT", headers = [] )

open fun addMembers(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "group_id") groupId: String, @RequestBody payload: Map<String, Any>): String

Method to add members to a group

changeMemberRole

@PatchMapping(path = ""/{" + GROUP_IDENTIFIER_KEY + "}" + CHANGE_MEMBER_ROLE_ENDPOINT", headers = [] )

open fun changeMemberRole(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "group_id") groupId: String, @RequestBody payload: Map<String, String>): String

Method to change the role of a group member

createGroup

@PostMapping(headers = [] )

open fun createGroup(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @ModelAttribute payload: GroupDTO): String

Method to create a new group

declineInvitation

@DeleteMapping(path = ""/{" + GROUP_IDENTIFIER_KEY + "}" + DECLINE_GROUP_INVITATION_ENDPOINT", headers = [] )

open fun declineInvitation(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "group_id") groupId: String, @RequestBody payload: Map<String, String>): String

Method to decline a group invitation

deleteGroup

@DeleteMapping(path = "/{" + GROUP_IDENTIFIER_KEY + "}", headers = [] )

open fun deleteGroup(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "group_id") groupId: String): String

Method to delete a group

editGroup

@PostMapping(path = "/{" + GROUP_IDENTIFIER_KEY + "}", headers = [] )

open fun editGroup(@PathVariable(value = "id") id: String, @PathVariable(value = "group_id") groupId: String, @RequestHeader(value = "token") token: String, @ModelAttribute payload: GroupDTO): String

Method to create edit an existing group

editProjects

@PatchMapping(path = ""/{" + GROUP_IDENTIFIER_KEY + "}" + EDIT_PROJECTS_ENDPOINT", headers = [] )

open fun editProjects(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "group_id") groupId: String, @RequestBody payload: Map<String, Any>): String

Method to edit the projects of a group

failedResponse

protected open fun failedResponse(error: String): String

generateIdentifier

open fun generateIdentifier(): String

getGroup

@GetMapping(path = "/{" + GROUP_IDENTIFIER_KEY + "}", headers = [] )

open fun <T> getGroup(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "group_id") groupId: String): T

Method to get a single group

getGroups

@GetMapping(headers = [] )

open fun <T> getGroups(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @RequestParam(name = "page", defaultValue = "0", required = false) page: Int, @RequestParam(name = "pageSize", defaultValue = "10", required = false) pageSize: Int, @RequestParam(name = "authored_groups", defaultValue = "false", required = false) authoredGroups: Boolean, @RequestParam(name = "name", defaultValue = "", required = false) groupName: String, @RequestParam(name = "roles", defaultValue = "", required = false) roles: List<String>): T

Method to get a groups list

initEquinoxEnvironment

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

isMe

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

isNotTheAuthor

private open fun isNotTheAuthor(group: Group, memberId: String): Boolean

Method to check whether the member of the operation is not the author of the group

isValidRequest

private open fun isValidRequest(id: String, token: String, payload: GroupDTO, editingMode: Boolean): String

Method to check the validity of a request between createGroup and editGroup

leaveGroup

@DeleteMapping(path = ""/{" + GROUP_IDENTIFIER_KEY + "}" + LEAVE_GROUP_ENDPOINT", headers = [] )

open fun leaveGroup(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "group_id") groupId: String, @RequestBody(required = false) payload: Map<String, String>): String

Method to leave from a group

loadJsonHelper

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

removeMember

@DeleteMapping(path = ""/{" + GROUP_IDENTIFIER_KEY + "}" + REMOVE_MEMBER_ENDPOINT", headers = [] )

open fun removeMember(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "group_id") groupId: String, @RequestBody payload: Map<String, String>): String

Method to remove a group member

successResponse

protected open fun successResponse(): String

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

Groups Controller

Author

See also

Constructors

Properties

Functions