Package com.netflix.zuul.netty.server

Class SocketAddressProperty

java.lang.Object
com.netflix.config.PropertyWrapper<T>
com.netflix.config.StringDerivedProperty<SocketAddress>
com.netflix.zuul.netty.server.SocketAddressProperty
All Implemented Interfaces:
com.netflix.config.Property<SocketAddress>
public final class SocketAddressProperty extends com.netflix.config.StringDerivedProperty<SocketAddress>
This class expresses an address that Zuul can bind to. Similar to DynamicStringMapProperty this class uses a similar key=value syntax, but only supports a single pair.

To use this class, set a bind type such as SocketAddressProperty.BindType.ANY and assign it a port number like 7001. Sample usage:

  • =7001 - equivalent to ANY=7001
  • ANY=7001 Binds on all IP addresses and IP stack for port 7001
  • IPV4_ANY=7001 Binds on all IPv4 address 0.0.0.0 for port 7001
  • IPV6_ANY=7001 Binds on all IPv6 address :: for port 7001
  • ANY_LOCAL=7001 Binds on localhost for all IP stacks for port 7001
  • IPV4_LOCAL=7001 Binds on IPv4 localhost (127.0.0.1) for port 7001
  • IPV6_LOCAL=7001 Binds on IPv6 localhost (::1) for port 7001
  • UDS=/var/run/zuul.sock Binds a domain socket at /var/run/zuul.sock

Note that the local IPv4 binds only work for 127.0.0.1, and not any other loopback addresses. Currently, all IP stack specific bind types only "prefer" a stack; it is up to the OS and the JVM to pick the the final address.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    SocketAddressProperty.BindType
     

  • Field Summary

    Fields inherited from class com.netflix.config.StringDerivedProperty

    decoder

    Fields inherited from class com.netflix.config.PropertyWrapper

    defaultValue, prop

  • Constructor Summary

    Constructors
    Constructor
    Description
    SocketAddressProperty(String propName, String defaultValue)
     
    SocketAddressProperty(String propName, SocketAddress defaultValue)
     

  • Method Summary

    Methods inherited from class com.netflix.config.StringDerivedProperty

    getValue, propertyChanged

    Methods inherited from class com.netflix.config.PropertyWrapper

    addCallback, addValidator, getChangedTimestamp, getDefaultValue, getDynamicProperty, getName, propertyChanged, registerSubClassWithNoCallback, removeAllCallbacks, toString, validate

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SocketAddressProperty

      public SocketAddressProperty(String propName, SocketAddress defaultValue)

    • SocketAddressProperty

      public SocketAddressProperty(String propName, String defaultValue)