Package org.sblim.slp

Interface SLPConfigProperties


public interface SLPConfigProperties
The interface SLPConfigProperties holds string constants for the configuration properties of the SLP package. To set a property call System.setProperty(name, value). Note that these properties have global VM scope.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    A URL string giving the location of the SLP config file.
    static final String
    A 16 bit positive integer giving the number of seconds the DA url lifetime should exceed the discovery interval.

    Default is 900 seconds (15 minutes).

    SBLIM specific extension to RFC 2614
    static final String
    A 16 bit positive integer giving the number of seconds between DA active discovery queries.

    Default is 900 seconds (15 minutes).

    If the property is set to zero, active discovery is turned off.
    static final String
    A value-list of IP addresses or DNS resolvable host names giving the SLPv2 DAs to use for statically configured UAs and SAs.
    static final String
    A comma-separated list of parenthesized attribute/value list pairs that the DA must advertise in DAAdverts.
    static final String
    A value-list of 32 bit integers used as timeouts, in milliseconds, to implement the multicast convergence algorithm during active DA discovery.
    static final String
    A 32 bit integer giving the number of seconds for the DA heartbeat.
    static final String
    A value-list of 32 bit integers used as timeouts, in milliseconds, to implement unicast datagram transmission to DAs.
    static final String
    Value-list of strings giving the IP addresses of network interfaces on which the DA or SA should listen on port 427 for multicast, unicast UDP, and TCP messages.

    Default is empty, i.e.
    static final String
    A boolean indicating if broadcast should be used instead of multicast.

    Default is false.
    static final String
    A boolean indicating if the SLP server is to act as a DA.
    static final String
    A RFC 1766 Language Tag for the language locale.
    static final String
    A 32 bit integer giving the maximum number of results to accumulate and return for a synchronous request before the timeout, or the maximum number of results to return through a callback if the request results are reported asynchronously.
    Positive integers and -1 are legal values.
    static final String
    A 16 bit integer giving the network packet MTU, in bytes.
    static final String
    A 32 bit integer giving the maximum amount of time to perform multicast, in milliseconds.

    Default is 2000 ms.
    static final String
    A value-list of 32 bit integers used as timeouts, in milliseconds, to implement the multicast convergence algorithm.
    static final String
    A positive integer less than or equal to 255, giving the multicast TTL.

    Default is 255.
    static final String
    A boolean indicating whether passive DA detection should be used.

    Default is true.

    Not evaluated by SBLIM SLP client
    static final String
    A 16 bit integer giving the port used for listening.

    Default is 427.
    static final String
    A 32 bit integer giving the maximum value for all random wait parameters, in milliseconds.
    static final String
    A comma-separated list of parenthesized attribute/value list pairs that the SA must advertise in SAAdverts.
    static final String
    A value-list of strings indicating the scopes that are only applied to SAs.
    static final String
    A comma-separated list of parenthesized attribute/value list pairs that the SA must advertise in SAAdverts.
    static final String
    A string containing a URL pointing to a document containing serialized registrations that should be processed when the DA or SA server starts up.

    Default is none.

    Not evaluated by SBLIM SLP client
    static final String
    A 32 bit integer giving the server socket queue length for SAs/DAs.

    Default is 10.

    SBLIM specific extension to RFC 2614
    static final String
    A 32 bit integer giving the TCP timeout in milliseconds.

    The default is 20000 ms.
    static final String
    A boolean controlling printing of messages about traffic with DAs.
    static final String
    A boolean controlling printing details when a SLP message is dropped for any reason.
    static final String
    A boolean controlling printing of details on SLP messages.
    static final String
    A boolean controlling dumps of all registered services upon registration and deregistration.
    static final String
    Trace level.
    static final String
    A value-list of service type names.
    static final String
    A value-list of strings indicating the only scopes a UA or SA is allowed to use when making requests or registering, or the scopes a DA must support.
    If not present for the DA and SA, then in the absence of scope information from DHCP, the default scope "DEFAULT" is used.
    static final String
    A boolean indicating whether IPv4 addresses should be used.

    Default is true.
    static final String
    A boolean indicating whether IPv6 addresses should be used.

    Default is true.
  • Field Details

    • NET_SLP_CONFIG_URL

      static final String NET_SLP_CONFIG_URL
      A URL string giving the location of the SLP config file.

      By default the SLP client looks for
      • file:sblim-slp-client2.properties
      • file:%USER_HOME%/sblim-slp-client2.properties
      • file:/etc/java/sblim-slp-client2.properties
      • file:/etc/sblim-slp-client2.properties
      The first file found will be used. The default search list is not applied if this property is set, even if the given URL does not exist.

      SBLIM specific extension to RFC 2614
      See Also:
    • NET_SLP_DA_ACTIVE_DISCOVERY_GRANULARITY

      static final String NET_SLP_DA_ACTIVE_DISCOVERY_GRANULARITY
      A 16 bit positive integer giving the number of seconds the DA url lifetime should exceed the discovery interval.

      Default is 900 seconds (15 minutes).

      SBLIM specific extension to RFC 2614
      See Also:
    • NET_SLP_DA_ACTIVE_DISCOVERY_INTERVAL

      static final String NET_SLP_DA_ACTIVE_DISCOVERY_INTERVAL
      A 16 bit positive integer giving the number of seconds between DA active discovery queries.

      Default is 900 seconds (15 minutes).

      If the property is set to zero, active discovery is turned off. This is useful when the DAs available are explicitly restricted to those obtained from DHCP or the net.slp.DAAddresses property.
      See Also:
    • NET_SLP_DA_ADDRESSES

      static final String NET_SLP_DA_ADDRESSES
      A value-list of IP addresses or DNS resolvable host names giving the SLPv2 DAs to use for statically configured UAs and SAs. Ignored by DAs (unless the DA is also an SA server).

      Default is none.

      The following grammar describes the property:

      addr-list = addr / addr "," addr-list
      addr = fqdn / hostnumber
      fqdn = ALPHA / ALPHA *[ anum / "-" ] anum
      anum = ALPHA / DIGIT
      hostnumber = 1*3DIGIT 3("." 1*3DIGIT)

      An example is:

      sawah,mandi,sambal

      IP addresses can be used instead of host names in networks where DNS is not deployed, but network administrators are reminded that using IP addresses will complicate machine renumbering, since the SLP configuration property files in statically configured networks will have to be changed. Similarly, if host names are used, implementors must be careful that a name service is available before SLP starts, in other words, SLP cannot be used to find the name service.
      See Also:
    • NET_SLP_DA_ATTRIBUTES

      static final String NET_SLP_DA_ATTRIBUTES
      A comma-separated list of parenthesized attribute/value list pairs that the DA must advertise in DAAdverts. The property must be in the SLP attribute list wire format, including escapes for reserved characters.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_DA_DISCOVERY_TIMEOUTS

      static final String NET_SLP_DA_DISCOVERY_TIMEOUTS
      A value-list of 32 bit integers used as timeouts, in milliseconds, to implement the multicast convergence algorithm during active DA discovery. Each value specifies the time to wait before sending the next request, or until nothing new has been learned from two successive requests.

      Default is: 200,200,200,200,300,400.
      See Also:
    • NET_SLP_DA_HEARTBEAT

      static final String NET_SLP_DA_HEARTBEAT
      A 32 bit integer giving the number of seconds for the DA heartbeat. Ignored if isDA is false.

      Default is 10800 seconds (3 hours).

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_DATAGRAM_TIMEOUTS

      static final String NET_SLP_DATAGRAM_TIMEOUTS
      A value-list of 32 bit integers used as timeouts, in milliseconds, to implement unicast datagram transmission to DAs. The nth value gives the time to block waiting for a reply on the nth try to contact the DA.

      Default is: 100,200,300
      See Also:
    • NET_SLP_INTERFACES

      static final String NET_SLP_INTERFACES
      Value-list of strings giving the IP addresses of network interfaces on which the DA or SA should listen on port 427 for multicast, unicast UDP, and TCP messages.

      Default is empty, i.e. use the default network interface.

      The grammar for this property is:

      addr-list = hostnumber / hostnumber "," addr-list
      hostnumber = 1*3DIGIT 3("." 1*3DIGIT)

      An example is:

      195.42.42.42,195.42.142.1,195.42.120.1

      The example machine has three interfaces on which the DA should listen. Note that since this property only takes IP addresses, it will need to be changed if the network is renumbered.
      See Also:
    • NET_SLP_IS_BROADCAST_ONLY

      static final String NET_SLP_IS_BROADCAST_ONLY
      A boolean indicating if broadcast should be used instead of multicast.

      Default is false.
      See Also:
    • NET_SLP_IS_DA

      static final String NET_SLP_IS_DA
      A boolean indicating if the SLP server is to act as a DA. If false, run as a SA.

      Default is false.
      See Also:
    • NET_SLP_LOCALE

      static final String NET_SLP_LOCALE
      A RFC 1766 Language Tag for the language locale. Setting this property causes the property value to become the default locale for SLP messages. This property is also used for SA and DA configuration.

      Default is en.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_MAX_RESULTS

      static final String NET_SLP_MAX_RESULTS
      A 32 bit integer giving the maximum number of results to accumulate and return for a synchronous request before the timeout, or the maximum number of results to return through a callback if the request results are reported asynchronously.
      Positive integers and -1 are legal values. If -1, indicates that all results should be returned.

      Default value is 2147483647 (2^31 - 1)
      SBLIM specific: RFC 2614 recommendation is -1.

      DAs and SAs always return all results that match the request. This configuration value applies only to UAs, that filter incoming results and only return as many values as net.slp.maxResults indicates.
      See Also:
    • NET_SLP_MTU

      static final String NET_SLP_MTU
      A 16 bit integer giving the network packet MTU, in bytes. This is the maximum size of any datagram to send, but the implementation might receive a larger datagram. The maximum size includes IP, and UDP or TCP headers.

      Default is 1400.
      See Also:
    • NET_SLP_MULTICAST_MAXIMUM_WAIT

      static final String NET_SLP_MULTICAST_MAXIMUM_WAIT
      A 32 bit integer giving the maximum amount of time to perform multicast, in milliseconds.

      Default is 2000 ms.
      See Also:
    • NET_SLP_MULTICAST_TIMEOUTS

      static final String NET_SLP_MULTICAST_TIMEOUTS
      A value-list of 32 bit integers used as timeouts, in milliseconds, to implement the multicast convergence algorithm. Each value specifies the time to wait before sending the next request, or until nothing new has been learned from two successive requests.

      Default is: 200, 200, 200, 200, 300, 400
      SBLIM specific: RFC 2614 recommendation is 3000,3000,3000,3000,3000.

      In a fast network the aggressive values of 1000,1250,1500,2000,4000 allow better performance.

      Note that the net.slp.DADiscoveryTimeouts property must be used for active DA discovery.
      See Also:
    • NET_SLP_MULTICAST_TTL

      static final String NET_SLP_MULTICAST_TTL
      A positive integer less than or equal to 255, giving the multicast TTL.

      Default is 255.
      See Also:
    • NET_SLP_PASSIVE_DA_DETECTION

      static final String NET_SLP_PASSIVE_DA_DETECTION
      A boolean indicating whether passive DA detection should be used.

      Default is true.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_PORT

      static final String NET_SLP_PORT
      A 16 bit integer giving the port used for listening.

      Default is 427.
      See Also:
    • NET_SLP_USEIPV6

      static final String NET_SLP_USEIPV6
      A boolean indicating whether IPv6 addresses should be used.

      Default is true.
      See Also:
    • NET_SLP_USEIPV4

      static final String NET_SLP_USEIPV4
      A boolean indicating whether IPv4 addresses should be used.

      Default is true.
      See Also:
    • NET_SLP_RANDOM_WAIT_BOUND

      static final String NET_SLP_RANDOM_WAIT_BOUND
      A 32 bit integer giving the maximum value for all random wait parameters, in milliseconds.

      Default is 1000 ms.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_SA_ATTRIBUTES

      static final String NET_SLP_SA_ATTRIBUTES
      A comma-separated list of parenthesized attribute/value list pairs that the SA must advertise in SAAdverts. The property must be in the SLP attribute list wire format, including escapes for reserved characters.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_SAONLY_SCOPES

      static final String NET_SLP_SAONLY_SCOPES
      A value-list of strings indicating the scopes that are only applied to SAs. In contradiction the "net.slp.useScopes" specifies the scope for UAs and SAs.

      SBLIM specific extension to RFC 2614
      See Also:
    • NET_SLP_SECURITY_ENABLED

      static final String NET_SLP_SECURITY_ENABLED
      A comma-separated list of parenthesized attribute/value list pairs that the SA must advertise in SAAdverts. The property must be in the SLP attribute list wire format, including escapes for reserved characters.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_SERIALIZED_REG_URL

      static final String NET_SLP_SERIALIZED_REG_URL
      A string containing a URL pointing to a document containing serialized registrations that should be processed when the DA or SA server starts up.

      Default is none.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_SERVER_SOCKET_QUEUE_LENGTH

      static final String NET_SLP_SERVER_SOCKET_QUEUE_LENGTH
      A 32 bit integer giving the server socket queue length for SAs/DAs.

      Default is 10.

      SBLIM specific extension to RFC 2614
      See Also:
    • NET_SLP_TCPTIMEOUT

      static final String NET_SLP_TCPTIMEOUT
      A 32 bit integer giving the TCP timeout in milliseconds.

      The default is 20000 ms.

      SBLIM specific extension to RFC 2614
      See Also:
    • NET_SLP_TRACE_DA_TRAFFIC

      static final String NET_SLP_TRACE_DA_TRAFFIC
      A boolean controlling printing of messages about traffic with DAs.

      Default is false.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_TRACE_DROP

      static final String NET_SLP_TRACE_DROP
      A boolean controlling printing details when a SLP message is dropped for any reason.

      Default is false.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_TRACE_MSG

      static final String NET_SLP_TRACE_MSG
      A boolean controlling printing of details on SLP messages. The fields in all incoming messages and outgoing replies are printed.

      Default is false.
      See Also:
    • NET_SLP_TRACE_REG

      static final String NET_SLP_TRACE_REG
      A boolean controlling dumps of all registered services upon registration and deregistration. If true, the contents of the DA or SA server are dumped after a registration or deregistration occurs.

      Default is false.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_TYPE_HINT

      static final String NET_SLP_TYPE_HINT
      A value-list of service type names. In the absence of any DAs, UAs perform SA discovery for finding scopes. These SA discovery requests may contain a request for service types as an attribute.

      The API implementation will use the service type names supplied by this property to discover only those SAs (and their scopes) which support the desired service type or types. For example, if net.slp.typeHint is set to "service:imap,service:pop3" then SA discovery requests will include the search filter:

      (|(service-type=service:imap)(service-type=service:pop3))

      The API library can also use unicast to contact the discovered SAs for subsequent requests for these service types, to optimize network access.

      Not evaluated by SBLIM SLP client
      See Also:
    • NET_SLP_USE_SCOPES

      static final String NET_SLP_USE_SCOPES
      A value-list of strings indicating the only scopes a UA or SA is allowed to use when making requests or registering, or the scopes a DA must support.
      If not present for the DA and SA, then in the absence of scope information from DHCP, the default scope "DEFAULT" is used. If not present for the UA, and there is no scope information available from DHCP, then the user scoping model is in force.
      Active and passive DA discovery or SA discovery are used for scope discovery, and the scope "DEFAULT" is used if no other information is available.
      If a DA or SA gets another scope in a request, a SCOPE_NOT_SUPPORTED error should be returned, unless the request was multicast, in which case it should be dropped. If a DA gets another scope in a registration, a SCOPE_NOT_SUPPORTED error must be returned.
      See Also:
    • NET_SLP_TRC_LEVEL

      static final String NET_SLP_TRC_LEVEL
      Trace level. Can be ALL, INFO, WARNING, ERROR, OFF

      Not evaluated by SBLIM SLP client
      See Also: