backend/com.tecknobit.brownie.services.hosts.entities/BrownieHost

Brownie Host

@Entity

open class BrownieHost : EquinoxItem

The BrownieHost class is useful to represent a Brownie's host

Author

N7ghtm4r3 - Tecknobit

Constructors

BrownieHost

constructor()

Constructor to instantiate the object

constructor(id: String, name: String, hostAddress: String, status: HostStatus, sshUser: String, sshPassword: String, session: BrownieSession, macAddress: String, broadcastIp: String, events: List<HostHistoryEvent>, services: List<BrownieHostService>, insertionDate: Long)

Constructor to instantiate the object

Properties

broadcastIp

open val broadcastIp: String

broadcastIp the ip address of the remote host network interface

DISCRIMINATOR_VALUE_KEY

val DISCRIMINATOR_VALUE_KEY: String = "dtype"

events

val events: List<HostHistoryEvent>

events the events related to the lifecycle of the host

hItem

protected val hItem: JsonHelper

hostAddress

val hostAddress: String

hostAddress the address of the host

protected val id: String

insertionDate

val insertionDate: Long

insertionDate the date when the host has been inserted in the system

macAddress

open val macAddress: String

macAddress the physical mac address of the remote host network interface

name

val name: String

name the name of the host

services

val services: List<BrownieHostService>

services the services attached to the host

session

val session: BrownieSession

session the owner session of the host

sshPassword

open val sshPassword: String

sshPassword the password to use for the SSH connection

sshUser

open val sshUser: String

sshUser the user to use for the SSH connection

status

val status: HostStatus

status the current status of the host

Functions

decryptSensitiveData

private open fun decryptSensitiveData()

Method used to decrypt the remote host's sensitive data

encryptSensitiveData

private open fun encryptSensitiveData()

Method used to encrypt the remote host's sensitive data

getId

open fun getId(): String

getService

open fun getService(serviceId: String): BrownieHostService

Method to retrieve the specified service from to the host

handleSensitiveData

private open fun handleSensitiveData(hostData: RemoteHostData)

Method used to handle the sensitive data of the remote host, assigning the encrypted or decrypted values to the fields

hasService

open fun hasService(serviceId: String): Boolean

Method to check whether the specified service belongs to the host

inSafeContext

open fun inSafeContext(usage: Consumer<BrownieHost>)

Method used to handle the remote host's sensitive data, decrypting and after custom usage, encrypting again

isOffline

open fun isOffline(): Boolean

Method to check whether the host is currently OFFLINE

isOnline

open fun isOnline(): Boolean

Method to check whether the host is currently ONLINE

isRemoteHost

open fun isRemoteHost(): Boolean

Method to check whether the host is remotely connected

listRunningServiceNames

open fun listRunningServiceNames(): List<String>

Method used to list the names of the running services of this host

listRunningServicePids

open fun listRunningServicePids(): HashSet<Long>

Method used to list the pids of the running services of this host

toString

open fun toString(): String

Brownie Host

Author

See also

Constructors

Properties

Functions