Interface HttpServerConfiguration


  • public interface HttpServerConfiguration
    Configuration values for a HttpServer.
    • Field Detail

      • HTTP_SERVER_PORT

        static final PropertyValue<Integer> HTTP_SERVER_PORT
        The port on which the http server is made available to clients.
        Value type: Integer
        Default value: 8080
      • HTTP_SERVER_SECURE

        static final PropertyValue<Boolean> HTTP_SERVER_SECURE
        Specifies whether https should be used.
        Value type: Boolean
        Default value: true
      • HTTP_SERVER_CLASSPATH_KEYSTORE

        static final PropertyValue<String> HTTP_SERVER_CLASSPATH_KEYSTORE
        The https keystore to use on the classpath, this will be resolved to a temporary file and set as the codion.server.http.keyStore system property on server start
        Value type: String Default value: null
      • HTTP_SERVER_KEYSTORE_PASSWORD

        static final PropertyValue<String> HTTP_SERVER_KEYSTORE_PASSWORD
        Specifies the password for the keystore used for securing http connections.
        Value type: String
        Default value: null
      • DOCUMENT_ROOT

        static final PropertyValue<String> DOCUMENT_ROOT
        Specifies the document root for file serving
        . Value type: String
        Default value: null
    • Method Detail

      • builderFromSystemProperties

        static HttpServerConfiguration.Builder builderFromSystemProperties()
        Parses configuration from system properties.
        Returns:
        a server configuration builder initialized according to system properties
      • serverPort

        int serverPort()
        Returns:
        the server port
      • isSecure

        boolean isSecure()
        Returns:
        true if https is used
      • documentRoot

        String documentRoot()
        Returns:
        the document root
      • keystorePath

        String keystorePath()
        Returns:
        the keystore path
      • keystorePassword

        String keystorePassword()
        Returns:
        the keystore password