backend/com.tecknobit.pandoro.services.changelogs.controller/ChangelogsController

Changelogs Controller

@RestController
@RequestMapping(path = "BASE_EQUINOX_ENDPOINT + USERS_KEY + "/{" + IDENTIFIER_KEY + "}/" + CHANGELOGS_KEY" )
open class ChangelogsController : DefaultPandoroController

The ChangelogsController class is useful to manage all the changelog operations

Author

N7ghtm4r3 - Tecknobit

See also

EquinoxController

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@Autowired
private open var changelogsHelper: ChangelogsHelper
changelogsHelper instance to manage the changelogs database operations
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
val NOT_AUTHORIZED_OR_WRONG_DETAILS_MESSAGE: String = "not_authorized_key"
Link copied to clipboard
open var resourcesProvider: ResourcesProvider
Link copied to clipboard
val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully_key"
Link copied to clipboard
protected open var serverProtector: ServerProtector
Link copied to clipboard
protected open var usersRepository: R
Link copied to clipboard
val WRONG_PROCEDURE_MESSAGE: String = "wrong_procedure_key"

Functions

Link copied to clipboard
@DeleteMapping(path = "{" + CHANGELOG_IDENTIFIER_KEY + "}", headers = [] )
open fun deleteChangelog(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "changelog_id") changelogId: String, @RequestBody(required = false) payload: Map<String, String>): String
Method to delete a changelog
Link copied to clipboard
protected open fun failedResponse(error: String): String
Link copied to clipboard
Link copied to clipboard
@GetMapping(headers = [] )
open fun <T> getChangelogs(@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): T
Method to get a changelogs list
Link copied to clipboard
@GetMapping(path = ""/" + UNREAD_CHANGELOGS_ENDPOINT", headers = [] )
open fun <T> getUnreadChangelogsCount(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String): T
Method to get an unread changelogs list
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
protected open fun isMe(id: String, token: String): Boolean
Link copied to clipboard
protected open fun <V> loadJsonHelper(payload: Map<String, V>)
Link copied to clipboard
@PatchMapping(path = "{" + CHANGELOG_IDENTIFIER_KEY + "}", headers = [] )
open fun readChangelog(@PathVariable(value = "id") id: String, @RequestHeader(value = "token") token: String, @PathVariable(value = "changelog_id") changelogId: String): String
Method to read a changelog
Link copied to clipboard
protected open fun successResponse(): String
protected open fun <V> successResponse(value: V): HashMap<String, V>