backend/com.tecknobit.brownie.services.hosts.services/HostsService

Hosts Service

@Service

open class HostsService

The HostsService class is useful to manage all the BrownieHost database operations

Author

N7ghtm4r3 - Tecknobit

Constructors

HostsService

@Autowired

constructor(hostsRepository: HostsRepository, eventsService: HostEventsService, servicesService: HostServicesService)

Constructor used to init the service

Properties

eventsService

private val eventsService: HostEventsService

eventsService the support service used to manage the host events data

hostsRepository

private val hostsRepository: HostsRepository

hostsRepository instance used to access to the HOSTS_KEY table

servicesService

private val servicesService: HostServicesService

servicesService the support service used to manage the services data

Functions

addService

open fun addService(host: BrownieHost, serviceName: String, hPayload: JsonHelper)

Method used to add a service to a host

editHost

open fun editHost(hostId: String, hostAddress: String, hostName: String, sshUser: String, sshPassword: String, sessionId: String)

Method used to edit an existing host

editService

open fun editService(host: BrownieHost, serviceId: String, serviceName: String, hPayload: JsonHelper)

Method used to edit an existing service of a host

findServicePath

private open fun findServicePath(host: BrownieHost, serviceName: String): String

Method used to find the path of the service inside the filesystem of the machine

getBrownieHost

open fun getBrownieHost(sessionId: String, hostId: String): BrownieHost

Method used to check whether a host belongs to the specified session

getHostOverview

open fun getHostOverview(host: BrownieHost): BrownieHostOverview

Method used to retrieve the current overview of a host

getHosts

open fun getHosts(sessionId: String, keywords: Set<String>, statuses: List<String>, page: Int, pageSize: Int): PaginatedResponse<BrownieHost>

Method used to get the list of the hosts

getHostsStatus

open fun getHostsStatus(hosts: List<String>): List<CurrentHostStatus>

Method used to get the current status of the specified hosts

getNetworkInterfaceDetails

private open fun getNetworkInterfaceDetails(sshUser: String, sshPassword: String, hostAddress: String): Pair<String, String>

Method used to retrieve the network interface details of the remote host

handleHostStatus

private open fun handleHostStatus(hostId: String, status: HostStatus)

Method used to set the status of a host

handleServicesOnStart

private open fun handleServicesOnStart(host: BrownieHost)

Method used to handle the services of the host has been rebooted or stopped

hostBelongsToSession

open fun hostBelongsToSession(sessionId: String, hostId: String): Boolean

Method used to check whether a host belongs to the specified session

rebootHost

open fun rebootHost(host: BrownieHost)

Method used to reboot a host

registerHost

open fun registerHost(hostId: String, hostName: String, hostAddress: String, sshUser: String, sshPassword: String, sessionId: String)

Method used to register a new host

restartHost

open fun restartHost(host: BrownieHost)

Method used to restart a host after it has been rebooted or stopped

safeguardHostData

private open fun safeguardHostData(hostId: String, sessionId: String, sshUser: String, sshPassword: String, hostAddress: String): RemoteHostData

Method used to safeguard the sensitive data of a remote host

setOfflineStatus

open fun setOfflineStatus(host: BrownieHost)

Method used to set the OFFLINE status of a host and all its attached services

setOnlineStatus

open fun setOnlineStatus(host: BrownieHost)

Method used to set the ONLINE status of a host

setRebootingStatus

open fun setRebootingStatus(host: BrownieHost)

Method used to set the REBOOTING status of a host and all its attached services

startHost

open fun startHost(host: BrownieHost)

Method used to start the remote host

stopHost

open fun stopHost(host: BrownieHost)

Method used to stop a host

unregisterHost

open fun unregisterHost(host: BrownieHost)

Method used to unregister a host from the system