Package org.refcodes.rest.ext.eureka

Interface EurekaServerDescriptor

  • All Superinterfaces:
    org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty, AmazonMetaDataAccessor, AmazonMetaDataAccessor.AmazonMetaDataMutator, AmazonMetaDataAccessor.AmazonMetaDataProperty, org.refcodes.structure.CanonicalMap, org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap, org.refcodes.structure.Clearable, org.refcodes.structure.Containable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.structure.Dictionary<java.lang.String,java.lang.String>, org.refcodes.structure.Dictionary.MutableDictionary<java.lang.String,java.lang.String>, org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<java.lang.String,java.lang.String,org.refcodes.structure.PathMap.PathMapBuilder<java.lang.String>>, org.refcodes.mixin.Dumpable, EurekaDataCenterTypeAccessor, EurekaDataCenterTypeAccessor.EurekaDataCenterTypeMutator, EurekaDataCenterTypeAccessor.EurekaDataCenterTypeProperty, EurekaServiceStatusAccessor, EurekaServiceStatusAccessor.EurekaServiceStatusMutator, EurekaServiceStatusAccessor.EurekaServiceStatusProperty, org.refcodes.rest.HomeUrlAccessor, org.refcodes.rest.HomeUrlAccessor.HomeUrlMutator, org.refcodes.rest.HomeUrlAccessor.HomeUrlProperty, org.refcodes.net.HostAccessor, org.refcodes.net.HostAccessor.HostMutator, org.refcodes.net.HostAccessor.HostProperty, org.refcodes.net.HttpBodyMap, org.refcodes.rest.HttpServerDescriptor, org.refcodes.net.IpAddressAccessor, org.refcodes.net.IpAddressAccessor.IpAddressMutator, org.refcodes.net.IpAddressAccessor.IpAddressProperty, org.refcodes.structure.Keys<java.lang.String,java.lang.String>, org.refcodes.structure.Keys.MutableKeys<java.lang.String,java.lang.String>, org.refcodes.structure.Keys.MutableValues<java.lang.String,java.lang.String>, java.util.Map<java.lang.String,java.lang.String>, org.refcodes.structure.PathMap<java.lang.String>, org.refcodes.structure.PathMap.MutablePathMap<java.lang.String>, org.refcodes.structure.PathMap.PathMapBuilder<java.lang.String>, org.refcodes.rest.PingUrlAccessor, org.refcodes.rest.PingUrlAccessor.PingUrlMutator, org.refcodes.rest.PingUrlAccessor.PingUrlProperty, org.refcodes.mixin.PortAccessor, org.refcodes.mixin.PortAccessor.PortMutator, org.refcodes.mixin.PortAccessor.PortProperty, org.refcodes.structure.PropertiesAccessorMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin, org.refcodes.rest.StatusUrlAccessor, org.refcodes.rest.StatusUrlAccessor.StatusUrlMutator, org.refcodes.rest.StatusUrlAccessor.StatusUrlProperty, org.refcodes.mixin.TypeAccessor<java.lang.String>
    All Known Implementing Classes:
    EurekaServerDescriptorImpl
    public interface EurekaServerDescriptor
extends org.refcodes.rest.HttpServerDescriptor, org.refcodes.mixin.AliasAccessor.AliasProperty, org.refcodes.rest.PingUrlAccessor.PingUrlProperty, org.refcodes.rest.StatusUrlAccessor.StatusUrlProperty, org.refcodes.rest.HomeUrlAccessor.HomeUrlProperty, org.refcodes.net.HostAccessor.HostProperty, org.refcodes.net.IpAddressAccessor.IpAddressProperty, org.refcodes.mixin.PortAccessor.PortProperty, org.refcodes.net.HttpBodyMap, EurekaDataCenterTypeAccessor.EurekaDataCenterTypeProperty, EurekaServiceStatusAccessor.EurekaServiceStatusProperty, AmazonMetaDataAccessor.AmazonMetaDataProperty
    The EurekaServerDescriptor refines the HttpServerDescriptor for use with an Eureka Service-Registry.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor

        org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

      • Nested classes/interfaces inherited from interface org.refcodes.structure.CanonicalMap

        org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor

        org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

      • Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary

        org.refcodes.structure.Dictionary.MutableDictionary<K extends java.lang.Object,V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary.MutableDictionary

        org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K extends java.lang.Object,V extends java.lang.Object,B extends org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

      • Nested classes/interfaces inherited from interface org.refcodes.rest.HomeUrlAccessor

        org.refcodes.rest.HomeUrlAccessor.HomeUrlBuilder<B extends org.refcodes.rest.HomeUrlAccessor.HomeUrlBuilder<?>>, org.refcodes.rest.HomeUrlAccessor.HomeUrlMutator, org.refcodes.rest.HomeUrlAccessor.HomeUrlProperty

      • Nested classes/interfaces inherited from interface org.refcodes.net.HostAccessor

        org.refcodes.net.HostAccessor.HostBuilder<B extends org.refcodes.net.HostAccessor.HostBuilder<?>>, org.refcodes.net.HostAccessor.HostMutator, org.refcodes.net.HostAccessor.HostProperty

      • Nested classes/interfaces inherited from interface org.refcodes.rest.HttpServerDescriptor

        org.refcodes.rest.HttpServerDescriptor.HttpServerDescriptorBuilder<B extends org.refcodes.rest.HttpServerDescriptor.HttpServerDescriptorBuilder<B>>

      • Nested classes/interfaces inherited from interface org.refcodes.net.IpAddressAccessor

        org.refcodes.net.IpAddressAccessor.IpAddressBuilder<B extends org.refcodes.net.IpAddressAccessor.IpAddressBuilder<B>>, org.refcodes.net.IpAddressAccessor.IpAddressMutator, org.refcodes.net.IpAddressAccessor.IpAddressProperty

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface org.refcodes.structure.PathMap

        org.refcodes.structure.PathMap.MutablePathMap<T extends java.lang.Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends java.lang.Object>

      • Nested classes/interfaces inherited from interface org.refcodes.rest.PingUrlAccessor

        org.refcodes.rest.PingUrlAccessor.PingUrlBuilder<B extends org.refcodes.rest.PingUrlAccessor.PingUrlBuilder<?>>, org.refcodes.rest.PingUrlAccessor.PingUrlMutator, org.refcodes.rest.PingUrlAccessor.PingUrlProperty

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.PortAccessor

        org.refcodes.mixin.PortAccessor.PortBuilder<B extends org.refcodes.mixin.PortAccessor.PortBuilder<B>>, org.refcodes.mixin.PortAccessor.PortMutator, org.refcodes.mixin.PortAccessor.PortProperty

      • Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin

        org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends java.lang.Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

      • Nested classes/interfaces inherited from interface org.refcodes.rest.StatusUrlAccessor

        org.refcodes.rest.StatusUrlAccessor.StatusUrlBuilder<B extends org.refcodes.rest.StatusUrlAccessor.StatusUrlBuilder<?>>, org.refcodes.rest.StatusUrlAccessor.StatusUrlMutator, org.refcodes.rest.StatusUrlAccessor.StatusUrlProperty

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

        org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>

    • Field Summary

      • Fields inherited from interface org.refcodes.structure.CanonicalMap

        DEFAULT_COMMENT

      • Fields inherited from interface org.refcodes.net.HttpBodyMap

        STATUS_ALIAS_PATH, STATUS_CODE_PATH, STATUS_EXCEPTION_PATH, STATUS_MESSAGE_PATH, STATUS_TIMESTAMP_PATH

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default java.lang.String getAlias()
      default AmazonMetaData getAmazonMetaData()
      Retrieves the Amazon Meta-Data from the Amazon Meta-Data property.
      default EurekaDataCenterType getEurekaDataCenterType()
      Retrieves the Eureka data center type from the Eureka data center type property.
      default EurekaServiceStatus getEurekaServiceStatus()
      Retrieves the Eureka service status from the Eureka service status property.
      default org.refcodes.net.Url getHomeUrl()
      default java.lang.String getHost()
      default int[] getIpAddress()
      default java.lang.Integer getLeaseEvictionDurationInSecs()
      Returns the length of lease - default if 90 seconds.
      default java.util.Map<java.lang.String,java.lang.String> getMetaData()
      Retrieves the application's Meta-Data.
      default org.refcodes.net.Url getPingUrl()
      default int getPort()
      default org.refcodes.net.Url getStatusUrl()
      default java.lang.String getVirtualHost()
      Retrieves the virtual host as of Eureka(?).
      default java.lang.String putMetaData​(java.lang.String aKey, java.lang.String aValue)
      Adds a key-value pair to the application's Meta-Data.
      default void setAlias​(java.lang.String aAlias)
      default void setAmazonMetaData​(AmazonMetaData aDataCenterType)
      Sets the Amazon Meta-Data for the Amazon Meta-Data property.
      default void setEurekaDataCenterType​(EurekaDataCenterType aDataCenterType)
      Sets the Eureka data center type for the Eureka data center type property.
      default void setEurekaServiceStatus​(EurekaServiceStatus aServiceStatus)
      Sets the Eureka service status for the Eureka service status property.
      default void setHomeUrl​(org.refcodes.net.Url aUrl)
      default void setHost​(java.lang.String aHost)
      default void setIpAddress​(int[] aIpAddress)
      default void setLeaseEvictionDurationInSecs​(java.lang.Integer aLeaseEvictionDurationInSecs)
      Optional, if you want to change the length of lease - default if 90 seconds.
      default void setMetaData​(java.util.Map<java.lang.String,java.lang.String> aMetaData)
      Sets the application's Meta-Data.
      default void setPingUrl​(org.refcodes.net.Url aUrl)
      default void setPort​(int aPort)
      default void setStatusUrl​(org.refcodes.net.Url aUrl)
      default void setVirtualHost​(java.lang.String aVirtualHost)
      Sets the virtual host as of Eureka(?).

      • Methods inherited from interface org.refcodes.structure.CanonicalMap

        toInstance, toInstance, toType, toType

      • Methods inherited from interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

        withInsert, withInsert, withInsertFrom, withInsertTo, withPutBoolean, withPutByte, withPutDouble, withPutFloat, withPutInteger, withPutLong, withPutShort, withRemoveFrom

      • Methods inherited from interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

        containsValue, insert, insert, insertFrom, insertTo, put, putAll, putAll, putAll, toDump, toSourceCode, toSourceCode

      • Methods inherited from interface org.refcodes.structure.Containable

        isEmpty, size

      • Methods inherited from interface org.refcodes.mixin.DelimiterAccessor

        getDelimiter

      • Methods inherited from interface org.refcodes.mixin.Dumpable

        toDump

      • Methods inherited from interface org.refcodes.net.HttpBodyMap

        childrenOf, delete, getStatusAlias, getStatusCode, getStatusException, getStatusMessage, getStatusTimeStamp, hasStatusAlias, hasStatusCode, hasStatusException, hasStatusMessage, hasStatusTimeStamp, putStatusAlias, putStatusAlias, putStatusCode, putStatusCode, putStatusException, putStatusException, putStatusMessage, putStatusTimeStamp, putStatusTimeStamp, retrieve, retrieveFrom, retrieveTo, withInsert, withInsert, withInsertFrom, withInsertTo, withPut, withPut, withPutStatusAlias, withPutStatusAlias, withPutStatusCode, withPutStatusCode

      • Methods inherited from interface org.refcodes.net.IpAddressAccessor

        toCidrNotation

      • Methods inherited from interface org.refcodes.net.IpAddressAccessor.IpAddressMutator

        fromCidrNotation

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

      • Methods inherited from interface org.refcodes.structure.PathMap

        directories, directories, entries, entries, fromExternalKey, getArray, getArray, getRootPath, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath

      • Methods inherited from interface org.refcodes.structure.PathMap.MutablePathMap

        insert, insert, insert, insert, insertFrom, insertFrom, insertTo, insertTo, put, putArray, putArray, removeAll

      • Methods inherited from interface org.refcodes.structure.PathMap.PathMapBuilder

        withInsert, withInsert, withInsertFrom, withInsertTo

      • Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

        containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort

      • Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin

        withPut

      • Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

        put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort

      • Methods inherited from interface org.refcodes.mixin.TypeAccessor

        getType

    • Method Detail

      • getLeaseEvictionDurationInSecs

        default java.lang.Integer getLeaseEvictionDurationInSecs()
        Returns the length of lease - default if 90 seconds.
        Returns:
        The lease eviction duration in seconds.

      • setLeaseEvictionDurationInSecs

        default void setLeaseEvictionDurationInSecs​(java.lang.Integer aLeaseEvictionDurationInSecs)
        Optional, if you want to change the length of lease - default if 90 seconds.
        Parameters:
        aLeaseEvictionDurationInSecs - The lease eviction duration in seconds.

      • getAlias

        default java.lang.String getAlias()
        Specified by:
        getAlias in interface org.refcodes.mixin.AliasAccessor

      • setAlias

        default void setAlias​(java.lang.String aAlias)
        Specified by:
        setAlias in interface org.refcodes.mixin.AliasAccessor.AliasMutator

      • getPingUrl

        default org.refcodes.net.Url getPingUrl()
        Specified by:
        getPingUrl in interface org.refcodes.rest.PingUrlAccessor

      • setPingUrl

        default void setPingUrl​(org.refcodes.net.Url aUrl)
        Specified by:
        setPingUrl in interface org.refcodes.rest.PingUrlAccessor.PingUrlMutator

      • getStatusUrl

        default org.refcodes.net.Url getStatusUrl()
        Specified by:
        getStatusUrl in interface org.refcodes.rest.StatusUrlAccessor

      • setStatusUrl

        default void setStatusUrl​(org.refcodes.net.Url aUrl)
        Specified by:
        setStatusUrl in interface org.refcodes.rest.StatusUrlAccessor.StatusUrlMutator

      • getHomeUrl

        default org.refcodes.net.Url getHomeUrl()
        Specified by:
        getHomeUrl in interface org.refcodes.rest.HomeUrlAccessor

      • setHomeUrl

        default void setHomeUrl​(org.refcodes.net.Url aUrl)
        Specified by:
        setHomeUrl in interface org.refcodes.rest.HomeUrlAccessor.HomeUrlMutator

      • getHost

        default java.lang.String getHost()
        Specified by:
        getHost in interface org.refcodes.net.HostAccessor

      • setHost

        default void setHost​(java.lang.String aHost)
        Specified by:
        setHost in interface org.refcodes.net.HostAccessor.HostMutator

      • getPort

        default int getPort()
        Specified by:
        getPort in interface org.refcodes.mixin.PortAccessor

      • setPort

        default void setPort​(int aPort)
        Specified by:
        setPort in interface org.refcodes.mixin.PortAccessor.PortMutator

      • getIpAddress

        default int[] getIpAddress()
        Specified by:
        getIpAddress in interface org.refcodes.net.IpAddressAccessor

      • setIpAddress

        default void setIpAddress​(int[] aIpAddress)
        Specified by:
        setIpAddress in interface org.refcodes.net.IpAddressAccessor.IpAddressMutator

      • getVirtualHost

        default java.lang.String getVirtualHost()
        Retrieves the virtual host as of Eureka(?).
        Returns:
        The virtual host.

      • setVirtualHost

        default void setVirtualHost​(java.lang.String aVirtualHost)
        Sets the virtual host as of Eureka(?).
        Parameters:
        aVirtualHost - The virtual host.

      • getAmazonMetaData

        default AmazonMetaData getAmazonMetaData()
        Retrieves the Amazon Meta-Data from the Amazon Meta-Data property.
        Specified by:
        getAmazonMetaData in interface AmazonMetaDataAccessor
        Returns:
        The Amazon Meta-Data stored by the Amazon Meta-Data property.

      • getMetaData

        default java.util.Map<java.lang.String,java.lang.String> getMetaData()
        Retrieves the application's Meta-Data.
        Returns:
        The Map representing the applications's Meta-Data.

      • setMetaData

        default void setMetaData​(java.util.Map<java.lang.String,java.lang.String> aMetaData)
        Sets the application's Meta-Data.
        Parameters:
        aMetaData - The Map representing the applications's Meta-Data.

      • putMetaData

        default java.lang.String putMetaData​(java.lang.String aKey,
                                     java.lang.String aValue)
        Adds a key-value pair to the application's Meta-Data.
        Parameters:
        aKey - The Key of the Meta-Data entry.
        aValue - The value for the Meta-Data entry.
        Returns:
        The previously set value for the given Meta-Data entry or null if none was set before.