com.atlassian.confluence.impl.tenant.provisioning

Class ProvisionerApiRequest

java.lang.Object

com.atlassian.confluence.impl.tenant.provisioning.ProvisionerApiRequest

@Internal
public class ProvisionerApiRequest
extends Object

Request JSON received by the provisioning and migration endpoints. (Not intended to be a publicly consumed model object - for internal use by provisioning and migration code only.) See https://extranet.atlassian.com/display/ENG/Cloud+Provisioner+-+Provider+API

See Also:

ProvisioningServlet, AbstractProvisionerApiServlet, ProvisionerApiResponse

Constructor Summary

Constructors

Constructor and Description
ProvisionerApiRequest(String jsonString) Construct by parsing json from Cloud Provisioner

Method Summary

Modifier and Type	Method and Description
String	getCallbackUrl() The callback URL at which the invoking service is listening for our final asynchronous response.
String	getCloudId() The tenant ID, always present.
String	getCloudName() Get the cloudName field if available, else throw ClientException.
String	getCloudNamespace() Get the cloudNamespace field if available, else throw ClientException.
String	getHeartbeatUrl() The heartbeat URL at which the invoking service is listening for our heartbeats during asynchronous processing.
String	getJdbcPassword() Get the JDBC database password from Monarch if available, else throw ClientException.
String	getJdbcUrl() Get the JDBC URL from Monarch if available, else throw ClientException.
String	getJdbcUser() Get the JDBC database user from Monarch if available, else throw ClientException.
Set<String>	getLicensedProductKeys() Get license info from Purchasing in the provisioner request if available, else an empty set.
Optional<String>	getOfflineReason() Get the first reason a tenant is made offline.
Map<String,String>	getProductLicenseInfo() Returns a mapping of all values within LICENSE_PRODUCTS_DATA flattened
Set<String>	getRequestProducts() Get products relevant to the CURRENT request, if present, else an empty set.
String	getServiceEntitlementNumber() Get the Service Entitlement Number (SEN) from billingDetails if available, else throw ClientException This is NOT available in migration requests, should never be null in provisioning requests.
ZoneId	getTimeZone() Get the timezone from cloud-provisioner details if available, else throw ClientException Unconfirmed whether this is available in migration requests; should never be null in provisioning requests.
boolean	hasJdbcInfo() Check for whether we've been given valid monarch JDBC connection details.
static String	removeEnd(String str, String remove) Removes a substring only if it is at the end of a source string, otherwise returns the source string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProvisionerApiRequest

public ProvisionerApiRequest(String jsonString)

Construct by parsing json from Cloud Provisioner

Parameters:

jsonString - raw json in Cloud Provisioner API format

Throws:

ClientException - for invalid values or missing mandatory fields

Method Detail

getCloudId

public String getCloudId()

The tenant ID, always present.

getCloudName

public String getCloudName()

Get the cloudName field if available, else throw ClientException.

Returns:

instance host name (non-null, non-empty)

Throws:

ClientException - if not set

getCloudNamespace

public String getCloudNamespace()

Get the cloudNamespace field if available, else throw ClientException.

Returns:

domain, e.g. "jira-dev.com" (non-null, non-empty)

Throws:

ClientException - if not set

getJdbcUrl

public String getJdbcUrl()

Get the JDBC URL from Monarch if available, else throw ClientException. This is NOT available in requests to Unicorn migration servlets, and could be null in abort workflows: see CONFDEV-48873

Returns:

JDBC URL (non-null, non-empty)

Throws:

ClientException - if not set

hasJdbcInfo

public boolean hasJdbcInfo()

Check for whether we've been given valid monarch JDBC connection details.

Returns:

true if the json had monarch JDBC connection details, false otherwise

getJdbcUser

public String getJdbcUser()

Get the JDBC database user from Monarch if available, else throw ClientException. This is NOT available in requests to Unicorn migration servlets, and could be null in abort workflows: see CONFDEV-48873

Returns:

JDBC database user (non-null, non-empty)

Throws:

ClientException - if not set

getJdbcPassword

public String getJdbcPassword()

Get the JDBC database password from Monarch if available, else throw ClientException. This is NOT available in requests to Unicorn migration servlets, and could be null in abort workflows: see CONFDEV-48873

Returns:

JDBC database password (non-null, non-empty)

Throws:

ClientException - if not set

getServiceEntitlementNumber

public String getServiceEntitlementNumber()

Get the Service Entitlement Number (SEN) from billingDetails if available, else throw ClientException This is NOT available in migration requests, should never be null in provisioning requests.

Returns:

Service Entitlement Number (non-null, non-empty)

Throws:

ClientException - if not set

getTimeZone

public ZoneId getTimeZone()

Get the timezone from cloud-provisioner details if available, else throw ClientException Unconfirmed whether this is available in migration requests; should never be null in provisioning requests.

Returns:

timezone (non-null)

Throws:

ClientException - if not set

getCallbackUrl

public String getCallbackUrl()

The callback URL at which the invoking service is listening for our final asynchronous response. Only present if the remote service is configured to use async for this endpoint.

getHeartbeatUrl

public String getHeartbeatUrl()

The heartbeat URL at which the invoking service is listening for our heartbeats during asynchronous processing. Only present if the remote service is configured to use async for this endpoint.

getLicensedProductKeys

public Set<String> getLicensedProductKeys()

Get license info from Purchasing in the provisioner request if available, else an empty set.

Returns:

licensedProductKeys from purchasing, may be empty for some requests; see https://extranet.atlassian.com/display/ENG/Cloud+Provisioner+-+Provider+API?focusedCommentId=2982254545#comment-2982254545

getRequestProducts

public Set<String> getRequestProducts()

Get products relevant to the CURRENT request, if present, else an empty set. Note that this differs from getLicensedProductKeys() in that getLicensedProductKeys will return ALL licensedProductKeys that the product has, not just those relevant to the current request.

Returns:

products that are relevant to the current request, may be empty for some requests; see https://extranet.atlassian.com/display/ENG/Cloud+Provisioner+-+Provider+API?focusedCommentId=2982254545#comment-2982254545

getProductLicenseInfo

public Map<String,String> getProductLicenseInfo()

Returns a mapping of all values within LICENSE_PRODUCTS_DATA flattened

getOfflineReason

public Optional<String> getOfflineReason()

Get the first reason a tenant is made offline. At this point we do not care about tie-breaking when there are multiple reasons, just pick the first one.

Returns:

first reason if a tenant is offline

See Also:

more

removeEnd

public static String removeEnd(String str,
                               String remove)

Removes a substring only if it is at the end of a source string, otherwise returns the source string.

Parameters:

str - the source String to search

remove - the String to search for and remove

Returns:

the substring with the string removed if found