backend/com.tecknobit.pandoro.services.projects.controller/ProjectsController

Projects Controller

@RestController

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

open class ProjectsController : DefaultPandoroController

The ProjectsController class is useful to manage all the project operations

Author

N7ghtm4r3 - Tecknobit

Constructors

ProjectsController

@Autowired

constructor(projectsService: ProjectsService, updatesService: UpdatesService, changeNotesService: ChangeNotesService)

Constructor used to init the controller

Properties

changeNotesService

private val changeNotesService: ChangeNotesService

changeNotesService the service which handles the database operations of the change notes

configuration

protected val configuration: EquinoxBackendConfiguration

jsonHelper

protected open var jsonHelper: JsonHelper

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"

projectsService

private val projectsService: ProjectsService

projectsService instance to manage the projects database operations

resourcesProvider

open var resourcesProvider: ResourcesProvider

RESPONSE_SUCCESSFUL_MESSAGE

val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully"

serverProtector

protected open var serverProtector: ServerProtector

updatesService

private val updatesService: UpdatesService

updatesService the service which handles the database operations of the updates

usersRepository

protected open var usersRepository: R

WRONG_CHANGE_NOTES_ERROR_MESSAGE

val WRONG_CHANGE_NOTES_ERROR_MESSAGE: String = "wrong_change_notes_list"

WRONG_CHANGE_NOTES_ERROR_MESSAGE message to use when the change notes list is not valid

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_PROJECT_DESCRIPTION_ERROR_MESSAGE

val WRONG_PROJECT_DESCRIPTION_ERROR_MESSAGE: String = "wrong_project_description"

WRONG_PROJECT_DESCRIPTION_ERROR_MESSAGE message to use when the description of the project is not a valid description

WRONG_PROJECT_NAME_ERROR_MESSAGE

val WRONG_PROJECT_NAME_ERROR_MESSAGE: String = "wrong_project_name"

WRONG_PROJECT_NAME_ERROR_MESSAGE message to use when the name of the project is not a valid name

WRONG_PROJECT_NAME_EXISTS_ERROR_MESSAGE

val WRONG_PROJECT_NAME_EXISTS_ERROR_MESSAGE: String = "project_name_already_exists"

WRONG_PROJECT_NAME_EXISTS_ERROR_MESSAGE message to use when the name of the project is already used

WRONG_PROJECT_REPOSITORY_ERROR_MESSAGE

val WRONG_PROJECT_REPOSITORY_ERROR_MESSAGE: String = "wrong_project_repository"

WRONG_PROJECT_REPOSITORY_ERROR_MESSAGE message to use when the repository of the project is not valid

WRONG_PROJECT_VERSION_ERROR_MESSAGE

val WRONG_PROJECT_VERSION_ERROR_MESSAGE: String = "wrong_project_version"

WRONG_PROJECT_VERSION_ERROR_MESSAGE message to use when the version of the project is not valid

WRONG_PUBLISH_UPDATE_REQUEST_ERROR_MESSAGE

val WRONG_PUBLISH_UPDATE_REQUEST_ERROR_MESSAGE: String = "wrong_publish_update_request"

WRONG_PUBLISH_UPDATE_REQUEST_ERROR_MESSAGE message to use when a request to publish an update is not valid

WRONG_START_UPDATE_REQUEST_ERROR_MESSAGE

val WRONG_START_UPDATE_REQUEST_ERROR_MESSAGE: String = "wrong_development_update_request"

WRONG_START_UPDATE_REQUEST_ERROR_MESSAGE message to use when a request to start an update is not valid

WRONG_SURNAME_MESSAGE

val WRONG_SURNAME_MESSAGE: String = "wrong_surname"

WRONG_UPDATE_TARGET_VERSION_ERROR_MESSAGE

val WRONG_UPDATE_TARGET_VERSION_ERROR_MESSAGE: String = "wrong_target_version"

WRONG_UPDATE_TARGET_VERSION_ERROR_MESSAGE message to use when the target version of an update is not valid

WRONG_UPDATE_TARGET_VERSION_EXISTS_ERROR_MESSAGE

val WRONG_UPDATE_TARGET_VERSION_EXISTS_ERROR_MESSAGE: String = "update_version_already_exists"

WRONG_UPDATE_TARGET_VERSION_EXISTS_ERROR_MESSAGE message to use when the version of an update is already used

Functions

addChangeNote

@PutMapping(path = ""/{" + PROJECT_IDENTIFIER_KEY + "}" + UPDATES_PATH + "{" + UPDATE_IDENTIFIER_KEY + "}" + ADD_CHANGE_NOTE_ENDPOINT", headers = [] )

open fun addChangeNote(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @PathVariable(value = "update_id") updateId: String, @RequestBody payload: Map<String, String>): String

Method to add a change note to an update

addProject

@PostMapping(headers = [] )

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

Method to add a new project

deleteChangeNote

@DeleteMapping(path = "/{" + PROJECT_IDENTIFIER_KEY + "}" + UPDATES_PATH + "{" + UPDATE_IDENTIFIER_KEY + "}/" + NOTES_KEY + "/{" + NOTE_IDENTIFIER_KEY + "}", headers = [] )

open fun deleteChangeNote(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @PathVariable(value = "update_id") updateId: String, @PathVariable(value = "note_id") noteId: String): String

Method to delete a change note

deleteProject

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

open fun deleteProject(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String): String

Method to delete a project

deleteUpdate

@DeleteMapping(path = "/{" + PROJECT_IDENTIFIER_KEY + "}" + UPDATES_PATH + "{" + UPDATE_IDENTIFIER_KEY + "}", headers = [] )

open fun deleteUpdate(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @PathVariable(value = "update_id") updateId: String): String

Method to delete an update

editChangeNote

@PatchMapping(path = "/{" + PROJECT_IDENTIFIER_KEY + "}" + UPDATES_PATH + "{" + UPDATE_IDENTIFIER_KEY + "}/" + NOTES_KEY + "/{" + NOTE_IDENTIFIER_KEY + "}", headers = [] )

open fun editChangeNote(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @PathVariable(value = "update_id") updateId: String, @PathVariable(value = "note_id") noteId: String, @RequestBody payload: Map<String, String>): String

Method to edit an existing change note of an update

editProject

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

open fun editProject(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @ModelAttribute payload: ProjectDTO): String

Method to edit an existing project

failedResponse

protected open fun failedResponse(errorKey: String): String

generateIdentifier

open fun generateIdentifier(): String

getAuthoredProjects

@GetMapping(path = "/authored", headers = [] )

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

Method to get the authored projects list

getInDevelopmentProjects

@GetMapping(path = "/in_development", headers = [] )

open fun <T> getInDevelopmentProjects(@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 = "filters", defaultValue = "", required = false) filters: Set<String>): T

Method to get a IN_DEVELOPMENT projects list

getInternationalizedMessage

protected open fun getInternationalizedMessage(messageKey: String): String

getProject

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

open fun <T> getProject(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String): T

Method to get a single project

getProjects

@GetMapping(headers = [] )

open fun <T> getProjects(@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 = "filters", defaultValue = "", required = false) filters: Set<String>): T

Method to get a projects list

handleChangeNote

private open fun handleChangeNote(id: String, token: String, projectId: String, updateId: String, noteId: String, operation: ProjectsController.ChangeNoteOperation): String

Method to manage a change note

initEquinoxEnvironment

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

isMe

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

loadJsonHelper

protected open fun loadJsonHelper(payload: JSONObject)

manageUpdateStatus

private open fun manageUpdateStatus(id: String, token: String, projectId: String, updateId: String, isPublishing: Boolean): String

Method to manage the status of an update

markChangeNoteAsDone

@PatchMapping(path = ""/{" + PROJECT_IDENTIFIER_KEY + "}" + UPDATES_PATH + "{" + UPDATE_IDENTIFIER_KEY + "}/" + NOTES_KEY + "/{" + NOTE_IDENTIFIER_KEY + "}" + MARK_CHANGE_NOTE_AS_DONE_ENDPOINT", headers = [] )

open fun markChangeNoteAsDone(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @PathVariable(value = "update_id") updateId: String, @PathVariable(value = "note_id") noteId: String): String

Method to mark a change note as done

markChangeNoteAsToDo

open fun markChangeNoteAsToDo(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @PathVariable(value = "update_id") updateId: String, @PathVariable(value = "note_id") noteId: String): String

Method to mark a change note as to-do

moveChangeNote

@PutMapping(path = "/{" + PROJECT_IDENTIFIER_KEY + "}" + UPDATES_PATH + "{" + UPDATE_IDENTIFIER_KEY + "}/" + NOTES_KEY + "/{" + NOTE_IDENTIFIER_KEY + "}" + MOVE_ENDPOINT + "{" + DESTINATION_UPDATE_IDENTIFIER_KEY + "}", headers = [] )

open fun moveChangeNote(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @PathVariable(value = "update_id") sourceUpdateId: String, @PathVariable(value = "note_id") noteId: String, @PathVariable(value = "destination_update_id") destinationUpdateId: String): String

Endpoint used to move a change note from an update to other update

notAuthorizedOrWrongDetailsResponse

protected open fun notAuthorizedOrWrongDetailsResponse(): String

plainResponse

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

publishUpdate

@PatchMapping(path = ""/{" + PROJECT_IDENTIFIER_KEY + "}" + UPDATES_PATH + "{" + UPDATE_IDENTIFIER_KEY + "}" + PUBLISH_UPDATE_ENDPOINT", headers = [] )

open fun publishUpdate(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @PathVariable(value = "update_id") updateId: String): String

Method to publish an update of a project

scheduleUpdate

@PostMapping(path = ""/{" + PROJECT_IDENTIFIER_KEY + "}" + UPDATES_PATH + SCHEDULE_UPDATE_ENDPOINT", headers = [] )

open fun scheduleUpdate(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @RequestBody payload: Map<String, Any>): String

Method to schedule an update for a project

setSessionLocale

protected open fun setSessionLocale(locale: String)

startUpdate

@PatchMapping(path = ""/{" + PROJECT_IDENTIFIER_KEY + "}" + UPDATES_PATH + "{" + UPDATE_IDENTIFIER_KEY + "}" + START_UPDATE_ENDPOINT", headers = [] )

open fun startUpdate(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "project_id") projectId: String, @PathVariable(value = "update_id") updateId: String): String

Method to start an update of a project

successResponse

protected open fun successResponse(): String

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

workWithProject

private open fun workWithProject(id: String, token: String, payload: ProjectDTO, projectId: String): String

Method to add or edit a project

wrongProcedureResponse

protected open fun wrongProcedureResponse(): String

Projects Controller

Author

See also

Constructors

Properties

Functions