Package io.vertx.ext.shell.term

Class HttpTermOptions

    • Constructor Detail

      • HttpTermOptions

        public HttpTermOptions()

      • HttpTermOptions

        public HttpTermOptions​(JsonObject json)

    • Method Detail

      • defaultVertxShellJsResource

        public static Buffer defaultVertxShellJsResource()
        Returns:
        the vertxshell.js default resource as a buffer

      • defaultTermJsResource

        public static Buffer defaultTermJsResource()
        Returns:
        the term.js default resource as a buffer

      • defaultShellHtmlResource

        public static Buffer defaultShellHtmlResource()
        Returns:
        the shell.html default resource as a buffer

      • getSockJSHandlerOptions

        public SockJSHandlerOptions getSockJSHandlerOptions()
        Returns:
        the SockJS handler options

      • setSockJSHandlerOptions

        public HttpTermOptions setSockJSHandlerOptions​(SockJSHandlerOptions sockJSHandlerOptions)
        The SockJS handler options.
        Parameters:
        sockJSHandlerOptions - the options to use
        Returns:
        a reference to this, so the API can be used fluently

      • getSockJSPath

        public String getSockJSPath()
        Returns:
        the SockJS path

      • setSockJSPath

        public HttpTermOptions setSockJSPath​(String sockJSPath)
        Configure the SockJS path, the default value is /term/*.
        Parameters:
        sockJSPath - the new SockJS path
        Returns:
        a reference to this, so the API can be used fluently

      • getAuthOptions

        public JsonObject getAuthOptions()
        Returns:
        the auth options

      • setAuthOptions

        public HttpTermOptions setAuthOptions​(JsonObject authOptions)
        Set the auth options.
        Parameters:
        authOptions - the auth options
        Returns:
        a reference to this, so the API can be used fluently

      • setSendBufferSize

        public HttpTermOptions setSendBufferSize​(int sendBufferSize)
        Description copied from class: NetworkOptions
        Set the TCP send buffer size
        Overrides:
        setSendBufferSize in class HttpServerOptions
        Parameters:
        sendBufferSize - the buffers size, in bytes
        Returns:
        a reference to this, so the API can be used fluently

      • setReceiveBufferSize

        public HttpTermOptions setReceiveBufferSize​(int receiveBufferSize)
        Description copied from class: NetworkOptions
        Set the TCP receive buffer size
        Overrides:
        setReceiveBufferSize in class HttpServerOptions
        Parameters:
        receiveBufferSize - the buffers size, in bytes
        Returns:
        a reference to this, so the API can be used fluently

      • setReuseAddress

        public HttpTermOptions setReuseAddress​(boolean reuseAddress)
        Description copied from class: NetworkOptions
        Set the value of reuse address
        Overrides:
        setReuseAddress in class HttpServerOptions
        Parameters:
        reuseAddress - the value of reuse address
        Returns:
        a reference to this, so the API can be used fluently

      • setTrafficClass

        public HttpTermOptions setTrafficClass​(int trafficClass)
        Description copied from class: NetworkOptions
        Set the value of traffic class
        Overrides:
        setTrafficClass in class HttpServerOptions
        Parameters:
        trafficClass - the value of traffic class
        Returns:
        a reference to this, so the API can be used fluently

      • setTcpNoDelay

        public HttpTermOptions setTcpNoDelay​(boolean tcpNoDelay)
        Description copied from class: TCPSSLOptions
        Set whether TCP no delay is enabled
        Overrides:
        setTcpNoDelay in class HttpServerOptions
        Parameters:
        tcpNoDelay - true if TCP no delay is enabled (Nagle disabled)
        Returns:
        a reference to this, so the API can be used fluently

      • setTcpKeepAlive

        public HttpTermOptions setTcpKeepAlive​(boolean tcpKeepAlive)
        Description copied from class: TCPSSLOptions
        Set whether TCP keep alive is enabled
        Overrides:
        setTcpKeepAlive in class HttpServerOptions
        Parameters:
        tcpKeepAlive - true if TCP keep alive is enabled
        Returns:
        a reference to this, so the API can be used fluently

      • setSoLinger

        public HttpTermOptions setSoLinger​(int soLinger)
        Description copied from class: TCPSSLOptions
        Set whether SO_linger keep alive is enabled
        Overrides:
        setSoLinger in class HttpServerOptions
        Parameters:
        soLinger - true if SO_linger is enabled
        Returns:
        a reference to this, so the API can be used fluently

      • setIdleTimeout

        public HttpTermOptions setIdleTimeout​(int idleTimeout)
        Description copied from class: TCPSSLOptions
        Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received nor sent within the timeout. If you want change default time unit, use TCPSSLOptions.setIdleTimeoutUnit(TimeUnit)
        Overrides:
        setIdleTimeout in class HttpServerOptions
        Parameters:
        idleTimeout - the timeout
        Returns:
        a reference to this, so the API can be used fluently

      • setSsl

        public HttpTermOptions setSsl​(boolean ssl)
        Description copied from class: TCPSSLOptions
        Set whether SSL/TLS is enabled
        Overrides:
        setSsl in class HttpServerOptions
        Parameters:
        ssl - true if enabled
        Returns:
        a reference to this, so the API can be used fluently

      • setClientAuth

        public HttpTermOptions setClientAuth​(ClientAuth clientAuth)
        Description copied from class: NetServerOptions
        Set whether client auth is required
        Overrides:
        setClientAuth in class HttpServerOptions
        Parameters:
        clientAuth - One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then it won't mandate the certificate to be presented, basically make it optional.
        Returns:
        a reference to this, so the API can be used fluently

      • setCompressionSupported

        public HttpTermOptions setCompressionSupported​(boolean compressionSupported)
        Description copied from class: HttpServerOptions
        Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header)
        Overrides:
        setCompressionSupported in class HttpServerOptions
        Parameters:
        compressionSupported - true to enable compression support
        Returns:
        a reference to this, so the API can be used fluently

      • setHandle100ContinueAutomatically

        public HttpTermOptions setHandle100ContinueAutomatically​(boolean handle100ContinueAutomatically)
        Description copied from class: HttpServerOptions
        Set whether 100 Continue should be handled automatically
        Overrides:
        setHandle100ContinueAutomatically in class HttpServerOptions
        Parameters:
        handle100ContinueAutomatically - true if it should be handled automatically
        Returns:
        a reference to this, so the API can be used fluently

      • getVertsShellJsResource

        public Buffer getVertsShellJsResource()
        Returns:
        the vertxshell.js resource for this server

      • setVertsShellJsResource

        public HttpTermOptions setVertsShellJsResource​(Buffer vertsShellJsResource)
        Set vertxshell.js resource to use.
        Parameters:
        vertsShellJsResource - the resource
        Returns:
        a reference to this, so the API can be used fluently

      • getTermJsResource

        public Buffer getTermJsResource()
        Returns:
        the term.js resource for this server

      • setTermJsResource

        public HttpTermOptions setTermJsResource​(Buffer termJsResource)
        Set term.js resource to use.
        Parameters:
        termJsResource - the resource
        Returns:
        a reference to this, so the API can be used fluently

      • getShellHtmlResource

        public Buffer getShellHtmlResource()
        Returns:
        the shell.html resource for this server

      • setShellHtmlResource

        public HttpTermOptions setShellHtmlResource​(Buffer shellHtmlResource)
        Set shell.html resource to use.
        Parameters:
        shellHtmlResource - the resource
        Returns:
        a reference to this, so the API can be used fluently

      • getCharset

        public String getCharset()
        Returns:
        the charset used for encoding / decoding text from/to SockJS

      • setCharset

        public HttpTermOptions setCharset​(String charset)
        Set the charset used for encoding / decoding text data from/to SockJS
        Parameters:
        charset - the charset to use
        Returns:
        a reference to this, so the API can be used fluently

      • getIntputrc

        public String getIntputrc()
        Returns:
        the current path of the inputrc config

      • setIntputrc

        public HttpTermOptions setIntputrc​(String intputrc)
        The path of the inputrc config.
        Parameters:
        intputrc - the path of the inputrc config
        Returns:
        a reference to this, so the API can be used fluently