com.bose.aem.spring.config.ConfigClientProperties.java Source code

Introduction

Here is the source code for com.bose.aem.spring.config.ConfigClientProperties.java

Source

/*
 * Copyright 2013-2014 the original author or authors.
 *
 * 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.bose.aem.spring.config;

import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.core.env.Environment;
import org.springframework.util.StringUtils;
import org.springframework.web.util.UriComponentsBuilder;

import java.net.MalformedURLException;
import java.net.URL;

/**
 * @author Dave Syer
 *
 */
public class ConfigClientProperties {

    public static final String PREFIX = "spring.cloud.config";

    /**
     * Flag to say that remote configuration is enabled. Default true;
     */
    private boolean enabled = true;

    /**
     * The default profile to use when fetching remote configuration (comma-separated).
     * Default is "default".
     */
    private String profile = "default";

    @Value("${spring.application.name:application}")
    private String name;

    /**
     * The label name to use to pull remote configuration properties. The default is set
     * on the server (generally "master" for a git based server).
     */
    private String label;

    /**
     * The username to use (HTTP Basic) when contacting the remote server.
     */
    private String username;

    /**
     * The password to use (HTTP Basic) when contacting the remote server.
     */
    private String password;

    /**
     * The URI of the remote server (default http://localhost:8888).
     */
    private String uri = "http://localhost:8888";

    /**
     * Discovery properties.
     */
    private Discovery discovery = new Discovery();

    /**
     * Flag to indicate that failure to connect to the server is fatal (default false).
     */
    private boolean failFast = false;

    private ConfigClientProperties() {
    }

    public ConfigClientProperties(Environment environment) {
        String[] profiles = environment.getActiveProfiles();
        if (profiles.length == 0) {
            profiles = environment.getDefaultProfiles();
        }
        this.setProfile(StringUtils.arrayToCommaDelimitedString(profiles));
    }

    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    public String getRawUri() {
        return extractCredentials()[2];
    }

    public String getUri() {
        return uri;
    }

    public void setUri(String url) {
        this.uri = url;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getProfile() {
        return profile;
    }

    public void setProfile(String env) {
        this.profile = env;
    }

    public String getLabel() {
        return label;
    }

    public void setLabel(String label) {
        this.label = label;
    }

    public String getUsername() {
        return extractCredentials()[0];
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return extractCredentials()[1];
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public Discovery getDiscovery() {
        return discovery;
    }

    public void setDiscovery(Discovery discovery) {
        this.discovery = discovery;
    }

    public boolean isFailFast() {
        return failFast;
    }

    public void setFailFast(boolean failFast) {
        this.failFast = failFast;
    }

    private String[] extractCredentials() {
        String[] result = new String[3];
        String uri = this.uri;
        result[2] = uri;
        String[] creds = getUsernamePassword();
        result[0] = creds[0];
        result[1] = creds[1];
        try {
            URL url = new URL(uri);
            String userInfo = url.getUserInfo();
            if (StringUtils.isEmpty(userInfo) || ":".equals(userInfo)) {
                return result;
            }
            String bare = UriComponentsBuilder.fromHttpUrl(uri).userInfo(null).build().toUriString();
            result[2] = bare;
            if (!userInfo.contains(":")) {
                userInfo = userInfo + ":";
            }
            String[] split = userInfo.split(":");
            result[0] = split[0];
            result[1] = split[1];
            if (creds[1] != null) {
                // Explicit username / password takes precedence
                result[1] = creds[1];
                if ("user".equals(creds[0])) {
                    // But the username can be overridden
                    result[0] = split[0];
                }
            }
            return result;
        } catch (MalformedURLException e) {
            throw new IllegalStateException("Invalid URL: " + uri);
        }
    }

    private String[] getUsernamePassword() {
        if (StringUtils.hasText(password)) {
            return new String[] { StringUtils.hasText(username) ? username.trim() : "user", password.trim() };
        }
        return new String[2];
    }

    public static class Discovery {
        public static final String DEFAULT_CONFIG_SERVER = "CONFIGSERVER";

        private boolean enabled;
        private String serviceId = DEFAULT_CONFIG_SERVER;

        public boolean isEnabled() {
            return enabled;
        }

        public void setEnabled(boolean enabled) {
            this.enabled = enabled;
        }

        public String getServiceId() {
            return serviceId;
        }

        public void setServiceId(String serviceId) {
            this.serviceId = serviceId;
        }

    }

    public ConfigClientProperties override(Environment environment) {
        ConfigClientProperties override = new ConfigClientProperties();
        BeanUtils.copyProperties(this, override);
        override.setName(environment.resolvePlaceholders(
                "${" + ConfigClientProperties.PREFIX + ".name:${spring.application.name:application}}"));
        if (environment.containsProperty(ConfigClientProperties.PREFIX + ".profile")) {
            override.setProfile(environment.getProperty(ConfigClientProperties.PREFIX + ".profile"));
        }
        if (environment.containsProperty(ConfigClientProperties.PREFIX + ".label")) {
            override.setLabel(environment.getProperty(ConfigClientProperties.PREFIX + ".label"));
        }
        return override;
    }

    @Override
    public String toString() {
        return "ConfigClientProperties [enabled=" + enabled + ", profile=" + profile + ", name=" + name + ", label="
                + (label == null ? "" : label) + ", username=" + username + ", password=" + password + ", uri="
                + uri + ", discovery.enabled=" + discovery.enabled + ", failFast=" + failFast + "]";
    }

}