Class Login


  • public final class Login
    extends Object
    The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
    • Constructor Detail

      • Login

        public Login()
    • Method Detail

      • routes

        public LoginRoutes routes()
        Get the routes property: The routes that specify the endpoints used for login and logout requests.
        Returns:
        the routes value.
      • withRoutes

        public Login withRoutes​(LoginRoutes routes)
        Set the routes property: The routes that specify the endpoints used for login and logout requests.
        Parameters:
        routes - the routes value to set.
        Returns:
        the Login object itself.
      • preserveUrlFragmentsForLogins

        public Boolean preserveUrlFragmentsForLogins()
        Get the preserveUrlFragmentsForLogins property: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.
        Returns:
        the preserveUrlFragmentsForLogins value.
      • withPreserveUrlFragmentsForLogins

        public Login withPreserveUrlFragmentsForLogins​(Boolean preserveUrlFragmentsForLogins)
        Set the preserveUrlFragmentsForLogins property: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.
        Parameters:
        preserveUrlFragmentsForLogins - the preserveUrlFragmentsForLogins value to set.
        Returns:
        the Login object itself.
      • allowedExternalRedirectUrls

        public List<String> allowedExternalRedirectUrls()
        Get the allowedExternalRedirectUrls property: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.
        Returns:
        the allowedExternalRedirectUrls value.
      • withAllowedExternalRedirectUrls

        public Login withAllowedExternalRedirectUrls​(List<String> allowedExternalRedirectUrls)
        Set the allowedExternalRedirectUrls property: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.
        Parameters:
        allowedExternalRedirectUrls - the allowedExternalRedirectUrls value to set.
        Returns:
        the Login object itself.
      • cookieExpiration

        public CookieExpiration cookieExpiration()
        Get the cookieExpiration property: The configuration settings of the session cookie's expiration.
        Returns:
        the cookieExpiration value.
      • withCookieExpiration

        public Login withCookieExpiration​(CookieExpiration cookieExpiration)
        Set the cookieExpiration property: The configuration settings of the session cookie's expiration.
        Parameters:
        cookieExpiration - the cookieExpiration value to set.
        Returns:
        the Login object itself.
      • nonce

        public Nonce nonce()
        Get the nonce property: The configuration settings of the nonce used in the login flow.
        Returns:
        the nonce value.
      • withNonce

        public Login withNonce​(Nonce nonce)
        Set the nonce property: The configuration settings of the nonce used in the login flow.
        Parameters:
        nonce - the nonce value to set.
        Returns:
        the Login object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.