Package org.springframework.security.config.oauth2.client

Enum CommonOAuth2Provider

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CommonOAuth2Provider>
    public enum CommonOAuth2Provider
extends java.lang.Enum<CommonOAuth2Provider>
    Common OAuth2 Providers that can be used to create builders pre-configured with sensible defaults.
    Since:
    5.0

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract org.springframework.security.oauth2.client.registration.ClientRegistration.Builder getBuilder​(java.lang.String registrationId)
      Create a new ClientRegistration.Builder pre-configured with provider defaults.
      protected org.springframework.security.oauth2.client.registration.ClientRegistration.Builder getBuilder​(java.lang.String registrationId, org.springframework.security.oauth2.core.ClientAuthenticationMethod method, java.lang.String redirectUri)  
      static CommonOAuth2Provider valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CommonOAuth2Provider[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static CommonOAuth2Provider[] 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 (CommonOAuth2Provider c : CommonOAuth2Provider.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CommonOAuth2Provider valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getBuilder

        protected final org.springframework.security.oauth2.client.registration.ClientRegistration.Builder getBuilder​(java.lang.String registrationId,
                                                                                                              org.springframework.security.oauth2.core.ClientAuthenticationMethod method,
                                                                                                              java.lang.String redirectUri)

      • getBuilder

        public abstract org.springframework.security.oauth2.client.registration.ClientRegistration.Builder getBuilder​(java.lang.String registrationId)
        Create a new ClientRegistration.Builder pre-configured with provider defaults.
        Parameters:
        registrationId - the registration-id used with the new builder
        Returns:
        a builder instance