backend/com.tecknobit.brownie.services.hostservices.controller/HostServicesController

Host Services Controller

@RestController

@RequestMapping(value = "BASE_EQUINOX_ENDPOINT + SESSIONS_KEY + "/{" + IDENTIFIER_KEY + "}/" + HOSTS_KEY + "/{" + HOST_IDENTIFIER_KEY + "}/" + SERVICES_KEY" )

open class HostServicesController : DefaultBrownieController

The HostServicesController class is useful to manage all the BrownieHostService operations

Author

N7ghtm4r3 - Tecknobit

Constructors

HostServicesController

@Autowired

constructor(sessionsService: BrownieSessionsService, hostsService: HostsService, service: HostServicesService)

Constructor used to init the controller

Properties

configuration

protected val configuration: EquinoxBackendConfiguration

currentBrownieSession

protected open var currentBrownieSession: BrownieSession

currentBrownieSession the current Brownie's session used in the request

hostsService

protected val hostsService: HostsService

hostsService the support service used to manage the hosts data

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"

resourcesProvider

open var resourcesProvider: ResourcesProvider

RESPONSE_SUCCESSFUL_MESSAGE

val RESPONSE_SUCCESSFUL_MESSAGE: String = "operation_executed_successfully"

serverProtector

protected open var serverProtector: ServerProtector

service

private val service: HostServicesService

service the support service used to manage the services data

sessionsService

protected val sessionsService: BrownieSessionsService

sessionsService the support service used to manage the sessions data

SOMETHING_WENT_WRONG_MESSAGE

val SOMETHING_WENT_WRONG_MESSAGE: String = "something_went_wrong"

SOMETHING_WENT_WRONG_MESSAGE the key of the message sent to the clients when a remote SSH connection failed

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

addService

@PutMapping

open fun addService(@PathVariable(value = "id") sessionId: String, @PathVariable(value = "host_id") hostId: String, @RequestParam(value = "language", required = false, defaultValue = "en") language: String, @RequestBody payload: Map<String, Any>): String

Endpoint used to add a service to a host

editService

@PatchMapping(path = "/{" + SERVICE_IDENTIFIER_KEY + "}" )

open fun editService(@PathVariable(value = "id") sessionId: String, @PathVariable(value = "host_id") hostId: String, @PathVariable(value = "service_id") serviceId: String, @RequestParam(value = "language", required = false, defaultValue = "en") language: String, @RequestBody payload: Map<String, Any>): String

Endpoint used to edit an existing service to a host

failedResponse

protected open fun failedResponse(errorKey: String): String

generateIdentifier

open fun generateIdentifier(): String

getBrownieHostIfAllowed

protected open fun getBrownieHostIfAllowed(sessionId: String, hostId: String): BrownieHost

Method to retrieve a BrownieHost checking the identifier of the session and its identifier

getInternationalizedMessage

protected open fun getInternationalizedMessage(messageKey: String): String

getService

@GetMapping(path = "/{" + SERVICE_IDENTIFIER_KEY + "}" )

open fun <T> getService(@PathVariable(value = "id") sessionId: String, @PathVariable(value = "host_id") hostId: String, @PathVariable(value = "service_id") serviceId: String, @RequestParam(value = "language", required = false, defaultValue = "en") language: String): T

Endpoint used to get an existing service of a host

getServices

@GetMapping

open fun <T> getServices(@PathVariable(value = "id") sessionId: String, @PathVariable(value = "host_id") hostId: String, @RequestParam(name = "keywords", defaultValue = "", required = false) keywords: Set<String>, @RequestParam(name = "statuses", defaultValue = "RUNNING, STOPPED, REBOOTING", required = false) statuses: List<String>, @RequestParam(value = "language", required = false, defaultValue = "en") language: String, @RequestParam(name = "page", defaultValue = "0", required = false) page: Int, @RequestParam(name = "pageSize", defaultValue = "10", required = false) pageSize: Int): T

Endpoint used to retrieve the services of a host

getServicesStatus

@GetMapping(path = ""/" + STATUS_KEY" )

open fun <T> getServicesStatus(@PathVariable(value = "id") sessionId: String, @PathVariable(value = "host_id") hostId: String, @RequestParam(name = "services", defaultValue = "") services: List<String>, @RequestParam(value = "language", required = false, defaultValue = "en") language: String): T

Endpoint used to retrieve the current status of the specified services

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)

notAuthorizedOrWrongDetailsResponse

protected open fun notAuthorizedOrWrongDetailsResponse(): String

plainResponse

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

rebootService

@PatchMapping(path = ""/{" + SERVICE_IDENTIFIER_KEY + "}" + REBOOT_ENDPOINT" )

open fun rebootService(@PathVariable(value = "id") sessionId: String, @PathVariable(value = "host_id") hostId: String, @PathVariable(value = "service_id") serviceId: String, @RequestParam(value = "language", required = false, defaultValue = "en") language: String): String

Endpoint used to reboot a service

removeService

@DeleteMapping(path = "/{" + SERVICE_IDENTIFIER_KEY + "}" )

open fun removeService(@PathVariable(value = "id") sessionId: String, @PathVariable(value = "host_id") hostId: String, @PathVariable(value = "service_id") serviceId: String, @RequestParam(value = "language", required = false, defaultValue = "en") language: String, @RequestParam(value = "remove_from_the_host", required = false, defaultValue = "false") removeFromTheHost: Boolean): String

Endpoint used to remove a service

sessionExists

protected open fun sessionExists(sessionId: String): Boolean

Method to check whether a session exists by its id

setSessionLocale

protected open fun setSessionLocale(locale: String)

startService

@PatchMapping(path = ""/{" + SERVICE_IDENTIFIER_KEY + "}" + START_ENDPOINT" )

open fun startService(@PathVariable(value = "id") sessionId: String, @PathVariable(value = "host_id") hostId: String, @PathVariable(value = "service_id") serviceId: String, @RequestParam(value = "language", required = false, defaultValue = "en") language: String): String

Endpoint used to start a service

stopService

@PatchMapping(path = ""/{" + SERVICE_IDENTIFIER_KEY + "}" + STOP_ENDPOINT" )

open fun stopService(@PathVariable(value = "id") sessionId: String, @PathVariable(value = "host_id") hostId: String, @PathVariable(value = "service_id") serviceId: String, @RequestParam(value = "language", required = false, defaultValue = "en") language: String): String

Endpoint used to stop a service

successResponse

protected open fun successResponse(): String

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

wrongProcedureResponse

protected open fun wrongProcedureResponse(): String

Host Services Controller

Author

See also

Constructors

Properties

Functions