AtlassianHost

An Atlassian host in which the add-on is or has been installed. Hosts are stored in AtlassianHostRepository.

During processing of a request from an Atlassian host, the details of the host and of the user at the browser can be obtained from the AtlassianHostUser.

clientKey: Identifying key for the Atlassian product instance that the add-on was installed into.
key: Add-on key that was installed into the Atlassian Product, as it appears in your add-on's descriptor.
publicKey: Public key for this Atlassian product instance.
oauthClientId: OAuth 2.0 client ID for the add-on used for OAuth 2.0 - JWT Bearer token authorization grant type.
sharedSecret: Secret to sign outgoing JWT tokens and validate incoming JWT tokens. Only sent on the installed event.
serverVersion: Host product's version.
pluginsVersion: Semver compliant version of Atlassian Connect which is running on the host server.
baseUrl: URL prefix for this Atlassian product instance.
productType: Identifies the category of Atlassian product, e.g. jira or confluence.
description: Host product description.
serviceEntitlementNumber: Service entitlement number (SEN) is the add-on license id. Only included during installation of a paid add-on.
installed: Indicates if the add-on is currently installed on the host. Upon uninstallation, the value of this flag will be set to false.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new AtlassianHost(clientKey: ClientKey, key: String, publicKey: String, oauthClientId: Option[String], sharedSecret: String, serverVersion: String, pluginsVersion: String, baseUrl: String, productType: String, description: String, serviceEntitlementNumber: Option[String], installed: Boolean)

clientKey
Identifying key for the Atlassian product instance that the add-on was installed into.
key
Add-on key that was installed into the Atlassian Product, as it appears in your add-on's descriptor.
publicKey
Public key for this Atlassian product instance.
oauthClientId
OAuth 2.0 client ID for the add-on used for OAuth 2.0 - JWT Bearer token authorization grant type.
sharedSecret
Secret to sign outgoing JWT tokens and validate incoming JWT tokens. Only sent on the installed event.
serverVersion
Host product's version.
pluginsVersion
Semver compliant version of Atlassian Connect which is running on the host server.
baseUrl
URL prefix for this Atlassian product instance.
productType
Identifies the category of Atlassian product, e.g. jira or confluence.
description
Host product description.
serviceEntitlementNumber
Service entitlement number (SEN) is the add-on license id. Only included during installation of a paid add-on.
installed
Indicates if the add-on is currently installed on the host. Upon uninstallation, the value of this flag will be set to false.

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
val baseUrl: String

URL prefix for this Atlassian product instance.
val clientKey: ClientKey

Identifying key for the Atlassian product instance that the add-on was installed into.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val description: String

Host product description.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val installed: Boolean

Indicates if the add-on is currently installed on the host.
Indicates if the add-on is currently installed on the host. Upon uninstallation, the value of this flag will be set to false.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val key: String

Add-on key that was installed into the Atlassian Product, as it appears in your add-on's descriptor.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val oauthClientId: Option[String]

OAuth 2.0 client ID for the add-on used for OAuth 2.0 - JWT Bearer token authorization grant type.
val pluginsVersion: String

Semver compliant version of Atlassian Connect which is running on the host server.
val productType: String

Identifies the category of Atlassian product, e.g.
Identifies the category of Atlassian product, e.g. jira or confluence.
val publicKey: String

Public key for this Atlassian product instance.
val serverVersion: String

Host product's version.
val serviceEntitlementNumber: Option[String]

Service entitlement number (SEN) is the add-on license id.
Service entitlement number (SEN) is the add-on license id. Only included during installation of a paid add-on.
val sharedSecret: String

Secret to sign outgoing JWT tokens and validate incoming JWT tokens.
Secret to sign outgoing JWT tokens and validate incoming JWT tokens. Only sent on the installed event.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package models

Instance Constructors

new AtlassianHost(clientKey: ClientKey, key: String, publicKey: String, oauthClientId: Option[String], sharedSecret: String, serverVersion: String, pluginsVersion: String, baseUrl: String, productType: String, description: String, serviceEntitlementNumber: Option[String], installed: Boolean)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val baseUrl: String

val clientKey: ClientKey

def clone(): AnyRef

val description: String

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val installed: Boolean

final def isInstanceOf[T0]: Boolean

val key: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val oauthClientId: Option[String]

val pluginsVersion: String

val productType: String

val publicKey: String

val serverVersion: String

val serviceEntitlementNumber: Option[String]

val sharedSecret: String

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped