com.okta.sdk.impl.config.ClientConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Stormpath, Inc.
 * Modifications Copyright 2018 Okta, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.okta.sdk.impl.config;

import com.okta.commons.http.config.BaseUrlResolver;
import com.okta.commons.http.config.HttpClientConfiguration;
import com.okta.commons.lang.Strings;
import com.okta.sdk.cache.CacheConfigurationBuilder;
import com.okta.sdk.client.AuthenticationScheme;
import com.okta.sdk.client.AuthorizationMode;
import com.okta.sdk.impl.api.ClientCredentialsResolver;

import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.function.UnaryOperator;

/**
 * This class holds the default configuration properties.
 *
 * During application initialization all the properties found in the pre-defined locations that are
 * defined by the user will be added here in the order defined in {@link com.okta.sdk.impl.client.DefaultClientBuilder}.
 * Unset values will use default values from {@code com/okta/sdk/config/okta.yaml}.
 *
 * @since 0.5.0
 */
public class ClientConfiguration extends HttpClientConfiguration {

    private String apiToken;
    private ClientCredentialsResolver clientCredentialsResolver;
    private boolean cacheManagerEnabled;
    private long cacheManagerTtl;
    private long cacheManagerTti;
    private Map cacheManagerCaches = new LinkedHashMap<>();
    private AuthenticationScheme authenticationScheme;
    private BaseUrlResolver baseUrlResolver;
    private AuthorizationMode authorizationMode;
    private String clientId;
    private Set scopes = new HashSet<>();
    private String privateKey;
    private String oAuth2AccessToken;
    private String kid;
    private UnaryOperator jwtSigner;
    private String jwtSigningAlgorithm;

    public String getApiToken() {
        return apiToken;
    }

    public void setApiToken(String apiToken) {
        this.apiToken = apiToken;
    }

    public ClientCredentialsResolver getClientCredentialsResolver() {
        return clientCredentialsResolver;
    }

    public void setClientCredentialsResolver(ClientCredentialsResolver clientCredentialsResolver) {
        this.clientCredentialsResolver = clientCredentialsResolver;
    }

    public AuthenticationScheme getAuthenticationScheme() {
        return authenticationScheme;
    }

    public void setAuthenticationScheme(AuthenticationScheme authenticationScheme) {
        this.authenticationScheme = authenticationScheme;
    }

    public BaseUrlResolver getBaseUrlResolver() {
        return baseUrlResolver;
    }

    public void setBaseUrlResolver(BaseUrlResolver baseUrlResolver) {
        this.baseUrlResolver = baseUrlResolver;
    }

    public AuthorizationMode getAuthorizationMode() {
        return authorizationMode;
    }

    public void setAuthorizationMode(AuthorizationMode authorizationMode) {
        this.authorizationMode = authorizationMode;
    }

    public String getClientId() {
        return clientId;
    }

    public void setClientId(String clientId) {
        this.clientId = clientId;
    }

    public Set getScopes() {
        return scopes;
    }

    public void setScopes(Set scopes) {
        this.scopes = scopes;
    }

    public String getPrivateKey() {
        return privateKey;
    }

    public void setPrivateKey(String privateKey) {
        this.privateKey = privateKey;
    }

    public String getOAuth2AccessToken() {
        return oAuth2AccessToken;
    }

    public void setOAuth2AccessToken(String oAuth2AccessToken) {
        this.oAuth2AccessToken = oAuth2AccessToken;
    }

    public boolean isCacheManagerEnabled() {
        return cacheManagerEnabled;
    }

    public void setCacheManagerEnabled(boolean cacheManagerEnabled) {
        this.cacheManagerEnabled = cacheManagerEnabled;
    }

    public Map getCacheManagerCaches() {
        return cacheManagerCaches;
    }

    public void setCacheManagerCaches(Map cacheManagerCaches) {
        this.cacheManagerCaches = cacheManagerCaches;
    }

    public String getKid() {
        return kid;
    }

    public void setKid(String kid) {
        this.kid = kid;
    }

    public UnaryOperator getJwtSigner() {
        return jwtSigner;
    }

    public void setJwtSigner(UnaryOperator jwtSigner, String algorithm) {
        this.jwtSigner = jwtSigner;
        this.jwtSigningAlgorithm = algorithm;
    }

    public String getJwtSigningAlgorithm() {
        return jwtSigningAlgorithm;
    }

    public boolean hasCustomJwtSigner() {
        return jwtSigner != null && jwtSigningAlgorithm != null;
    }

    /**
     * Time to idle for cache manager in seconds
     * @return seconds until time to idle expires
     */
    public long getCacheManagerTti() {
        return cacheManagerTti;
    }

    /**
     * The cache manager's time to idle in seconds
     * @param cacheManagerTti the time to idle in seconds
     */
    public void setCacheManagerTti(long cacheManagerTti) {
        this.cacheManagerTti = cacheManagerTti;
    }

    /**
     * Time to live for cache manager in seconds
     * @return seconds until time to live expires
     */
    public long getCacheManagerTtl() {
        return cacheManagerTtl;
    }

    /**
     * The cache manager's time to live in seconds
     * @param cacheManagerTtl the time to live in seconds
     */
    public void setCacheManagerTtl(long cacheManagerTtl) {
        this.cacheManagerTtl = cacheManagerTtl;
    }

    @Override
    public String getBaseUrl() {
        String baseUrl = super.getBaseUrl();

        if (Strings.isEmpty(baseUrl) && baseUrlResolver != null) {
            baseUrl = baseUrlResolver.getBaseUrl();
        }

        return baseUrl;
    }

    @Override
    public String toString() {
        return "ClientConfiguration {cacheManagerTtl=" + cacheManagerTtl +
            ", cacheManagerTti=" + cacheManagerTti +
            ", cacheManagerCaches=" + cacheManagerCaches +
            ", baseUrl='" + getBaseUrl() + '\'' +
            ", authorizationMode=" + getAuthorizationMode() +
            ", clientId=" + getClientId() +
            ", scopes=" + getScopes() +
            ", privateKey=" + ((getPrivateKey() != null) ? "xxxxx" : null) +
            ", connectionTimeout=" + getConnectionTimeout() +
            ", requestAuthenticator=" + getRequestAuthenticator() +
            ", retryMaxElapsed=" + getRetryMaxElapsed() +
            ", retryMaxAttempts=" + getRetryMaxAttempts() +
            ", proxy=" + getProxy() +
            " }";
    }
}