Package com.commercetools.api.models.error

Interface ExternalOAuthFailedError

All Superinterfaces:
ErrorObject
public interface ExternalOAuthFailedError extends ErrorObject

Returned when an external OAuth Introspection endpoint does not return a response within the time limit, or the response isn't compliant with RFC 7662 (for example, an HTTP status code like 500).

Example to create an instance using the builder pattern 

     ExternalOAuthFailedError externalOAuthFailedError = ExternalOAuthFailedError.builder()
             .message("{message}")
             .build()

  • Field Details

    • EXTERNAL_O_AUTH_FAILED

      static final String EXTERNAL_O_AUTH_FAILED
      discriminator value for ExternalOAuthFailedError
      See Also:

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()
      Description copied from interface: ErrorObject

      Error identifier.

      Specified by:
      getCode in interface ErrorObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      Plain text description detailing the external OAuth error. For example, "External OAuth did not respond in time.".

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • setMessage

      void setMessage(String message)

      Plain text description detailing the external OAuth error. For example, "External OAuth did not respond in time.".

      Specified by:
      setMessage in interface ErrorObject
      Parameters:
      message - value to be set

    • of

      static ExternalOAuthFailedError of()
      factory method
      Returns:
      instance of ExternalOAuthFailedError

    • of

      static ExternalOAuthFailedError of(ExternalOAuthFailedError template)
      factory method to create a shallow copy ExternalOAuthFailedError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ExternalOAuthFailedError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

      @Nullable static ExternalOAuthFailedError deepCopy(@Nullable ExternalOAuthFailedError template)
      factory method to create a deep copy of ExternalOAuthFailedError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ExternalOAuthFailedErrorBuilder builder()
      builder factory method for ExternalOAuthFailedError
      Returns:
      builder

    • builder

      static ExternalOAuthFailedErrorBuilder builder(ExternalOAuthFailedError template)
      create builder for ExternalOAuthFailedError instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withExternalOAuthFailedError

      default <T> T withExternalOAuthFailedError(Function<ExternalOAuthFailedError,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ExternalOAuthFailedError> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference