Package jakarta.ws.rs

Interface SeBootstrap.Configuration

  • Enclosing interface:
    SeBootstrap

    public static interface SeBootstrap.Configuration
    Provides information needed by the JAX-RS implementation for bootstrapping an application.

    The configuration essentially consists of a set of parameters. While the set of actually effective keys is product specific, the key constants defined by the SeBootstrap.Configuration interface MUST be effective on all compliant products. Any unknown key MUST be silently ignored.

    Since:
    3.1
    Author:
    Markus KARG (markus@headcrashing.eu)
    • Field Detail

      • PROTOCOL

        static final String PROTOCOL
        Configuration key for the protocol an application is bound to.

        A compliant implementation at least MUST accept the strings "HTTP" and "HTTPS" if these protocols are supported.

        The default value is "HTTP".

        Since:
        3.1
        See Also:
        Constant Field Values
      • HOST

        static final String HOST
        Configuration key for the hostname or IP address an application is bound to.

        A compliant implementation at least MUST accept string values bearing hostnames, IP4 address text representations, and IP6 address text representations. If a hostname string, the special IP4 address string "0.0.0.0" or "::" for IP6 is provided, the application MUST be bound to all IP addresses assigned to that hostname. If the hostname string is "localhost" the application MUST be bound to the local host's loopback adapter only.

        The default value is "localhost".

        Since:
        3.1
        See Also:
        Constant Field Values
      • PORT

        static final String PORT
        Configuration key for the TCP port an application is bound to.

        A compliant implementation MUST accept java.lang.Integer values.

        There is no default port mandated by this specification, but the default value of this property is DEFAULT_PORT (i. e. -1). A compliant implementation MUST use its own default port when the value -1 is provided, and MAY apply (but is not obligated to) auto-selection and range-scanning algorithms.

        Since:
        3.1
        See Also:
        Constant Field Values
      • ROOT_PATH

        static final String ROOT_PATH
        Configuration key for the root path an application is bound to.

        The default value is "/".

        Since:
        3.1
        See Also:
        Constant Field Values
      • FREE_PORT

        static final int FREE_PORT
        Special value for PORT property indicating that the implementation MUST scan for a free port.
        Since:
        3.1
        See Also:
        Constant Field Values
      • DEFAULT_PORT

        static final int DEFAULT_PORT
        Special value for PORT property indicating that the implementation MUST use its default port.
        Since:
        3.1
        See Also:
        Constant Field Values