com.github.mvysny.fakeservlet.FakeHttpEnvironment.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fake-servlet5 Show documentation
Fake Servlet
The newest version!
package com.github.mvysny.fakeservlet

import java.util.*
import jakarta.servlet.*
import jakarta.servlet.http.HttpServletResponse

public open class FakeServletConfig(public val context: ServletContext) : ServletConfig {

    /**
     * Per-servlet init parameters.
     */
    public var servletInitParams: MutableMap = mutableMapOf()

    override fun getInitParameter(name: String): String? = servletInitParams[name]

    override fun getInitParameterNames(): Enumeration = Collections.enumeration(servletInitParams.keys)

    override fun getServletName(): String = "Vaadin Servlet"

    override fun getServletContext(): ServletContext = context
}

internal fun  MutableMap.putOrRemove(key: K, value: V?) {
    if (value == null) remove(key) else set(key, value)
}

public object FakeHttpEnvironment {
    /**
     * [FakeRequest.getLocalPort]
     */
    public var localPort: Int = 8080

    /**
     * [FakeRequest.getServerPort]
     */
    public var serverPort: Int = 8080

    /**
     * [FakeRequest.getRemotePort]
     */
    public var remotePort: Int = 8080

    /**
     * [FakeRequest.getRemoteAddr]
     */
    public var remoteAddr: String = "127.0.0.1"

    /**
     * [FakeRequest.getAuthType]
     */
    public var authType: String? = null

    /**
     * [FakeRequest.isSecure]
     */
    public var isSecure: Boolean = false

    /**
     * [FakeRequest.authenticate]
     */
    public var authenticator: (HttpServletResponse) -> Boolean = { throw UnsupportedOperationException("not implemented. Set MockHttpEnvironment.authenticator to override") }

    /**
     * According to the servlet spec, HttpSession functions should fail on an invalidated session.
     * However, apparently the servlet containers do not take this check too seriously since existing Spring Security servlet-related
     * code apparently works and is happily reading and writing http session attributes on an invalidated session.
     *
     * Therefore this setting defaults to false which disables all session invalidity checks. Turn this
     * to true, to make [FakeHttpSession] behave according to the spec.
     *
     * See [FakeHttpSession.getAttribute] implementation for more details.
     */
    public var strictSessionValidityChecks: Boolean = false
}