Package liquibase.analytics.configuration

Class LiquibaseRemoteAnalyticsConfiguration

java.lang.Object

liquibase.analytics.configuration.LiquibaseRemoteAnalyticsConfiguration

All Implemented Interfaces:

AnalyticsConfiguration, Plugin

public class LiquibaseRemoteAnalyticsConfiguration
extends Object
implements AnalyticsConfiguration

LiquibaseRemoteAnalyticsConfiguration is responsible for fetching and providing remote analytics configurations used by Liquibase. This class uses a Cache to store the remote analytics configuration, which is loaded from a specified URL endpoint.

Field Summary

Fields inherited from interface liquibase.plugin.Plugin

PRIORITY_DATABASE, PRIORITY_DEFAULT, PRIORITY_NOT_APPLICABLE, PRIORITY_SPECIALIZED

Constructor Summary

Constructors

Constructor	Description
LiquibaseRemoteAnalyticsConfiguration()

Method Summary

Modifier and Type	Method	Description
String	getDestinationUrl()	Retrieves the destination URL for analytics from the remote configuration.
List<RemoteAnalyticsConfiguration.ExtensionName>	getExtensionNames()	Retrieves the list of extension names included in the remote configuration.
int	getPriority()
int	getTimeoutMillis()	Retrieves the timeout value in milliseconds from the remote configuration.
String	getWriteKey()	Retrieves the write key used for analytics reporting from the remote configuration.
boolean	isOssAnalyticsEnabled()	Determines if OSS analytics are enabled by reading the remote configuration.
boolean	isProAnalyticsEnabled()	Determines if Pro analytics are enabled by reading the remote configuration.

Methods inherited from class java.lang.Object

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

Constructor Details

LiquibaseRemoteAnalyticsConfiguration

public LiquibaseRemoteAnalyticsConfiguration()

Method Details

getPriority

public int getPriority()

Specified by:

getPriority in interface AnalyticsConfiguration

getTimeoutMillis

public int getTimeoutMillis()
                     throws Exception

Retrieves the timeout value in milliseconds from the remote configuration.

Returns:

the timeout in milliseconds

Throws:

Exception - if there is an issue fetching the configuration

getDestinationUrl

public String getDestinationUrl()
                         throws Exception

Retrieves the destination URL for analytics from the remote configuration.

Returns:

the destination URL as a String

Throws:

Exception - if there is an issue fetching the configuration

isOssAnalyticsEnabled

public boolean isOssAnalyticsEnabled()
                              throws Exception

Determines if OSS analytics are enabled by reading the remote configuration.

Specified by:

isOssAnalyticsEnabled in interface AnalyticsConfiguration

Returns:

true if OSS analytics are enabled, false otherwise

Throws:

Exception - if there is an issue fetching the configuration

isProAnalyticsEnabled

public boolean isProAnalyticsEnabled()
                              throws Exception

Determines if Pro analytics are enabled by reading the remote configuration.

Specified by:

isProAnalyticsEnabled in interface AnalyticsConfiguration

Returns:

true if Pro analytics are enabled, false otherwise

Throws:

Exception - if there is an issue fetching the configuration

getWriteKey

public String getWriteKey()
                   throws Exception

Retrieves the write key used for analytics reporting from the remote configuration.

Returns:

the write key as a String

Throws:

Exception - if there is an issue fetching the configuration

getExtensionNames

public List<RemoteAnalyticsConfiguration.ExtensionName> getExtensionNames()
                                                                   throws Exception

Retrieves the list of extension names included in the remote configuration.

Returns:

a list of extension names

Throws:

Exception - if there is an issue fetching the configuration