Packages

trait AtlassianHost extends AnyRef

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.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AtlassianHost
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def baseUrl: String

    URL prefix for this Atlassian product instance.

    URL prefix for this Atlassian product instance.

    returns

    Base URL for this product instance.

  2. abstract def clientKey: ClientKey

    Identifying key for the Atlassian product instance that the add-on was installed into.

    Identifying key for the Atlassian product instance that the add-on was installed into.

    returns

    Client key for this product instance.

  3. abstract def description: String

    Host product description.

    Host product description.

    returns

    Description of this product.

  4. abstract def 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.

    returns

    Installation status for this add-on.

  5. abstract def key: String

    Add-on key that was installed into the Atlassian product, as it appears in your add-on's descriptor.

    Add-on key that was installed into the Atlassian product, as it appears in your add-on's descriptor.

    returns

    Add-on key for this add-on.

  6. abstract def oauthClientId: Option[String]

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

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

    returns

    OAuth 2.0 client id.

  7. abstract def pluginsVersion: String

    Semver compliant version of Atlassian Connect which is running on the host server.

    Semver compliant version of Atlassian Connect which is running on the host server.

    returns

    Version of Atlassian Connect on this product instance.

  8. abstract def productType: String

    Identifies the category of Atlassian product, e.g.

    Identifies the category of Atlassian product, e.g. jira or confluence.

    returns

    Category of this product.

  9. abstract def publicKey: String

    Public key for this Atlassian product instance.

    Public key for this Atlassian product instance.

    returns

    Public key for this product instance.

  10. abstract def serverVersion: String

    Host product's version.

    Host product's version.

    returns

    Version of this product instance.

  11. abstract def 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.

    returns

    Add-on license id if this is a paid add-on.

  12. abstract def 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.

    returns

    Shared secret for this product instance.

  13. abstract def uninstalled: AtlassianHost

    Uninstalls this host by setting the installed field to false.

    Uninstalls this host by setting the installed field to false.

    returns

    A new version of this host with the installed field set to false.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped