AtlassianHost (Atlassian Connect Spring Boot API 2.1.3 API)

java.lang.Object
- com.atlassian.connect.spring.AtlassianHost

```
public class AtlassianHost
extends Object
```
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.

Since:

1.0.0

See Also:

AtlassianHostRepository

Constructor Summary

Constructors
Constructor and Description

AtlassianHost()
Creates a new empty Atlassian host (used by persistence mechanism).

Constructors
Constructor and Description
`AtlassianHost()` Creates a new empty Atlassian host (used by persistence mechanism).

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getBaseUrl()` The URL prefix for the Atlassian product instance.
`String`	`getClientKey()` The identifying key for the Atlassian product instance that the add-on was installed into.
`String`	`getCreatedBy()` The key of the Atlassian user that first installed the add-on on the host, if any.
`Calendar`	`getCreatedDate()` The time at which the add-on was first installed on the host.
`String`	`getDescription()` The host product description.
`String`	`getLastModifiedBy()` The key of the Atlassian user that last modified the add-on installation, if any.
`Calendar`	`getLastModifiedDate()` The time at which the add-on installation was last modified.
`String`	`getOauthClientId()` Returns the client identifier for use with OAuth 2.0 authentication.
`String`	`getProductType()` The identifier of the category of Atlassian product.
`String`	`getPublicKey()` Deprecated. No replacement.
`String`	`getServiceEntitlementNumber()` The Support Entitlement Number (SEN) is the add-on license identifier.
`String`	`getSharedSecret()` The shared secret issued by the Atlassian product instance on installation of the add-on.
`int`	`hashCode()`
`boolean`	`isAddonInstalled()` Returns true if the add-on is currently installed on the host.
`void`	`setAddonInstalled(boolean addonInstalled)` Used by persistence mechanism.
`void`	`setBaseUrl(String baseUrl)` Used by persistence mechanism.
`void`	`setClientKey(String clientKey)` Used by persistence mechanism.
`void`	`setCreatedBy(String createdBy)` Used by persistence mechanism.
`void`	`setCreatedDate(Calendar createdDate)` Used by persistence mechanism.
`void`	`setDescription(String description)` Used by persistence mechanism.
`void`	`setLastModifiedBy(String lastModifiedBy)` Used by persistence mechanism.
`void`	`setLastModifiedDate(Calendar lastModifiedDate)` Used by persistence mechanism.
`void`	`setOauthClientId(String oauthClientId)` Used by persistence mechanism.
`void`	`setProductType(String productType)` Used by persistence mechanism.
`void`	`setPublicKey(String publicKey)` Used by persistence mechanism.
`void`	`setServiceEntitlementNumber(String serviceEntitlementNumber)` Used by persistence mechanism.
`void`	`setSharedSecret(String sharedSecret)` Used by persistence mechanism.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AtlassianHost
```
public AtlassianHost()
```
    Creates a new empty Atlassian host (used by persistence mechanism).
- Method Detail
  - getClientKey
```
public String getClientKey()
```
    The identifying key for the Atlassian product instance that the add-on was installed into. This will never change for a given instance, and is unique across all Atlassian product tenants. This value should be used to key tenant details in your add-on.
    
    Returns:
    
    the client key of the host
  - setClientKey
```
public void setClientKey(String clientKey)
```
    Used by persistence mechanism.
  - getPublicKey
```
@Deprecated
public String getPublicKey()
```
    Deprecated. No replacement.
    
    The public key of the Atlassian product instance.
    
    Returns:
    
    the public key of the host
  - setPublicKey
```
public void setPublicKey(String publicKey)
```
    Used by persistence mechanism.
  - getOauthClientId
```
public String getOauthClientId()
```
    Returns the client identifier for use with OAuth 2.0 authentication.
    
    Returns:
    
    the OAuth 2.0 client ID
  - setOauthClientId
```
public void setOauthClientId(String oauthClientId)
```
    Used by persistence mechanism.
  - getSharedSecret
```
public String getSharedSecret()
```
    The shared secret issued by the Atlassian product instance on installation of the add-on. This string is used to validate incoming JWT tokens and to sign outgoing JWT tokens.
    
    Returns:
    
    the shared secret of the installation
  - setSharedSecret
```
public void setSharedSecret(String sharedSecret)
```
    Used by persistence mechanism.
  - getBaseUrl
```
public String getBaseUrl()
```
    The URL prefix for the Atlassian product instance. All of its REST endpoints begin with this URL.
    
    Returns:
    
    the base URL of the host
  - setBaseUrl
```
public void setBaseUrl(String baseUrl)
```
    Used by persistence mechanism.
  - getProductType
```
public String getProductType()
```
    The identifier of the category of Atlassian product.
    
    Returns:
    
    the host product type, e.g. jira or confluence
  - setProductType
```
public void setProductType(String productType)
```
    Used by persistence mechanism.
  - getDescription
```
public String getDescription()
```
    The host product description. This string is customisable by an instance administrator.
    
    Returns:
    
    the description of the host
  - setDescription
```
public void setDescription(String description)
```
    Used by persistence mechanism.
  - getServiceEntitlementNumber
```
public String getServiceEntitlementNumber()
```
    The Support Entitlement Number (SEN) is the add-on license identifier. This attribute will only be included during installation of a paid add-on.
    
    Returns:
    
    the SEN
  - setServiceEntitlementNumber
```
public void setServiceEntitlementNumber(String serviceEntitlementNumber)
```
    Used by persistence mechanism.
  - isAddonInstalled
```
public boolean isAddonInstalled()
```
    Returns true if the add-on is currently installed on the host. Upon uninstallation, the value of this flag will be set to false.
    
    Returns:
    
    true if the add-on is installed
  - setAddonInstalled
```
public void setAddonInstalled(boolean addonInstalled)
```
    Used by persistence mechanism.
  - getCreatedDate
```
public Calendar getCreatedDate()
```
    The time at which the add-on was first installed on the host.
    
    Returns:
    
    the creation time
  - setCreatedDate
```
public void setCreatedDate(Calendar createdDate)
```
    Used by persistence mechanism.
  - getLastModifiedDate
```
public Calendar getLastModifiedDate()
```
    The time at which the add-on installation was last modified.
    
    Returns:
    
    the last modification time
  - setLastModifiedDate
```
public void setLastModifiedDate(Calendar lastModifiedDate)
```
    Used by persistence mechanism.
  - getCreatedBy
```
public String getCreatedBy()
```
    The key of the Atlassian user that first installed the add-on on the host, if any.
    
    Returns:
    
    the user key of the creator
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    Used by persistence mechanism.
  - getLastModifiedBy
```
public String getLastModifiedBy()
```
    The key of the Atlassian user that last modified the add-on installation, if any.
    
    Returns:
    
    the user key of the last modifier
  - setLastModifiedBy
```
public void setLastModifiedBy(String lastModifiedBy)
```
    Used by persistence mechanism.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AtlassianHost

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AtlassianHost

Method Detail

getClientKey

setClientKey

getPublicKey

setPublicKey

getOauthClientId

setOauthClientId

getSharedSecret

setSharedSecret

getBaseUrl

setBaseUrl

getProductType

setProductType

getDescription

setDescription

getServiceEntitlementNumber

setServiceEntitlementNumber

isAddonInstalled

setAddonInstalled

getCreatedDate

setCreatedDate

getLastModifiedDate

setLastModifiedDate

getCreatedBy

setCreatedBy

getLastModifiedBy

setLastModifiedBy

equals

hashCode

toString