io.pivotal.spring.cloud.service.eureka.EurekaInstanceAutoConfiguration.java Source code

Java tutorial

Introduction

Here is the source code for io.pivotal.spring.cloud.service.eureka.EurekaInstanceAutoConfiguration.java

Source

/*
 * Copyright 2015-2016 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 io.pivotal.spring.cloud.service.eureka;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
import org.springframework.cloud.commons.util.InetUtils;
import org.springframework.cloud.commons.util.InetUtilsProperties;
import org.springframework.cloud.netflix.eureka.EurekaInstanceConfigBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.StringUtils;

import java.net.URI;
import java.util.Map;
import java.util.logging.Logger;

/**
 * Configuration class to configure a Eureka instance's settings based on the
 * value of <code>spring.cloud.services.registrationMethod</code>. "route" will
 * register vcap.application.uris[0] while "direct" will register using the container IP address
 * and PORT environment variable. The default behaviour is "route".<br>
 * <br>
 * Any defined eureka.instance.* property will override those set by this
 * auto-configuration.
 *
 * @author Chris Schaefer
 * @author Will Tran
 */
@Configuration
@ConditionalOnClass(EurekaInstanceConfigBean.class)
@ConditionalOnExpression("'${vcap.application.uris[0]:}'!='' || '${cf.instance.ip:}'!=''")
public class EurekaInstanceAutoConfiguration {

    private static Logger LOGGER = Logger.getLogger(EurekaInstanceAutoConfiguration.class.getName());

    private static final String UNKNOWN_ZONE = "unknown";
    private static final String INDETERMINATE_EUREKA_ZONE_MESSAGE = "Eureka zone could not be determined from %s=\"%s\". Using \"%s\".";
    private static final String DEFAULT_ZONE_PROPERTY = "eureka.client.serviceUrl.defaultZone";
    private static final String ROUTE_REGISTRATION_METHOD = "route";
    private static final String DIRECT_REGISTRATION_METHOD = "direct";
    private static final String INSTANCE_ID = "instanceId";
    private static final String ZONE = "zone";

    @Value("${vcap.application.uris[0]:}")
    private String hostname;

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

    @Value("${vcap.application.application_id:}")
    private String cfAppGuid;

    @Value("${cf.instance.index:}")
    private String cfInstanceIndex;

    @Value("${cf.instance.internal.ip:}")
    private String ip;

    @Value("${port:-1}")
    private int port;

    @Value("${vcap.application.instance_id:${random.value}}")
    private String instanceId;

    @Value("${spring.cloud.services.registrationMethod:route}")
    private String registrationMethod;

    @Value("${" + DEFAULT_ZONE_PROPERTY + ":}")
    private String zoneUri;

    @Bean
    public VirtualHostNamesBean getVirtualHostNames() {
        return new VirtualHostNamesBean();
    }

    @Bean
    public EurekaInstanceConfigBean eurekaInstanceConfigBean() {
        if (!StringUtils.isEmpty(registrationMethod)) {
            LOGGER.info("Eureka registration method: " + registrationMethod);

            if (ROUTE_REGISTRATION_METHOD.equals(registrationMethod)) {
                return getRouteRegistration();
            }

            if (DIRECT_REGISTRATION_METHOD.equals(registrationMethod)) {
                return getDirectRegistration();
            }
        }

        return getDefaultRegistration();
    }

    @Bean
    public SurgicalRoutingRequestTransformer surgicalRoutingLoadBalancerRequestTransformer() {
        return new SurgicalRoutingRequestTransformer();
    }

    private SanitizingEurekaInstanceConfigBean getRouteRegistration() {
        SanitizingEurekaInstanceConfigBean eurekaInstanceConfigBean = getDefaults();
        eurekaInstanceConfigBean.setSecurePortEnabled(true);
        eurekaInstanceConfigBean.setInstanceId(hostname + ":" + instanceId);
        return eurekaInstanceConfigBean;
    }

    private SanitizingEurekaInstanceConfigBean getDirectRegistration() {
        SanitizingEurekaInstanceConfigBean eurekaInstanceConfigBean = getDefaults();
        eurekaInstanceConfigBean.setPreferIpAddress(true);
        eurekaInstanceConfigBean.setNonSecurePort(port);
        eurekaInstanceConfigBean.setInstanceId(ip + ":" + instanceId);
        return eurekaInstanceConfigBean;
    }

    private SanitizingEurekaInstanceConfigBean getDefaults() {
        InetUtilsProperties inetUtilsProperties = new InetUtilsProperties();
        inetUtilsProperties.setDefaultHostname(hostname);
        inetUtilsProperties.setDefaultIpAddress(ip);

        SanitizingEurekaInstanceConfigBean eurekaInstanceConfigBean = new SanitizingEurekaInstanceConfigBean(
                new InetUtils(inetUtilsProperties));
        eurekaInstanceConfigBean.setHostname(hostname);
        eurekaInstanceConfigBean.setIpAddress(ip);
        Map<String, String> metadataMap = eurekaInstanceConfigBean.getMetadataMap();
        metadataMap.put(SurgicalRoutingRequestTransformer.CF_APP_GUID, cfAppGuid);
        metadataMap.put(SurgicalRoutingRequestTransformer.CF_INSTANCE_INDEX, cfInstanceIndex);
        metadataMap.put(INSTANCE_ID, instanceId);
        metadataMap.put(ZONE, zoneFromUri(zoneUri));

        return eurekaInstanceConfigBean;
    }

    private static String zoneFromUri(String defaultZoneUri) {
        String hostname = null;
        try {
            hostname = new URI(defaultZoneUri).getHost();
        } catch (Exception e) {
            LOGGER.warning(String.format(INDETERMINATE_EUREKA_ZONE_MESSAGE + " %s", DEFAULT_ZONE_PROPERTY,
                    defaultZoneUri, UNKNOWN_ZONE, e));
            return UNKNOWN_ZONE;
        }
        if (hostname == null || !hostname.contains(".")) {
            LOGGER.warning(String.format(INDETERMINATE_EUREKA_ZONE_MESSAGE, DEFAULT_ZONE_PROPERTY, defaultZoneUri,
                    UNKNOWN_ZONE));
            return UNKNOWN_ZONE;
        }
        return hostname.substring(hostname.indexOf(".") + 1);
    }

    private SanitizingEurekaInstanceConfigBean getDefaultRegistration() {
        LOGGER.info("Eureka registration method not provided, defaulting to route");
        return getRouteRegistration();
    }

    void setHostname(String hostname) {
        this.hostname = hostname;
    }

    void setCfAppGuid(String cfAppGuid) {
        this.cfAppGuid = cfAppGuid;
    }

    void setCfInstanceIndex(String cfInstanceIndex) {
        this.cfInstanceIndex = cfInstanceIndex;
    }

    void setIp(String ip) {
        this.ip = ip;
    }

    void setPort(int port) {
        this.port = port;
    }

    void setInstanceId(String instanceId) {
        this.instanceId = instanceId;
    }

    void setRegistrationMethod(String registrationMethod) {
        this.registrationMethod = registrationMethod;
    }

    void setZoneUri(String zoneUri) {
        this.zoneUri = zoneUri;
    }

}