trait ApplicationFacade extends ServiceFacadeWithDatabase with ServiceFacade[ApplicationFacade]
- Alphabetic
- By Inheritance
- ApplicationFacade
- ServiceFacade
- ServiceFacadeWithDatabase
- ServiceFacadeBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract val environment: String
- Definition Classes
- ServiceFacadeBase
- abstract def getAuditLog(outputStream: OutputStream, from: LocalDateTime = LocalDateTime.MIN, to: LocalDateTime = LocalDateTime.MAX, locale: String = getLogDefaultLocale, maxDecimals: Int = getLogDefaultMaxDecimals): Unit
Gets the audit log for a specific time period.
Gets the audit log for a specific time period. The audit log has information on all API request made by all (non-service) users. The data set is described by AuditLogEntry.
- outputStream
The stream data is written to.
- from
The lower bound on the audit log entries.
- to
The upper bound on the audit log entries.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- abstract def getCacheStatistics: Array[CacheStatistics]
- Definition Classes
- ServiceFacadeBase
- abstract def getCluster(id: String): ClusterInfo
Gets the most recent version of a specific cluster.
Gets the most recent version of a specific cluster.
- id
The unique id of the cluster.
- abstract def getClusters(includeDeleted: Boolean = false): Array[ClusterInfo]
Gets the most recent version of each cluster.
Gets the most recent version of each cluster.
- includeDeleted
Whether to include deleted clusters.
- abstract def getClusters: Array[ClusterInfo]
Gets the most recent version of each cluster.
- abstract def getConfigParameter(id: String): ConfigParameterInfo
Gets the most recent version of a specific config parameter.
Gets the most recent version of a specific config parameter.
- id
The unique id of the config parameter.
- abstract def getConfigParameters(serviceClass: Option[String] = None, serviceName: Option[String] = None, includeDeleted: Boolean = false): Array[ConfigParameterInfo]
Gets the most recent version of each config parameter with optional filters.
Gets the most recent version of each config parameter with optional filters.
- serviceClass
The simple name of the service interface or
Nonefor any interface.- serviceName
The service name of the service instance or
Nonefor any instance.- includeDeleted
Whether to include deleted config parameters.
- abstract def getCurrentUser: ServiceUserInfo
Gets the most recent version of the current user.
- abstract def getDatabase(outputStream: OutputStream): Unit
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def getDatabasePath: String
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def getEnvironment(id: String): ServiceEnvironmentInfo
Gets the most recent version of a specific environment.
Gets the most recent version of a specific environment.
- id
The unique id of the environment.
- abstract def getEnvironments(includeDeleted: Boolean = false): Array[ServiceEnvironmentInfo]
Gets the most recent version of each environment.
Gets the most recent version of each environment.
- includeDeleted
Whether to include deleted environments.
- abstract def getEnvironments: Array[ServiceEnvironmentInfo]
Gets the most recent version of each environment.
- abstract def getEventLog(outputStream: OutputStream, from: LocalDateTime = LocalDateTime.MIN, to: LocalDateTime = LocalDateTime.MAX, locale: String = getLogDefaultLocale, maxDecimals: Int = getLogDefaultMaxDecimals): Unit
Gets the event log for a specific time period.
Gets the event log for a specific time period. The event log has information on all log events triggered from application code, including all exceptions thrown. The data set is described by EventLogEntry.
- outputStream
The stream data is written to.
- from
The lower bound on the audit log entries.
- to
The upper bound on the audit log entries.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- abstract def getFile(path: String, outputStream: OutputStream): Unit
- Definition Classes
- ServiceFacadeBase
- abstract def getLink(id: String): LinkInfo
Gets the most recent version of a specific link.
Gets the most recent version of a specific link.
- id
The unique id of the link.
- abstract def getLinks: Array[LinkInfo]
Gets the most recent version of each active link.
- abstract def getLogForClusterState(machineId: String): String
Get the log information on a specific cluster.
Get the log information on a specific cluster.
- machineId
The unique id of the cluster.
- abstract def getLogForMachineState(machineId: String): String
Get the log information on a specific machine.
Get the log information on a specific machine.
- machineId
The unique id of the machine.
- abstract def getLogLevel: String
- Definition Classes
- ServiceFacadeBase
- abstract def getMachine(id: String): MachineInfo
Gets the most recent version of a specific machine.
Gets the most recent version of a specific machine.
- id
The unique id of the machine.
- abstract def getMachines(includeDeleted: Boolean = false): Array[MachineInfo]
Gets the most recent version of each machine.
Gets the most recent version of each machine.
- includeDeleted
Whether to include deleted machines.
- abstract def getMachines: Array[MachineInfo]
Gets the most recent version of each machine.
- abstract def getPerformanceMetrics: PerformanceMetrics
- Definition Classes
- ServiceFacadeBase
- abstract def getServiceLocation(id: String, name: String, version: String, timeout: Int = defaultServiceWaitTimeout, expiration: Int = defaultServiceExpiration): Option[ServiceLocationInfo]
Gets connection information for a specific service, if available.
Gets connection information for a specific service, if available.
- id
The simple type name of the service API interface, e.g. 'ApplicationFacade'.
- name
The name of service instance.
- version
The version of the service to request.
- timeout
The maximum amount of seconds to wait for connection information.
- expiration
The maximum age in seconds to accept for connection information.
- abstract def getServiceLocations: Array[ServiceLocationInfo]
Gets all available information on services that are, or have been, connected to the application service.
- abstract def getStateForCluster(id: String): ClusterStateInfo
Get the state information on a specific cluster.
Get the state information on a specific cluster.
- id
The unique id of the cluster.
- abstract def getStateForMachine(id: String): MachineStateInfo
Get the state information on a specific machine.
Get the state information on a specific machine.
- id
The unique id of the machine.
- abstract def getUser(id: String): ServiceUserInfo
Gets the most recent version of a specific user.
Gets the most recent version of a specific user.
- id
The unique id of the user.
- abstract def getUserActivity: Array[ServiceUserActivity]
Gets basic activity information for all users that have been active since the service was started.
- abstract def getUserGroup(id: String): ServiceUserGroupInfo
Gets the most recent version of a specific user group.
Gets the most recent version of a specific user group.
- id
The unique id of the user group.
- abstract def getUserGroups(includeDeleted: Boolean = false): Array[ServiceUserGroupInfo]
Gets the most recent version of each user group.
Gets the most recent version of each user group.
- includeDeleted
Whether to include deleted user groups
- abstract def getUserGroups: Array[ServiceUserGroupInfo]
Gets the most recent version of each user group.
- abstract def getUsers(includeDeleted: Boolean = false): Array[ServiceUserInfo]
Gets the most recent version of each user.
Gets the most recent version of each user.
- includeDeleted
Whether to include deleted users.
- abstract def getUsers: Array[ServiceUserInfo]
Gets the most recent version of each user.
- abstract def getVersion: String
- Definition Classes
- ServiceFacadeBase
- abstract def getVersionForCluster(id: String, version: UUID): ClusterInfo
Gets a specific version of a specific cluster.
Gets a specific version of a specific cluster.
- id
The unique id of the cluster.
- version
The
UUIDfor the version.
- abstract def getVersionForConfigParameter(id: String, version: UUID): ConfigParameterInfo
Gets a specific version of a specific config parameter.
Gets a specific version of a specific config parameter.
- id
The unique id of the config parameter.
- version
The
UUIDfor the version.
- abstract def getVersionForEnvironment(id: String, version: UUID): ServiceEnvironmentInfo
Gets a specific version of a specific environment.
Gets a specific version of a specific environment.
- id
The unique id of the environment.
- version
The
UUIDfor the version.
- abstract def getVersionForMachine(id: String, version: UUID): MachineInfo
Gets a specific version of a specific machine.
Gets a specific version of a specific machine.
- id
The unique id of the machine.
- version
The
UUIDfor the version.
- abstract def getVersionForUser(id: String, version: UUID): ServiceUserInfo
Gets a specific version of a specific user.
Gets a specific version of a specific user.
- id
The unique id of the user.
- version
The
UUIDfor the version.
- abstract def getVersionForUserGroup(id: String, version: UUID): ServiceUserGroupInfo
Gets a specific version of a specific user group.
Gets a specific version of a specific user group.
- id
The unique id of the user group.
- version
The
UUIDfor the version.
- abstract def getVersionsForCluster(id: String): Array[ClusterInfo]
Gets all versions of a specific cluster.
Gets all versions of a specific cluster.
- id
The unique id of the cluster.
- abstract def getVersionsForConfigParameter(id: String): Array[ConfigParameterInfo]
Gets all versions of a specific config parameter.
Gets all versions of a specific config parameter.
- id
The unique id of the config parameter.
- abstract def getVersionsForEnvironment(id: String): Array[ServiceEnvironmentInfo]
Gets all versions of a specific environment.
Gets all versions of a specific environment.
- id
The unique id of the environment.
- abstract def getVersionsForMachine(id: String): Array[MachineInfo]
Gets all versions of a specific machine.
Gets all versions of a specific machine.
- id
The unique id of the machine.
- abstract def getVersionsForUser(id: String): Array[ServiceUserInfo]
Gets all versions of a specific user.
Gets all versions of a specific user.
- id
The unique id of the user.
- abstract def getVersionsForUserGroup(id: String): Array[ServiceUserGroupInfo]
Gets all versions of a specific user group.
Gets all versions of a specific user group.
- id
The unique id of the user group.
- abstract def isReady: Boolean
- Definition Classes
- ServiceFacadeBase
- abstract def postAuditLog(entries: Array[AuditLogEntry]): Unit
Append a collection of entries to the audit log.
Append a collection of entries to the audit log.
- entries
The collection of entries.
- abstract def postAwsCliCommand(region: String, scope: String, command: String): String
- abstract def postAzureCliCommand(command: String): String
- abstract def postBugReport(bugReport: BugReport): Unit
Submit a bug report from a user to the system administrator.
Submit a bug report from a user to the system administrator.
- bugReport
Information on the bug report to send.
- abstract def postCachePurge(id: Option[String]): Unit
- Definition Classes
- ServiceFacadeBase
- abstract def postCluster(content: ClusterContent): Unit
Creates a new version of a cluster with the specific content.
Creates a new version of a cluster with the specific content.
- content
The content of the new version.
- abstract def postConfigParameter(content: ConfigParameterContent): Unit
Creates a new version of a config parameter with the specific content.
Creates a new version of a config parameter with the specific content.
- content
The content of the new version.
- abstract def postDatabaseBackup(encryptionEnabled: Option[Boolean], encryptionMasterKeyIdentifier: Option[String], outputRepository: String = EnvironmentVariables.output_repository): Unit
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def postDeleteForCluster(id: String): Unit
Marks a specific cluster as deleted.
Marks a specific cluster as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the cluster.
- abstract def postDeleteForConfigParameter(id: String): Unit
Marks a specific config parameter as deleted.
Marks a specific config parameter as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the config parameter.
- abstract def postDeleteForEnvironment(id: String): Unit
Marks a specific environment as deleted.
Marks a specific environment as deleted. Technically a copy of the most recent version is created with the deletion time set. Only environments without result data can be deleted. Deleting an environment will eventually delete the databases and associated with that environment.
- id
The unique id of the environment.
- abstract def postDeleteForLink(id: String): Unit
Marks a specific link as deleted.
Marks a specific link as deleted. Technically a copy of the most recent version is created with the deletion time set. The associated user is deleted alongside the link.
- id
The unique id of the link.
- abstract def postDeleteForMachine(id: String): Unit
Marks a specific machine as deleted.
Marks a specific machine as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the machine.
- abstract def postDeleteForUser(id: String): Unit
Marks a specific user as deleted.
Marks a specific user as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the user.
- abstract def postDeleteForUserGroup(id: String): Unit
Marks a specific user group as deleted.
Marks a specific user group as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the user group.
- abstract def postEmail(email: OutgoingEmail, environment: String): Array[EmailReceipt]
Send an email using connection information in a given environment.
Send an email using connection information in a given environment. Note that EnvironmentVariables.DATASOLVR_OUTGOING_MAIL_ENVIRONMENT takes precedence over the given environment.
Information on the email to send.
- environment
The given environment.
- abstract def postEnvironment(content: ServiceEnvironmentContent): Unit
Creates a new version of a environment with the specific content.
Creates a new version of a environment with the specific content.
- content
The content of the new version.
- abstract def postEnvironmentBackup(id: String, encryptionEnabled: Option[Boolean], encryptionMasterKeyIdentifier: Option[String], outputRepository: Option[String]): Unit
Creates a new backup of the database for each service used by the environment.
Creates a new backup of the database for each service used by the environment.
- id
The unique ID of the environment
- encryptionEnabled
An optional value indicating whether to encrypt the backup. If left blank, the system default will be used
- encryptionMasterKeyIdentifier
An optional identifier for a master key to use for encrypting the backup. Must be specified if encryptionEnabled is set to true
- outputRepository
An optional URI for an alternate output repository where to store the backup
- abstract def postErrorReport(errorReport: ErrorReport): Unit
Submit an internal error report to the system administrator.
Submit an internal error report to the system administrator.
- errorReport
Information on the error report to send.
- abstract def postEventLog(entries: Array[EventLogEntry]): Unit
Append a collection of entries to the event log.
Append a collection of entries to the event log.
- entries
The collection of entries.
- abstract def postFlushLog(): Unit
Flush the audit and event log buffers to persistent storage.
Flush the audit and event log buffers to persistent storage. This is done automatically on a periodic basis, but can be triggered manually if one needs to restart the service without dropping the buffers.
- abstract def postForgotPassword(email: String): Unit
Sends an email with password reset information to the user matching a specific email address.
Sends an email with password reset information to the user matching a specific email address. If the email address does not match any user nothing is done. This requires EnvironmentVariables.auth_password_reset_url to be configured.
The specific email address.
- abstract def postInstanceProtectionForCluster(instanceId: String, protect: Boolean): Unit
Sets whether a specific AWS instance managed by a cluster is protected from termination.
Sets whether a specific AWS instance managed by a cluster is protected from termination. For internal use only. Used to prevent auto scaling from terminating busy instances.
- instanceId
The AWS id of the instance.
- protect
Whether the instance should be protected or not.
- abstract def postLdapQuery(query: LdapQuery): Array[LdapEntry]
- abstract def postLink(link: LinkContent): LinkInfo
Creates a new link with the specified content.
Creates a new link with the specified content.
- link
The content of the link.
- abstract def postLinkLogin(id: String): LinkLoginResult
Obtains an authentication token for the user associated with the given link id, as well as a url that the user should be redirected to.
Obtains an authentication token for the user associated with the given link id, as well as a url that the user should be redirected to.
- id
The unique id of the link.
- abstract def postLogin(credentials: Login): LoginResult
Obtains an authentication token for given user credentials.
Obtains an authentication token for given user credentials. If TOTP is enabled this will initially return a TOTP challenge.
- credentials
The username and password.
- abstract def postLogout(user: String): Unit
Logout a specific user.
Logout a specific user. This invalidate all authentication tokens associated with the user.
- user
The specific user.
- abstract def postLogoutSelf(uuid: UUID): Unit
Invalidate all authentication tokens associated with the user associated with a specific authentication token.
Invalidate all authentication tokens associated with the user associated with a specific authentication token.
- uuid
The specific token to use.
- abstract def postMachine(content: MachineContent): Unit
Creates a new version of a machine with the specific content.
Creates a new version of a machine with the specific content.
- content
The content of the new version.
- abstract def postResendSignUpSelf(): Unit
Runs the sign up script for the authenticated user.
Runs the sign up script for the authenticated user. This would be used to resend the verification email.
- abstract def postResetTotpSecret(userId: String): Unit
Reset the TOTP secret for a specific user.
Reset the TOTP secret for a specific user. Use this if a user no longer has access to their TOTP device.
- userId
The unique id of the user.
- abstract def postRestart: Unit
- Definition Classes
- ServiceFacadeBase
- abstract def postServiceLocation(id: String, name: String, buildInfo: BuildLabels, hostname: String, port: Int, startTime: LocalDateTime): Unit
Update the information on a service with given id and name.
Update the information on a service with given id and name.
- id
The simple type name of the service API interface, e.g. 'ApplicationFacade'.
- name
The name of service instance.
- buildInfo
The build information for the service instance.
- hostname
The DNS name or IP address where the service is located.
- port
The port on which the service can be reached.
- startTime
The time when the service was started.
- abstract def postSignUp(credentials: Login): Unit
Register a user for sign up with given credentials.
Register a user for sign up with given credentials. This stores the user in an unauthorized state and runs the sign up script configured in EnvironmentVariables.sign_up_script_id.
- credentials
The credentials for the user signing up.
- abstract def postStartForCluster(id: String): Unit
Starts a specific cluster.
Starts a specific cluster. Starting a cluster means that it will actively monitor instance requests.
- id
The unique id of the cluster
- abstract def postStartForMachine(id: String, stopAfter: Option[LocalDateTime]): Unit
Starts a specific machine.
Starts a specific machine. Depending on the machine configuration this may or may not start the underlying AWS instance.
- id
The unique id of the machine.
- stopAfter
A date after which to automatically stop the machine.
- abstract def postStopForCluster(id: String): Unit
Stop a specific cluster.
Stop a specific cluster. Stopping a cluster disables all monitoring of cluster instances. It does not stop those instances.
- id
The unique id of the cluster
- abstract def postStopForMachine(id: String): Unit
Stops a specific machine.
Stops a specific machine. This will always stop the underlying AWS instance.
- id
The unique id of the machine.
- abstract def postToken(token: UUID): Option[AuthorizationInfo]
Gets the authorization information associated with a specific authentication token, if available.
Gets the authorization information associated with a specific authentication token, if available.
- token
The specific authentication token.
- abstract def postUser(content: ServiceUserContent): Unit
Creates a new version of a user with the specific content.
Creates a new version of a user with the specific content.
- content
The content of the new version.
- abstract def postUserGroup(content: ServiceUserGroupContent): Unit
Creates a new version of a user group with the specific content.
Creates a new version of a user group with the specific content.
- content
The content of the new version.
- abstract def postVacuumDatabase: Unit
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def postVerifyEmail(email: String, token: UUID): Unit
Verify an email address for a given verification token.
Verify an email address for a given verification token. This is matched against the value stored in UserOptions.EMAIL_VERIFICATION_TOKEN.
The email address to verify.
- token
The given email verification token.
- abstract def setLogLevel(level: String): Unit
- Definition Classes
- ServiceFacadeBase
- abstract def withTimeout(seconds: Int): ApplicationFacade
- Definition Classes
- ServiceFacade
- abstract def withToken(token: UUID): ApplicationFacade
- Definition Classes
- ServiceFacade
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val getLogDefaultLocale: String
The default value for
localeused in getAuditLog and getEventLog.The default value for
localeused in getAuditLog and getEventLog. The value is equal to EnvironmentVariables.DATASOLVR_DEFAULT_OUTPUT_LOCALE. - val getLogDefaultMaxDecimals: Int
The default value for
maxDecimalsused in getAuditLog and getEventLog.The default value for
maxDecimalsused in getAuditLog and getEventLog. The value is equal to EnvironmentVariables.DATASOLVR_DEFAULT_MAX_DECIMALS. - def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def waitIsReady(timeoutSeconds: Int, pollIntervalSeconds: Int): Unit
- Definition Classes
- ServiceFacadeBase
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)