Class OAuth2Defaults

    • Method Detail

      • hasOauthScopes

        public final boolean hasOauthScopes()
        For responses, this returns true if the service returned a value for the OauthScopes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • oauthScopes

        public final List<String> oauthScopes()

        OAuth 2.0 scopes that the connector supports.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOauthScopes() method.

        Returns:
        OAuth 2.0 scopes that the connector supports.
      • hasTokenUrls

        public final boolean hasTokenUrls()
        For responses, this returns true if the service returned a value for the TokenUrls property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tokenUrls

        public final List<String> tokenUrls()

        Token URLs that can be used for OAuth 2.0 authentication.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTokenUrls() method.

        Returns:
        Token URLs that can be used for OAuth 2.0 authentication.
      • hasAuthCodeUrls

        public final boolean hasAuthCodeUrls()
        For responses, this returns true if the service returned a value for the AuthCodeUrls property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • authCodeUrls

        public final List<String> authCodeUrls()

        Auth code URLs that can be used for OAuth 2.0 authentication.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuthCodeUrls() method.

        Returns:
        Auth code URLs that can be used for OAuth 2.0 authentication.
      • oauth2GrantTypesSupported

        public final List<OAuth2GrantType> oauth2GrantTypesSupported()

        OAuth 2.0 grant types supported by the connector.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOauth2GrantTypesSupported() method.

        Returns:
        OAuth 2.0 grant types supported by the connector.
      • hasOauth2GrantTypesSupported

        public final boolean hasOauth2GrantTypesSupported()
        For responses, this returns true if the service returned a value for the Oauth2GrantTypesSupported property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • oauth2GrantTypesSupportedAsStrings

        public final List<String> oauth2GrantTypesSupportedAsStrings()

        OAuth 2.0 grant types supported by the connector.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOauth2GrantTypesSupported() method.

        Returns:
        OAuth 2.0 grant types supported by the connector.
      • hasOauth2CustomProperties

        public final boolean hasOauth2CustomProperties()
        For responses, this returns true if the service returned a value for the Oauth2CustomProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • oauth2CustomProperties

        public final List<OAuth2CustomParameter> oauth2CustomProperties()

        List of custom parameters required for OAuth 2.0 authentication.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOauth2CustomProperties() method.

        Returns:
        List of custom parameters required for OAuth 2.0 authentication.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)