Package org.axonframework.updates.api

Class UpdateCheckRequest

java.lang.Object

org.axonframework.updates.api.UpdateCheckRequest

public class UpdateCheckRequest
extends Object

Represents an UpdateChecker request, including machine and instance identifiers, operating system details, JVM information, Kotlin version, and a list of library versions.

Since:

4.12.0

Author:

Mitchell Herrijgers

Constructor Summary

Constructors

Constructor	Description
UpdateCheckRequest(String machineId, String instanceId, String osName, String osVersion, String osArch, String jvmVersion, String jvmVendor, String kotlinVersion, List<Artifact> libraries)	Constructs an UpdateCheckRequest with the given machineId, instanceId, osName, osVersion, osArch, jvmVersion, jvmVendor, kotlinVersion, and libraries.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String	instanceId()	Returns the instance identifier of this update check request.
String	jvmVendor()	Returns the JVM vendor of this update check request.
String	jvmVersion()	Returns the JVM version of this update check request.
String	kotlinVersion()	Returns the kotlin version of this update check request.
List<Artifact>	libraries()	Returns the collection of libraries of this update check request.
String	machineId()	Returns the machine identifier of this update check request.
String	osArch()	Returns the operating system architecture of this update check request.
String	osName()	Returns the operating system name of this update check request.
String	osVersion()	Returns the operating system version of this update check request.
String	toQueryString()	Converts the usage request into a query string format suitable for HTTP requests.
String	toString()
String	toUserAgent()	Converts the usage request into a user agent string format.

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateCheckRequest

public UpdateCheckRequest(String machineId,
 String instanceId,
 String osName,
 String osVersion,
 String osArch,
 String jvmVersion,
 String jvmVendor,
 String kotlinVersion,
 List<Artifact> libraries)

Constructs an UpdateCheckRequest with the given machineId, instanceId, osName, osVersion, osArch, jvmVersion, jvmVendor, kotlinVersion, and libraries.

Parameters:

machineId - The unique identifier for the machine. This is a UUID that is generated and stored in the user's home directory.

instanceId - The unique identifier for the instance of the application. This is a UUID that is generated for each JVM instance.

osName - The name of the operating system (e.g., "Linux", "Windows").

osVersion - The version of the operating system (e.g., "6.11.0-26-generic").

osArch - The architecture of the operating system (e.g., "amd64", "x86_64").

jvmVersion - The version of the Java Virtual Machine (JVM) (e.g., "17.0.2").

jvmVendor - The vendor of the JVM (e.g., "AdoptOpenJDK", "Oracle").

kotlinVersion - The version of Kotlin used in the application, or "none" if Kotlin is not used.

libraries - A list of library versions used in the application, each represented by a Artifact object containing the group ID, artifact ID, and version of the library.

Method Details

machineId

public String machineId()

Returns the machine identifier of this update check request.

Returns:

The machine identifier of this update check request.

instanceId

public String instanceId()

Returns the instance identifier of this update check request.

Returns:

The instance identifier of this update check request.

osName

public String osName()

Returns the operating system name of this update check request.

Returns:

The operating system name of this update check request.

osVersion

public String osVersion()

Returns the operating system version of this update check request.

Returns:

The operating system version of this update check request.

osArch

public String osArch()

Returns the operating system architecture of this update check request.

Returns:

The operating system architecture of this update check request.

jvmVersion

public String jvmVersion()

Returns the JVM version of this update check request.

Returns:

The JVM version of this update check request.

jvmVendor

public String jvmVendor()

Returns the JVM vendor of this update check request.

Returns:

The JVM vendor of this update check request.

kotlinVersion

public String kotlinVersion()

Returns the kotlin version of this update check request.

Returns:

The kotlin version of this update check request.

libraries

public List<Artifact> libraries()

Returns the collection of libraries of this update check request.

Returns:

The collection of libraries of this update check request.

toQueryString

public String toQueryString()

Converts the usage request into a query string format suitable for HTTP requests. All values are properly URL encoded.

Returns:

The query string representation of the usage request.

toUserAgent

public String toUserAgent()

Converts the usage request into a user agent string format.

Returns:

The user agent string representation of the usage request.

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