com.netflix.appinfo

Class ApplicationInfoManager

java.lang.Object

com.netflix.appinfo.ApplicationInfoManager

@Singleton
public class ApplicationInfoManager
extends java.lang.Object

The class that initializes information required for registration with Eureka Server and to be discovered by other components.

The information required for registration is provided by the user by passing the configuration defined by the contract in EurekaInstanceConfig }.AWS clients can either use or extend CloudInstanceConfig. Other non-AWS clients can use or extend either MyDataCenterInstanceConfig or very basic AbstractInstanceConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ApplicationInfoManager.InstanceStatusMapper
static class	ApplicationInfoManager.OptionalArgs
static interface	ApplicationInfoManager.StatusChangeListener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,ApplicationInfoManager.StatusChangeListener>	listeners

Constructor Summary

Constructors

Constructor and Description
ApplicationInfoManager(EurekaInstanceConfig config) Deprecated. 2016-09-19 prefer ApplicationInfoManager(EurekaInstanceConfig, com.netflix.appinfo.ApplicationInfoManager.OptionalArgs)
ApplicationInfoManager(EurekaInstanceConfig config, ApplicationInfoManager.OptionalArgs optionalArgs)
ApplicationInfoManager(EurekaInstanceConfig config, InstanceInfo instanceInfo)
ApplicationInfoManager(EurekaInstanceConfig config, InstanceInfo instanceInfo, ApplicationInfoManager.OptionalArgs optionalArgs) public for DI use.

Method Summary

Modifier and Type	Method and Description
EurekaInstanceConfig	getEurekaInstanceConfig()
InstanceInfo	getInfo() Gets the information about this instance that is registered with eureka.
static ApplicationInfoManager	getInstance() Deprecated. please use DI instead
void	initComponent(EurekaInstanceConfig config)
void	refreshDataCenterInfoIfRequired() Refetches the hostname to check if it has changed.
void	refreshLeaseInfoIfRequired()
void	registerAppMetadata(java.util.Map<java.lang.String,java.lang.String> appMetadata) Register user-specific instance meta data.
void	registerStatusChangeListener(ApplicationInfoManager.StatusChangeListener listener)
void	setInstanceStatus(InstanceInfo.InstanceStatus status) Set the status of this instance.
void	unregisterStatusChangeListener(java.lang.String listenerId)

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected final java.util.Map<java.lang.String,ApplicationInfoManager.StatusChangeListener> listeners

Constructor Detail

ApplicationInfoManager

@Inject
public ApplicationInfoManager(EurekaInstanceConfig config,
                                      InstanceInfo instanceInfo,
                                      ApplicationInfoManager.OptionalArgs optionalArgs)

public for DI use. This class should be in singleton scope so do not create explicitly. Either use DI or create this explicitly using one of the other public constructors.

ApplicationInfoManager

public ApplicationInfoManager(EurekaInstanceConfig config,
                              ApplicationInfoManager.OptionalArgs optionalArgs)

ApplicationInfoManager

public ApplicationInfoManager(EurekaInstanceConfig config,
                              InstanceInfo instanceInfo)

ApplicationInfoManager

@Deprecated
public ApplicationInfoManager(EurekaInstanceConfig config)

Deprecated. 2016-09-19 prefer ApplicationInfoManager(EurekaInstanceConfig, com.netflix.appinfo.ApplicationInfoManager.OptionalArgs)

Method Detail

getInstance

@Deprecated
public static ApplicationInfoManager getInstance()

Deprecated. please use DI instead

initComponent

public void initComponent(EurekaInstanceConfig config)

getInfo

public InstanceInfo getInfo()

Gets the information about this instance that is registered with eureka.

Returns:

information about this instance that is registered with eureka.

getEurekaInstanceConfig

public EurekaInstanceConfig getEurekaInstanceConfig()

registerAppMetadata

public void registerAppMetadata(java.util.Map<java.lang.String,java.lang.String> appMetadata)

Register user-specific instance meta data. Application can send any other additional meta data that need to be accessed for other reasons.The data will be periodically sent to the eureka server. Please Note that metadata added via this method is not guaranteed to be submitted to the eureka servers upon initial registration, and may be submitted as an update at a subsequent time. If you want guaranteed metadata for initial registration, please use the mechanism described in EurekaInstanceConfig.getMetadataMap()

Parameters:

appMetadata - application specific meta data.

setInstanceStatus

public void setInstanceStatus(InstanceInfo.InstanceStatus status)

Set the status of this instance. Application can use this to indicate whether it is ready to receive traffic. Setting the status here also notifies all registered listeners of a status change event.

Parameters:

status - Status of the instance

registerStatusChangeListener

public void registerStatusChangeListener(ApplicationInfoManager.StatusChangeListener listener)

unregisterStatusChangeListener

public void unregisterStatusChangeListener(java.lang.String listenerId)

refreshDataCenterInfoIfRequired

public void refreshDataCenterInfoIfRequired()

Refetches the hostname to check if it has changed. If it has, the entire DataCenterInfo is refetched and passed on to the eureka server on next heartbeat. see InstanceInfo.getHostName() for explanation on why the hostname is used as the default address

refreshLeaseInfoIfRequired

public void refreshLeaseInfoIfRequired()