Class AbstractSingleSignOnProperties

java.lang.Object
com.vaadin.sso.core.AbstractSingleSignOnProperties

public abstract class AbstractSingleSignOnProperties extends Object
Definition of configuration properties for the SSO Kit starter.
Since:
1.0
Author:
Vaadin Ltd
  • Field Details

    • DEFAULT_LOGIN_ROUTE

      public static final String DEFAULT_LOGIN_ROUTE
      The default login route. Unauthorized requests will be redirected to this route. If there are no views mapped to this route, Spring's default login page will be generated.
      See Also:
    • DEFAULT_LOGOUT_REDIRECT_ROUTE

      public static final String DEFAULT_LOGOUT_REDIRECT_ROUTE
      The default logout-redirect route. Web browsers will be redirected to this route after the logout process has completed.
      See Also:
    • DEFAULT_BACKCHANNEL_LOGOUT_ROUTE

      @Deprecated(since="3.1", forRemoval=true) public static final String DEFAULT_BACKCHANNEL_LOGOUT_ROUTE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use built-in Spring Security support for OpenID Connect Back-Channel Logout
      The default Back-Channel Logout route. This should be the same as in the OIDC provider's configuration to be able to accept logout notices as described by the specification. It requires a URI variable to match the client registration-id: registrationId.
      See Also:
  • Constructor Details

    • AbstractSingleSignOnProperties

      public AbstractSingleSignOnProperties()
  • Method Details

    • isAutoConfigure

      @Deprecated(since="2.1.0", forRemoval=true) public boolean isAutoConfigure()
      Deprecated, for removal: This API element is subject to removal in a future version.
      to disable auto-configuration, use the spring.autoconfigure.exclude property
      Checks is auto-configuration of SingleSignOnConfiguration is enabled.
      Returns:
      always true, see deprecation tag
    • setAutoConfigure

      @Deprecated(since="2.1.0", forRemoval=true) public void setAutoConfigure(boolean autoConfigure)
      Deprecated, for removal: This API element is subject to removal in a future version.
      to disable auto-configuration, use the spring.autoconfigure.exclude property
      Enables or disables auto-configuration of SingleSignOnConfiguration.
      Parameters:
      autoConfigure - has no effect, see deprecation tag
    • getLoginRoute

      public String getLoginRoute()
      Gets the login-route property.
      Returns:
      the login-route property
    • setLoginRoute

      public void setLoginRoute(String loginRoute)
      Sets the login-route property.
      Parameters:
      loginRoute - the login-route property
    • getLogoutRedirectRoute

      public String getLogoutRedirectRoute()
      Gets the logout-redirect route.
      Returns:
      the logout-redirect route
    • setLogoutRedirectRoute

      public void setLogoutRedirectRoute(String logoutRedirectRoute)
      Sets the logout-redirect route.
      Parameters:
      logoutRedirectRoute - the logout-redirect route
    • isBackChannelLogout

      public boolean isBackChannelLogout()
      Checks weather Back-Channel logout is enabled.
      Returns:
      true if Back-Channel logout is enabled, false otherwise
    • setBackChannelLogout

      public void setBackChannelLogout(boolean backChannelLogout)
      Sets is Back-Channel logout is enabled.
      Parameters:
      backChannelLogout - weather to enable or disable Back-Channel logout
    • getBackChannelLogoutRoute

      public String getBackChannelLogoutRoute()
      Gets the Back-Channel Logout route.
      Returns:
      the Back-Channel Logout route
    • setBackChannelLogoutRoute

      public void setBackChannelLogoutRoute(String backChannelLogoutRoute)
      Sets the Back-Channel Logout route.
      Parameters:
      backChannelLogoutRoute - the Back-Channel Logout route
    • getMaximumConcurrentSessions

      public int getMaximumConcurrentSessions()
      Gets the maximum number of concurrent sessions per user.
      Returns:
      the maximum number of concurrent sessions
    • setMaximumConcurrentSessions

      public void setMaximumConcurrentSessions(int maximumConcurrentSessions)
      Sets maximum number of concurrent sessions per user.
      Parameters:
      maximumConcurrentSessions - maximum number of concurrent sessions