org.springframework.boot.cloud

Enum CloudPlatform

  • All Implemented Interfaces:
    Serializable, Comparable<CloudPlatform>

    public enum CloudPlatform
extends Enum<CloudPlatform>
    Simple detection for well known cloud platforms. For more advanced cloud provider integration consider the Spring Cloud project.
    Since:
    1.3.0
    Author:
    Phillip Webb
    See Also:
    "https://cloud.spring.io"

    • Enum Constant Detail

      • CLOUD_FOUNDRY

        public static final CloudPlatform CLOUD_FOUNDRY
        Cloud Foundry platform.

      • HEROKU

        public static final CloudPlatform HEROKU
        Heroku platform.

      • KUBERNETES

        public static final CloudPlatform KUBERNETES
        Kubernetes platform.

    • Method Detail

      • values

        public static CloudPlatform[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (CloudPlatform c : CloudPlatform.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CloudPlatform valueOf(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • isActive

        public abstract boolean isActive(org.springframework.core.env.Environment environment)
        Determines if the platform is active (i.e. the application is running in it).
        Parameters:
        environment - the environment
        Returns:
        if the platform is active.

      • isUsingForwardHeaders

        public boolean isUsingForwardHeaders()
        Returns if the platform is behind a load balancer and uses X-Forwarded-For headers.
        Returns:
        if X-Forwarded-For headers are used

      • getActive

        public static CloudPlatform getActive(org.springframework.core.env.Environment environment)
        Returns the active CloudPlatform or null if one cannot be deduced.
        Parameters:
        environment - the environment
        Returns:
        the CloudPlatform or null

Copyright © 2020 Pivotal Software, Inc.. All rights reserved.