Package io.quarkus.vertx.http.security

Class Form.Builder

java.lang.Object
io.quarkus.vertx.http.security.Form.Builder
Enclosing interface:
Form
public static final class Form.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • postLocation

      public Form.Builder postLocation(String postLocation)
      Configures the post location.
      Parameters:
      postLocation - see the 'quarkus.http.auth.form.post-location' configuration property
      Returns:
      Builder
      See Also:

    • loginPage

      public Form.Builder loginPage(String loginPage)
      Configures the login page.
      Parameters:
      loginPage - see the 'quarkus.http.auth.form.login-page' configuration property
      Returns:
      Builder
      See Also:

    • loginPageQueryParameters

      public Form.Builder loginPageQueryParameters(String... queryParameters)
      Configures query parameters Quarkus passes through when redirecting requests to the login page.
      Parameters:
      queryParameters - query parameters; must not be null
      Returns:
      Builder
      See Also:

    • usernameParameter

      public Form.Builder usernameParameter(String usernameParameter)
      Configures the username field name.
      Parameters:
      usernameParameter - see the 'quarkus.http.auth.form.username-parameter' configuration property
      Returns:
      Builder
      See Also:

    • passwordParameter

      public Form.Builder passwordParameter(String passwordParameter)
      Configures the password field name.
      Parameters:
      passwordParameter - see the 'quarkus.http.auth.form.password-parameter' configuration property
      Returns:
      Builder
      See Also:

    • errorPage

      public Form.Builder errorPage(String errorPage)
      Configures the error page.
      Parameters:
      errorPage - see the 'quarkus.http.auth.form.error-page' configuration property
      Returns:
      Builder
      See Also:

    • errorPageQueryParameters

      public Form.Builder errorPageQueryParameters(String... queryParameters)
      Configures query parameters Quarkus passes through when redirecting requests to the error page.
      Parameters:
      queryParameters - query parameters; must not be null
      Returns:
      Builder
      See Also:

    • landingPage

      public Form.Builder landingPage(String landingPage)
      Configures the landing page to redirect to if there is no saved page to redirect back to.
      Parameters:
      landingPage - see the 'quarkus.http.auth.form.landing-page' configuration property
      Returns:
      Builder
      See Also:

    • landingPageQueryParameters

      public Form.Builder landingPageQueryParameters(String... queryParameters)
      Configures query parameters Quarkus passes through when redirecting requests to the landing page.
      Parameters:
      queryParameters - query parameters; must not be null
      Returns:
      Builder
      See Also:

    • locationCookie

      public Form.Builder locationCookie(String locationCookie)
      Configures a name for the cookie that is used to redirect the user back to the location they want to access.
      Parameters:
      locationCookie - see the 'quarkus.http.auth.form.location-cookie' configuration property
      Returns:
      Builder
      See Also:

    • timeout

      public Form.Builder timeout(Duration timeout)
      Configures the inactivity timeout.
      Parameters:
      timeout - see the 'quarkus.http.auth.form.timeout' configuration property
      Returns:
      Builder
      See Also:

    • newCookieInterval

      public Form.Builder newCookieInterval(Duration newCookieInterval)
      Configures how old a cookie can get before it will be replaced with a new cookie with an updated timeout.
      Parameters:
      newCookieInterval - see the 'quarkus.http.auth.form.new-cookie-interval' configuration property
      Returns:
      Builder
      See Also:

    • cookieName

      public Form.Builder cookieName(String cookieName)
      Configures a name for the cookie that is used to store the persistent session.
      Parameters:
      cookieName - see the 'quarkus.http.auth.form.cookie-name' configuration property
      Returns:
      Builder
      See Also:

    • cookiePath

      public Form.Builder cookiePath(String cookiePath)
      Configures the cookie path for the session and location cookies.
      Parameters:
      cookiePath - see the 'quarkus.http.auth.form.cookie-path' configuration property
      Returns:
      Builder
      See Also:

    • cookieDomain

      public Form.Builder cookieDomain(String cookieDomain)
      Configures the 'domain' attribute for the session and location cookies.
      Parameters:
      cookieDomain - see the 'quarkus.http.auth.form.cookie-domain' configuration property
      Returns:
      Builder
      See Also:

    • httpOnlyCookie

      public Form.Builder httpOnlyCookie(boolean httpOnlyCookie)
      Configures the HttpOnly attribute to prevent access to the cookie via JavaScript.
      Parameters:
      httpOnlyCookie - see the 'quarkus.http.auth.form.http-only-cookie' configuration property
      Returns:
      Builder
      See Also:

    • httpOnlyCookie

      public Form.Builder httpOnlyCookie()
      This method is a shortcut for httpOnlyCookie(true).
      Returns:
      Builder
      See Also:

    • cookieSameSite

      public Form.Builder cookieSameSite(FormAuthConfig.CookieSameSite cookieSameSite)
      Configures the SameSite attribute for the session and location cookies.
      Parameters:
      cookieSameSite - see the 'quarkus.http.auth.form.cookie-same-site' configuration property
      Returns:
      Builder
      See Also:

    • cookieMaxAge

      public Form.Builder cookieMaxAge(Duration cookieMaxAge)
      Configures the Max-Age attribute for the session cookie.
      Parameters:
      cookieMaxAge - see the 'quarkus.http.auth.form.cookie-max-age' configuration property
      Returns:
      Builder
      See Also:

    • encryptionKey

      public Form.Builder encryptionKey(String encryptionKey)
      Configures the encryption key that is used to store persistent logins for the Form-based authentication.
      Parameters:
      encryptionKey - see the 'quarkus.http.auth.session.encryption-key' configuration property
      Returns:
      Builder
      See Also:

    • build

      public HttpAuthenticationMechanism build()