com.atlassian.connect.spring

Class AtlassianHost

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()

Method Summary

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)
void	setBaseUrl(String baseUrl)
void	setClientKey(String clientKey)
void	setCreatedBy(String createdBy)
void	setCreatedDate(Calendar createdDate)
void	setDescription(String description)
void	setLastModifiedBy(String lastModifiedBy)
void	setLastModifiedDate(Calendar lastModifiedDate)
void	setOauthClientId(String oauthClientId)
void	setProductType(String productType)
void	setPublicKey(String publicKey)
void	setServiceEntitlementNumber(String serviceEntitlementNumber)
void	setSharedSecret(String sharedSecret)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AtlassianHost

public AtlassianHost()

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)

getPublicKey

public String getPublicKey()

Deprecated. No replacement.

The public key for the Atlassian product instance.

setPublicKey

public void setPublicKey(String publicKey)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object