Package app.kntrl.client.openapi.model

Class ShAppCfg

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class ShAppCfg
extends java.lang.Object
    ShAppCfg

    • Field Detail

      • SERIALIZED_NAME_HTTP

        public static final java.lang.String SERIALIZED_NAME_HTTP
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_LOGINS

        public static final java.lang.String SERIALIZED_NAME_LOGINS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_LOGIN_REQUIREMENTS

        public static final java.lang.String SERIALIZED_NAME_LOGIN_REQUIREMENTS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_AUTHS

        public static final java.lang.String SERIALIZED_NAME_AUTHS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ENTRIES

        public static final java.lang.String SERIALIZED_NAME_ENTRIES
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_DB

        public static final java.lang.String SERIALIZED_NAME_DB
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_TOKEN

        public static final java.lang.String SERIALIZED_NAME_TOKEN
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_RATE_LIMITERS

        public static final java.lang.String SERIALIZED_NAME_RATE_LIMITERS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SECRET

        public static final java.lang.String SERIALIZED_NAME_SECRET
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_HEALTH_CHECK_KEY

        public static final java.lang.String SERIALIZED_NAME_HEALTH_CHECK_KEY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_I18N

        public static final java.lang.String SERIALIZED_NAME_I18N
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_$_SCHEMA

        public static final java.lang.String SERIALIZED_NAME_$_SCHEMA
        See Also:
        Constant Field Values

      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields

      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields

    • Constructor Detail

      • ShAppCfg

        public ShAppCfg()

    • Method Detail

      • getHttp

        @Nullable
public ShHttpCfg getHttp()
        Get http
        Returns:
        http

      • setHttp

        public void setHttp​(ShHttpCfg http)

      • logins

        public ShAppCfg logins​(java.util.List<java.lang.String> logins)

      • addLoginsItem

        public ShAppCfg addLoginsItem​(java.lang.String loginsItem)

      • getLogins

        @Nullable
public java.util.List<java.lang.String> getLogins()
        Types of logins that can be used for identification. If the login type is not specified in the auth config - it will be considered a simple login: the user can set any name. E.g. username. If the login type is specified in the auth config, this login will be generated by the corresponding authenticator. E.g. email, phone or facebook account id.
        Returns:
        logins

      • setLogins

        public void setLogins​(java.util.List<java.lang.String> logins)

      • loginRequirements

        public ShAppCfg loginRequirements​(java.util.Map<java.lang.String,​java.lang.String> loginRequirements)

      • putLoginRequirementsItem

        public ShAppCfg putLoginRequirementsItem​(java.lang.String key,
                                         java.lang.String loginRequirementsItem)

      • getLoginRequirements

        @Nullable
public java.util.Map<java.lang.String,​java.lang.String> getLoginRequirements()
        Regexes to validate logins.
        Returns:
        loginRequirements

      • setLoginRequirements

        public void setLoginRequirements​(java.util.Map<java.lang.String,​java.lang.String> loginRequirements)

      • getAuths

        @Nullable
public java.util.Map<java.lang.String,​ShAppCfgAuthsValue> getAuths()
        List of auth names and auth configs To use builtin auths (not a plugin or remote) follow the example: - `\"password\": { ... }` or - `\"anyAuthName\": { \"builtin\": \"password\", ... }` Available built-in auths: - `password`, `email`, `questions`, `ip`, 'totp' - (OAuth2 client) `oauth`, `oauth/facebook/openid`, `oauth/google/openid` - (Backend integration) `appSecret` - (OAuth2 server) 'authorizationCode', 'oauthApp', 'scopes'
        Returns:
        auths

      • setAuths

        public void setAuths​(java.util.Map<java.lang.String,​ShAppCfgAuthsValue> auths)

      • entries

        public ShAppCfg entries​(java.util.Map<java.lang.String,​EntryCfg> entries)

      • putEntriesItem

        public ShAppCfg putEntriesItem​(java.lang.String key,
                               EntryCfg entriesItem)

      • getEntries

        @Nullable
public java.util.Map<java.lang.String,​EntryCfg> getEntries()
        List of app entries. Entry usually represents UI used for signing in/up or additional authentication before action. E.g.: - app: main entry that requests user login/email + password and 2fa (if enabled) - api: entry that allows user to generate API keys and connect third-party app - action: additional authentication (e.g. code from sms) requested before e.g. payment
        Returns:
        entries

      • setEntries

        public void setEntries​(java.util.Map<java.lang.String,​EntryCfg> entries)

      • getDb

        @Nullable
public ShDbsCfg getDb()
        Get db
        Returns:
        db

      • setDb

        public void setDb​(ShDbsCfg db)

      • getToken

        @Nullable
public TokenCfg getToken()
        Get token
        Returns:
        token

      • setToken

        public void setToken​(TokenCfg token)

      • rateLimiters

        public ShAppCfg rateLimiters​(java.util.Map<java.lang.String,​RateLimiterCfg> rateLimiters)

      • putRateLimitersItem

        public ShAppCfg putRateLimitersItem​(java.lang.String key,
                                    RateLimiterCfg rateLimitersItem)

      • getRateLimiters

        @Nullable
public java.util.Map<java.lang.String,​RateLimiterCfg> getRateLimiters()
        List of rate limiters
        Returns:
        rateLimiters

      • setRateLimiters

        public void setRateLimiters​(java.util.Map<java.lang.String,​RateLimiterCfg> rateLimiters)

      • secret

        public ShAppCfg secret​(java.lang.String secret)

      • getSecret

        @Nullable
public java.lang.String getSecret()
        The key that app uses for RSA certificate generation used for token signature. If `null` - app will generate secret automatically during startup.
        Returns:
        secret

      • setSecret

        public void setSecret​(java.lang.String secret)

      • healthCheckKey

        public ShAppCfg healthCheckKey​(java.lang.String healthCheckKey)

      • getHealthCheckKey

        @Nullable
public java.lang.String getHealthCheckKey()
        Set this key if you want to restrict access to the health-check.
        Returns:
        healthCheckKey

      • setHealthCheckKey

        public void setHealthCheckKey​(java.lang.String healthCheckKey)

      • getI18n

        @Nullable
public I18nCfg getI18n()
        Get i18n
        Returns:
        i18n

      • setI18n

        public void setI18n​(I18nCfg i18n)

      • $schema

        public ShAppCfg $schema​(java.lang.String $schema)

      • get$Schema

        @Nullable
public java.lang.String get$Schema()
        Get $schema
        Returns:
        $schema

      • set$Schema

        public void set$Schema​(java.lang.String $schema)

      • putAdditionalProperty

        public ShAppCfg putAdditionalProperty​(java.lang.String key,
                                      java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        java.io.IOException - if the JSON Object is invalid with respect to ShAppCfg

      • fromJson

        public static ShAppCfg fromJson​(java.lang.String jsonString)
                         throws java.io.IOException
        Create an instance of ShAppCfg given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of ShAppCfg
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to ShAppCfg

      • toJson

        public java.lang.String toJson()
        Convert an instance of ShAppCfg to an JSON string
        Returns:
        JSON string