Package io.jans.configapi.core.model.adminui

Class AUIConfiguration

java.lang.Object
io.jans.configapi.core.model.adminui.AUIConfiguration
public class AUIConfiguration extends Object

  • Constructor Details

    • AUIConfiguration

      public AUIConfiguration()

  • Method Details

    • getAdditionalParameters

      public List<io.jans.as.model.config.adminui.KeyValuePair> getAdditionalParameters()
      Retrieves the additional key-value parameters configured for the Admin UI.
      Returns:
      the list of additional parameters, or null if none are set

    • setAdditionalParameters

      public void setAdditionalParameters(List<io.jans.as.model.config.adminui.KeyValuePair> additionalParameters)
      Set additional key-value parameters for the configuration.
      Parameters:
      additionalParameters - the list of extra KeyValuePair entries, or null to clear them

    • getSessionTimeoutInMins

      public Integer getSessionTimeoutInMins()
      Get the UI session timeout value in minutes.
      Returns:
      the session timeout in minutes, or `null` if not set

    • setSessionTimeoutInMins

      public void setSessionTimeoutInMins(Integer sessionTimeoutInMins)
      Sets the UI session timeout in minutes.
      Parameters:
      sessionTimeoutInMins - the session timeout in minutes, or null to unset

    • getAppType

      public String getAppType()
      Gets the application type identifier for the Admin UI.
      Returns:
      the application type identifier, or null if not set

    • setAppType

      public void setAppType(String appType)
      Sets the application type.
      Parameters:
      appType - the application type identifier for this configuration

    • getAuiWebServerHost

      public String getAuiWebServerHost()
      Gets the host configured for the Admin UI web server.
      Returns:
      the Admin UI web server host, or `null` if not set

    • setAuiWebServerHost

      public void setAuiWebServerHost(String auiWebServerHost)
      Sets the Admin UI web server host.
      Parameters:
      auiWebServerHost - the host (hostname or IP) for the Admin UI web server

    • getAuiWebServerClientId

      public String getAuiWebServerClientId()
      Gets the client ID used by the Admin UI web server.
      Returns:
      the client ID for the Admin UI web server, or null if not set

    • setAuiWebServerClientId

      public void setAuiWebServerClientId(String auiWebServerClientId)
      Sets the client identifier used by the Admin UI web server.
      Parameters:
      auiWebServerClientId - the client ID for the Admin UI web server

    • getAuiWebServerClientSecret

      public String getAuiWebServerClientSecret()
      Gets the Admin UI web server OAuth client secret.
      Returns:
      the client secret for the Admin UI web server, or null if not set.

    • setAuiWebServerClientSecret

      public void setAuiWebServerClientSecret(String auiWebServerClientSecret)
      Set the client secret used by the Admin UI web server's OAuth2 client.
      Parameters:
      auiWebServerClientSecret - the client secret string, or null to clear it

    • getAuiWebServerScope

      public String getAuiWebServerScope()
      Gets the OAuth2/OpenID Connect scope used by the Admin UI web server.
      Returns:
      the scope string configured for the Admin UI web server, or null if not set

    • setAuiWebServerScope

      public void setAuiWebServerScope(String auiWebServerScope)
      Sets the OAuth2/OpenID Connect scope used by the Admin UI web server.
      Parameters:
      auiWebServerScope - a space-separated scope string for the Admin UI web server's client

    • getAuiWebServerAcrValues

      public String getAuiWebServerAcrValues()
      Retrieves the ACR values configured for the Admin UI web server.
      Returns:
      the ACR values string for the Admin UI web server, or null if not set

    • setAuiWebServerAcrValues

      public void setAuiWebServerAcrValues(String auiWebServerAcrValues)
      Sets the ACR (Authentication Context Class Reference) values used by the Admin UI web server.
      Parameters:
      auiWebServerAcrValues - space-separated ACR values to include in authentication requests

    • getAuiWebServerRedirectUrl

      public String getAuiWebServerRedirectUrl()
      Gets the Admin UI web server's configured redirect URL.
      Returns:
      the configured redirect URL for the Admin UI web server, or null if not set

    • setAuiWebServerRedirectUrl

      public void setAuiWebServerRedirectUrl(String auiWebServerRedirectUrl)
      Sets the redirect URL used by the Admin UI web server.
      Parameters:
      auiWebServerRedirectUrl - the redirect URL to use for the Admin UI web server; may be null to clear the value

    • getAuiWebServerFrontChannelLogoutUrl

      public String getAuiWebServerFrontChannelLogoutUrl()
      Gets the Admin UI web server front-channel logout URL.
      Returns:
      the front-channel logout URL for the Admin UI web server, or null if not configured

    • setAuiWebServerFrontChannelLogoutUrl

      public void setAuiWebServerFrontChannelLogoutUrl(String auiWebServerFrontChannelLogoutUrl)
      Sets the Admin UI Web Server front-channel logout URL.
      Parameters:
      auiWebServerFrontChannelLogoutUrl - the front-channel logout URL to use for the Admin UI web server

    • getAuiWebServerPostLogoutRedirectUri

      public String getAuiWebServerPostLogoutRedirectUri()
      Gets the post-logout redirect URI configured for the Admin UI web server.
      Returns:
      the post-logout redirect URI, or null if not set

    • setAuiWebServerPostLogoutRedirectUri

      public void setAuiWebServerPostLogoutRedirectUri(String auiWebServerPostLogoutRedirectUri)
      Sets the Admin UI web server's post-logout redirect URI.
      Parameters:
      auiWebServerPostLogoutRedirectUri - the URI to which the Admin UI web server will redirect after logout

    • getAuiWebServerAuthzBaseUrl

      public String getAuiWebServerAuthzBaseUrl()
      Authorization server base URL used by the Admin UI web server to initiate authorization requests.
      Returns:
      the Admin UI web server's authorization base URL, or null if not set

    • setAuiWebServerAuthzBaseUrl

      public void setAuiWebServerAuthzBaseUrl(String auiWebServerAuthzBaseUrl)
      Set the Admin UI web server authorization base URL.
      Parameters:
      auiWebServerAuthzBaseUrl - the authorization server base URL used by the Admin UI web server

    • getAuiWebServerTokenEndpoint

      public String getAuiWebServerTokenEndpoint()
      Gets the token endpoint URL used by the Admin UI web server.
      Returns:
      the token endpoint URL for the Admin UI web server, or null if not set

    • setAuiWebServerTokenEndpoint

      public void setAuiWebServerTokenEndpoint(String auiWebServerTokenEndpoint)
      Set the Admin UI web server token endpoint URL.
      Parameters:
      auiWebServerTokenEndpoint - the token endpoint URL for the Admin UI web server; may be null to unset

    • getAuiWebServerIntrospectionEndpoint

      public String getAuiWebServerIntrospectionEndpoint()
      Gets the introspection endpoint URL for the Admin UI web server.
      Returns:
      the introspection endpoint URL for the Admin UI web server, or null if not set

    • setAuiWebServerIntrospectionEndpoint

      public void setAuiWebServerIntrospectionEndpoint(String auiWebServerIntrospectionEndpoint)
      Set the Admin UI web server introspection endpoint URL.
      Parameters:
      auiWebServerIntrospectionEndpoint - the introspection endpoint URL for the Admin UI web server

    • getAuiWebServerUserInfoEndpoint

      public String getAuiWebServerUserInfoEndpoint()
      Retrieves the Admin UI web server UserInfo endpoint URL.
      Returns:
      the UserInfo endpoint URL for the Admin UI web server, or null if not set.

    • setAuiWebServerUserInfoEndpoint

      public void setAuiWebServerUserInfoEndpoint(String auiWebServerUserInfoEndpoint)
      Set the Admin UI Web server UserInfo endpoint URL.
      Parameters:
      auiWebServerUserInfoEndpoint - the URL of the UserInfo endpoint used by the Admin UI Web server

    • getAuiWebServerEndSessionEndpoint

      public String getAuiWebServerEndSessionEndpoint()
      End-session endpoint URL for the Admin UI web server.
      Returns:
      the end-session endpoint URL used by the Admin UI web server, or null if not set

    • setAuiWebServerEndSessionEndpoint

      public void setAuiWebServerEndSessionEndpoint(String auiWebServerEndSessionEndpoint)
      Sets the Admin UI web server end-session endpoint URL.
      Parameters:
      auiWebServerEndSessionEndpoint - the end-session endpoint URL for the Admin UI web server; may be null to unset

    • getAuiBackendApiServerClientId

      public String getAuiBackendApiServerClientId()
      Client identifier used by the Admin UI backend API server.
      Returns:
      the client identifier for the Admin UI backend API server, or `null` if not set

    • setAuiBackendApiServerClientId

      public void setAuiBackendApiServerClientId(String auiBackendApiServerClientId)
      Sets the client identifier used by the Admin UI backend API server.
      Parameters:
      auiBackendApiServerClientId - the client ID for the Admin UI backend API server

    • getAuiBackendApiServerClientSecret

      public String getAuiBackendApiServerClientSecret()
      Client secret for the Admin UI backend API server.
      Returns:
      the client secret, or null if not set

    • setAuiBackendApiServerClientSecret

      public void setAuiBackendApiServerClientSecret(String auiBackendApiServerClientSecret)
      Sets the client secret used by the Admin UI Backend API server.
      Parameters:
      auiBackendApiServerClientSecret - the client secret for the backend API server

    • getAuiBackendApiServerScope

      public String getAuiBackendApiServerScope()
      Get the OAuth2 scope configured for the Admin UI backend API server.
      Returns:
      the scope string used by the backend API server, or null if not set

    • setAuiBackendApiServerScope

      public void setAuiBackendApiServerScope(String auiBackendApiServerScope)
      Sets the OAuth2 scope string used by the Admin UI Backend API server.
      Parameters:
      auiBackendApiServerScope - the scope value to use when requesting tokens from the backend API server

    • getAuiBackendApiServerAcrValues

      public String getAuiBackendApiServerAcrValues()
      Gets the ACR values used by the Admin UI backend API server.
      Returns:
      the ACR values for the Admin UI backend API server, or null if not set

    • setAuiBackendApiServerAcrValues

      public void setAuiBackendApiServerAcrValues(String auiBackendApiServerAcrValues)
      Set the AUI Backend API server ACR values requested during authentication.
      Parameters:
      auiBackendApiServerAcrValues - space-separated ACR (Authentication Context Class Reference) values to request from the backend API server, or null to clear.

    • getAuiBackendApiServerRedirectUrl

      public String getAuiBackendApiServerRedirectUrl()
      Returns the redirect URL configured for the Admin UI backend API server.
      Returns:
      the redirect URL for the Admin UI backend API server, or null if not set

    • setAuiBackendApiServerRedirectUrl

      public void setAuiBackendApiServerRedirectUrl(String auiBackendApiServerRedirectUrl)
      Set the redirect URL used by the Admin UI backend API server.
      Parameters:
      auiBackendApiServerRedirectUrl - the redirect URL for the Admin UI backend API server

    • getAuiBackendApiServerFrontChannelLogoutUrl

      public String getAuiBackendApiServerFrontChannelLogoutUrl()
      Gets the Admin UI Backend API server front-channel logout URL.
      Returns:
      the front-channel logout URL for the Admin UI Backend API server, or null if not set.

    • setAuiBackendApiServerFrontChannelLogoutUrl

      public void setAuiBackendApiServerFrontChannelLogoutUrl(String auiBackendApiServerFrontChannelLogoutUrl)
      Set the Admin UI backend API server front-channel logout URL.
      Parameters:
      auiBackendApiServerFrontChannelLogoutUrl - the front-channel logout URL for the Admin UI backend API server, or `null` to unset it

    • getAuiBackendApiServerPostLogoutRedirectUri

      public String getAuiBackendApiServerPostLogoutRedirectUri()
      Post-logout redirect URI for the Admin UI backend API server.
      Returns:
      the post-logout redirect URI for the Admin UI backend API server, or null if not set

    • setAuiBackendApiServerPostLogoutRedirectUri

      public void setAuiBackendApiServerPostLogoutRedirectUri(String auiBackendApiServerPostLogoutRedirectUri)
      Set the Admin UI backend API server post-logout redirect URI.
      Parameters:
      auiBackendApiServerPostLogoutRedirectUri - the post-logout redirect URI to use for the Admin UI backend API server

    • getAuiBackendApiServerAuthzBaseUrl

      public String getAuiBackendApiServerAuthzBaseUrl()
      Gets the authorization base URL for the Admin UI backend API server.
      Returns:
      the authorization base URL for the Admin UI backend API server, or `null` if not set

    • setAuiBackendApiServerAuthzBaseUrl

      public void setAuiBackendApiServerAuthzBaseUrl(String auiBackendApiServerAuthzBaseUrl)
      Sets the authorization server base URL used by the Admin UI backend API server.
      Parameters:
      auiBackendApiServerAuthzBaseUrl - the base authorization URL

    • getAuiBackendApiServerTokenEndpoint

      public String getAuiBackendApiServerTokenEndpoint()
      Token endpoint URL for the Admin UI backend API server.
      Returns:
      the token endpoint URL for the Admin UI backend API server, or null if not configured

    • setAuiBackendApiServerTokenEndpoint

      public void setAuiBackendApiServerTokenEndpoint(String auiBackendApiServerTokenEndpoint)
      Set the token endpoint URL for the Admin UI backend API server.
      Parameters:
      auiBackendApiServerTokenEndpoint - the token endpoint URL

    • getAuiBackendApiServerIntrospectionEndpoint

      public String getAuiBackendApiServerIntrospectionEndpoint()
      Provides the introspection endpoint URL for the Admin UI backend API server.
      Returns:
      the introspection endpoint URL, or null if not set

    • setAuiBackendApiServerIntrospectionEndpoint

      public void setAuiBackendApiServerIntrospectionEndpoint(String auiBackendApiServerIntrospectionEndpoint)
      Sets the introspection endpoint URL used by the Admin UI backend API server.
      Parameters:
      auiBackendApiServerIntrospectionEndpoint - the introspection endpoint URL, or null to clear it

    • getAuiBackendApiServerUserInfoEndpoint

      public String getAuiBackendApiServerUserInfoEndpoint()
      Retrieves the Admin UI backend API server UserInfo endpoint URL.
      Returns:
      the UserInfo endpoint URL for the Admin UI backend API server, or null if not configured

    • setAuiBackendApiServerUserInfoEndpoint

      public void setAuiBackendApiServerUserInfoEndpoint(String auiBackendApiServerUserInfoEndpoint)
      Set the Admin UI backend API server UserInfo endpoint URL.
      Parameters:
      auiBackendApiServerUserInfoEndpoint - the URL of the backend API server's UserInfo endpoint, or `null` to clear it

    • getAuiBackendApiServerEndSessionEndpoint

      public String getAuiBackendApiServerEndSessionEndpoint()
      Gets the Admin UI backend API server end-session endpoint URL.
      Returns:
      the end-session endpoint URL for the Admin UI backend API server, or null if not set

    • setAuiBackendApiServerEndSessionEndpoint

      public void setAuiBackendApiServerEndSessionEndpoint(String auiBackendApiServerEndSessionEndpoint)
      Sets the Admin UI Backend API server end-session endpoint URL.
      Parameters:
      auiBackendApiServerEndSessionEndpoint - the end-session endpoint URL used by the Admin UI backend API

    • getLicenseConfiguration

      public LicenseConfiguration getLicenseConfiguration()
      Retrieves the license configuration for the Admin UI.
      Returns:
      the LicenseConfiguration instance, or null if not set

    • setLicenseConfiguration

      public void setLicenseConfiguration(LicenseConfiguration licenseConfiguration)
      Sets the license configuration used by the Admin UI.
      Parameters:
      licenseConfiguration - the license configuration to apply

    • getAllowSmtpKeystoreEdit

      public Boolean getAllowSmtpKeystoreEdit()
      Gets whether editing the SMTP keystore is allowed.
      Returns:
      `true` if SMTP keystore editing is allowed, `false` if it is disallowed, or `null` if unset.

    • setAllowSmtpKeystoreEdit

      public void setAllowSmtpKeystoreEdit(Boolean allowSmtpKeystoreEdit)
      Set whether editing the SMTP keystore is allowed.
      Parameters:
      allowSmtpKeystoreEdit - `true` to allow SMTP keystore edits, `false` to disallow; may be `null` to unset the value

    • getCedarlingLogType

      public CedarlingLogType getCedarlingLogType()
      Gets the configured Cedarling logging type.
      Returns:
      the configured CedarlingLogType, or null if none is set

    • setCedarlingLogType

      public void setCedarlingLogType(CedarlingLogType cedarlingLogType)
      Sets the Cedarling logging type for this configuration.
      Parameters:
      cedarlingLogType - the CedarlingLogType to apply; may be null to unset the value

    • toString

      public String toString()
      Produce a string representation of this AUIConfiguration containing all configuration fields and their current values.
      Overrides:
      toString in class Object
      Returns:
      a string containing each field name and its current value for this configuration instance