Package io.micronaut.discovery.eureka.client.v2

Class InstanceInfo

java.lang.Object

io.micronaut.discovery.eureka.client.v2.InstanceInfo

All Implemented Interfaces:

ConfigurableInstanceInfo

public class InstanceInfo
extends Object
implements ConfigurableInstanceInfo

Represents an application instance in Eureka. See https://github.com/Netflix/eureka/wiki/Eureka-REST-operations.

Based on https://github.com/Netflix/eureka/blob/master/eureka-client/src/main/java/com/netflix/appinfo/InstanceInfo.java

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InstanceInfo.Status	The instance status according to Eureka.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_COUNTRY_ID	US by default.
static final int	DEFAULT_PORT	Eureka default port.
static final int	DEFAULT_SECURE_PORT	Secure port disabled by default.

Constructor Summary

Constructors

Constructor	Description
InstanceInfo(String host, int port, @NotBlank String appName, @NotBlank String instanceId)	Creates an InstanceInfo.
InstanceInfo(String host, int port, String ipAddress, String appName, String instanceId)	Creates an InstanceInfo.
InstanceInfo(String host, @NotBlank String appName)	Creates an InstanceInfo.
InstanceInfo(String host, @NotBlank String appName, @NotBlank String instanceId)	Creates an InstanceInfo.

Method Summary

Modifier and Type	Method	Description
@NotBlank String	getApp()	The application name.
String	getAppGroupName()	The application group name.
String	getAsgName()
@jakarta.validation.constraints.Min(1L) int	getCountryId()	The country id.
@NotNull DataCenterInfo	getDataCenterInfo()	The DataCenterInfo instance.
String	getHealthCheckUrl()
String	getHomePageUrl()
@NotBlank String	getHostName()	The host name of the application instance.
String	getId()	Returns the unique id of the instance.
@NotBlank String	getInstanceId()	The instance id.
@NotBlank String	getIpAddr()	The IP address of the instance.
LeaseInfo	getLeaseInfo()	The LeaseInfo instance.
Map<String,String>	getMetadata()
int	getPort()	The port of the application instance.
io.micronaut.discovery.eureka.client.v2.InstanceInfo.PortWrapper	getPortWrapper()
String	getSecureHealthCheckUrl()
int	getSecurePort()	The secure port of the application instance.
io.micronaut.discovery.eureka.client.v2.InstanceInfo.PortWrapper	getSecurePortWrapper()
@NotBlank String	getSecureVipAddress()
@NotNull InstanceInfo.Status	getStatus()
String	getStatusPageUrl()
@NotBlank String	getVipAddress()
void	setAppGroupName(String appGroupName)	Sets the application group name.
void	setAsgName(String asgName)	Sets the Amazon auto scaling group name to use.
void	setCountryId(int countryId)	Sets the country id.
void	setDataCenterInfo(DataCenterInfo dataCenterInfo)	Sets the DataCenterInfo.
void	setHealthCheckUrl(String healthCheckUrl)	Sets the health check URL.
void	setHomePageUrl(String homePageUrl)	Sets the home page URL.
void	setInstanceId(String instanceId)	Sets the instance ID.
void	setIpAddr(String ipAddr)	Sets the IP address of the instance.
void	setLeaseInfo(LeaseInfo leaseInfo)	Sets the LeaseInfo.
void	setMetadata(Map<String,String> metadata)
void	setPort(int port)	Sets the port of the application instance.
void	setSecureHealthCheckUrl(String secureHealthCheckUrl)	Sets the secure health check URL.
void	setSecurePort(int securePort)	Sets the secure port of the application instance.
void	setSecureVipAddress(String secureVipAddress)	Sets the Secure Virtual Host Address.
void	setStatus(InstanceInfo.Status status)	Sets the application status.
void	setStatusPageUrl(String statusPageUrl)	Sets the status page URL.
void	setVipAddress(String vipAddress)	Sets the Virtual Host Address.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PORT

public static final int DEFAULT_PORT

Eureka default port.

See Also:

• Constant Field Values

DEFAULT_SECURE_PORT

public static final int DEFAULT_SECURE_PORT

Secure port disabled by default.

See Also:

• Constant Field Values

DEFAULT_COUNTRY_ID

public static final int DEFAULT_COUNTRY_ID

US by default.

See Also:

• Constant Field Values

Constructor Details

InstanceInfo

public InstanceInfo(String host,
 @NotBlank
 @NotBlank String appName,
 @NotBlank
 @NotBlank String instanceId)

Creates an InstanceInfo.

Parameters:

host - The host name

appName - The application name

instanceId - The instance identifier

InstanceInfo

public InstanceInfo(String host,
 @NotBlank
 @NotBlank String appName)

Creates an InstanceInfo. The getInstanceId() will default to the value of the host

Parameters:

host - The host name

appName - The application name

InstanceInfo

public InstanceInfo(String host,
 int port,
 @NotBlank
 @NotBlank String appName,
 @NotBlank
 @NotBlank String instanceId)

Creates an InstanceInfo. This constructor will perform an IP Address lookup based on the host name

Parameters:

host - The host name

port - The port

appName - The application name

instanceId - The instance identifier

InstanceInfo

public InstanceInfo(String host,
 int port,
 String ipAddress,
 String appName,
 String instanceId)

Creates an InstanceInfo.

Parameters:

host - The host name

port - The port

ipAddress - The IP address

appName - The application name

instanceId - The instance identifier

Method Details

toString

public String toString()

Overrides:

toString in class Object

getHostName

@NotBlank
public @NotBlank String getHostName()

The host name of the application instance.

Specified by:

getHostName in interface ConfigurableInstanceInfo

Returns:

The hostname

getId

public String getId()

Returns the unique id of the instance. (Note) now that id is set at creation time within the instanceProvider, why do the other checks? This is still necessary for backwards compatibility when upgrading in a deployment with multiple client versions (some with the change, some without).

Specified by:

getId in interface ConfigurableInstanceInfo

Returns:

the unique id.

getPort

public int getPort()

The port of the application instance.

Specified by:

getPort in interface ConfigurableInstanceInfo

Returns:

The port

getSecurePort

public int getSecurePort()

The secure port of the application instance.

Specified by:

getSecurePort in interface ConfigurableInstanceInfo

Returns:

The secure port

getPortWrapper

public io.micronaut.discovery.eureka.client.v2.InstanceInfo.PortWrapper getPortWrapper()

Returns:

The port

getSecurePortWrapper

public io.micronaut.discovery.eureka.client.v2.InstanceInfo.PortWrapper getSecurePortWrapper()

Returns:

The secure port

setSecurePort

public void setSecurePort(int securePort)

Description copied from interface: ConfigurableInstanceInfo

Sets the secure port of the application instance.

Specified by:

setSecurePort in interface ConfigurableInstanceInfo

Parameters:

securePort - The secure port of the application instance

setPort

public void setPort(int port)

Description copied from interface: ConfigurableInstanceInfo

Sets the port of the application instance.

Specified by:

setPort in interface ConfigurableInstanceInfo

Parameters:

port - The port of the application instance

getApp

@NotBlank
public @NotBlank String getApp()

The application name.

Specified by:

getApp in interface ConfigurableInstanceInfo

Returns:

The application name

getAppGroupName

public String getAppGroupName()

The application group name.

Specified by:

getAppGroupName in interface ConfigurableInstanceInfo

Returns:

The application group name

getInstanceId

@NotBlank
public @NotBlank String getInstanceId()

The instance id.

Specified by:

getInstanceId in interface ConfigurableInstanceInfo

Returns:

The instance id

getCountryId

@Min(1L)
public @jakarta.validation.constraints.Min(1L) int getCountryId()

The country id.

Specified by:

getCountryId in interface ConfigurableInstanceInfo

Returns:

The country id

getIpAddr

@NotBlank
public @NotBlank String getIpAddr()

The IP address of the instance.

Specified by:

getIpAddr in interface ConfigurableInstanceInfo

Returns:

The IP address

getStatus

@NotNull
public @NotNull InstanceInfo.Status getStatus()

Specified by:

getStatus in interface ConfigurableInstanceInfo

Returns:

The application status

getDataCenterInfo

@NotNull
public @NotNull DataCenterInfo getDataCenterInfo()

The DataCenterInfo instance.

Specified by:

getDataCenterInfo in interface ConfigurableInstanceInfo

Returns:

The data center info

getLeaseInfo

public LeaseInfo getLeaseInfo()

The LeaseInfo instance.

Specified by:

getLeaseInfo in interface ConfigurableInstanceInfo

Returns:

The lease info

getMetadata

public Map<String,String> getMetadata()

Specified by:

getMetadata in interface ConfigurableInstanceInfo

Returns:

The instance metadata.

getStatusPageUrl

public String getStatusPageUrl()

Specified by:

getStatusPageUrl in interface ConfigurableInstanceInfo

Returns:

The status page URL

getHomePageUrl

public String getHomePageUrl()

Specified by:

getHomePageUrl in interface ConfigurableInstanceInfo

Returns:

The home page URL

getHealthCheckUrl

public String getHealthCheckUrl()

Specified by:

getHealthCheckUrl in interface ConfigurableInstanceInfo

Returns:

The health check URL

getVipAddress

@NotBlank
public @NotBlank String getVipAddress()

Specified by:

getVipAddress in interface ConfigurableInstanceInfo

Returns:

The Virtual Host Address for this instance (defaults to the app name)

getSecureVipAddress

@NotBlank
public @NotBlank String getSecureVipAddress()

Specified by:

getSecureVipAddress in interface ConfigurableInstanceInfo

Returns:

The Secure Virtual Host Address for this instance (defaults to the app name)

getSecureHealthCheckUrl

public String getSecureHealthCheckUrl()

Specified by:

getSecureHealthCheckUrl in interface ConfigurableInstanceInfo

Returns:

The secure health check URL

getAsgName

public String getAsgName()

Specified by:

getAsgName in interface ConfigurableInstanceInfo

Returns:

The amazon auto scaling group name

setInstanceId

public void setInstanceId(String instanceId)

Sets the instance ID.

Specified by:

setInstanceId in interface ConfigurableInstanceInfo

Parameters:

instanceId - The instance ID

setAsgName

public void setAsgName(String asgName)

Description copied from interface: ConfigurableInstanceInfo

Sets the Amazon auto scaling group name to use.

Specified by:

setAsgName in interface ConfigurableInstanceInfo

Parameters:

asgName - The Amazon auto scaling group name to use

setHomePageUrl

public void setHomePageUrl(String homePageUrl)

Description copied from interface: ConfigurableInstanceInfo

Sets the home page URL.

Specified by:

setHomePageUrl in interface ConfigurableInstanceInfo

Parameters:

homePageUrl - The home page URL

setLeaseInfo

public void setLeaseInfo(LeaseInfo leaseInfo)

Description copied from interface: ConfigurableInstanceInfo

Sets the LeaseInfo.

Specified by:

setLeaseInfo in interface ConfigurableInstanceInfo

Parameters:

leaseInfo - The LeaseInfo

setCountryId

public void setCountryId(int countryId)

Description copied from interface: ConfigurableInstanceInfo

Sets the country id.

Specified by:

setCountryId in interface ConfigurableInstanceInfo

Parameters:

countryId - The country id

setStatusPageUrl

public void setStatusPageUrl(String statusPageUrl)

Description copied from interface: ConfigurableInstanceInfo

Sets the status page URL.

Specified by:

setStatusPageUrl in interface ConfigurableInstanceInfo

Parameters:

statusPageUrl - The status page URL

setHealthCheckUrl

public void setHealthCheckUrl(String healthCheckUrl)

Description copied from interface: ConfigurableInstanceInfo

Sets the health check URL.

Specified by:

setHealthCheckUrl in interface ConfigurableInstanceInfo

Parameters:

healthCheckUrl - The health check URL

setSecureHealthCheckUrl

public void setSecureHealthCheckUrl(String secureHealthCheckUrl)

Description copied from interface: ConfigurableInstanceInfo

Sets the secure health check URL.

Specified by:

setSecureHealthCheckUrl in interface ConfigurableInstanceInfo

Parameters:

secureHealthCheckUrl - The secure health check URL

setDataCenterInfo

public void setDataCenterInfo(DataCenterInfo dataCenterInfo)

Description copied from interface: ConfigurableInstanceInfo

Sets the DataCenterInfo.

Specified by:

setDataCenterInfo in interface ConfigurableInstanceInfo

Parameters:

dataCenterInfo - The DataCenterInfo

setStatus

public void setStatus(InstanceInfo.Status status)

Description copied from interface: ConfigurableInstanceInfo

Sets the application status.

Specified by:

setStatus in interface ConfigurableInstanceInfo

Parameters:

status - The application status

setAppGroupName

public void setAppGroupName(String appGroupName)

Description copied from interface: ConfigurableInstanceInfo

Sets the application group name.

Specified by:

setAppGroupName in interface ConfigurableInstanceInfo

Parameters:

appGroupName - The application group name

setIpAddr

public void setIpAddr(String ipAddr)

Description copied from interface: ConfigurableInstanceInfo

Sets the IP address of the instance.

Specified by:

setIpAddr in interface ConfigurableInstanceInfo

Parameters:

ipAddr - The IP address of the instance

setVipAddress

public void setVipAddress(String vipAddress)

Description copied from interface: ConfigurableInstanceInfo

Sets the Virtual Host Address.

Specified by:

setVipAddress in interface ConfigurableInstanceInfo

Parameters:

vipAddress - The Virtual Host Address

setSecureVipAddress

public void setSecureVipAddress(String secureVipAddress)

Description copied from interface: ConfigurableInstanceInfo

Sets the Secure Virtual Host Address.

Specified by:

setSecureVipAddress in interface ConfigurableInstanceInfo

Parameters:

secureVipAddress - The Secure Virtual Host Address

setMetadata

public void setMetadata(Map<String,String> metadata)

Parameters:

metadata - Sets the application metadata