Spring Framework

org.springframework.web.client
Class HttpStatusCodeException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by org.springframework.core.NestedRuntimeException
                  extended by org.springframework.web.client.RestClientException
                      extended by org.springframework.web.client.HttpStatusCodeException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
HttpClientErrorException, HttpServerErrorException

public abstract class HttpStatusCodeException
extends RestClientException

Abstract base class for exceptions based on an HttpStatus.

Since:
3.0
Author:
Arjen Poutsma, Chris Beams
See Also:
Serialized Form

Constructor Summary
protected HttpStatusCodeException(HttpStatus statusCode)
          Construct a new instance of HttpStatusCodeException based on a HttpStatus.
protected HttpStatusCodeException(HttpStatus statusCode, java.lang.String statusText)
          Construct a new instance of HttpStatusCodeException based on a HttpStatus and status text.
protected HttpStatusCodeException(HttpStatus statusCode, java.lang.String statusText, byte[] responseBody, java.nio.charset.Charset responseCharset)
          Construct a new instance of HttpStatusCodeException based on a HttpStatus, status text, and response body content.
 
Method Summary
 byte[] getResponseBodyAsByteArray()
          Returns the response body as a byte array.
 java.lang.String getResponseBodyAsString()
          Returns the response body as a string.
 HttpStatus getStatusCode()
          Returns the HTTP status code.
 java.lang.String getStatusText()
          Returns the HTTP status text.
 
Methods inherited from class org.springframework.core.NestedRuntimeException
contains, getMessage, getMostSpecificCause, getRootCause
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HttpStatusCodeException

protected HttpStatusCodeException(HttpStatus statusCode)
Construct a new instance of HttpStatusCodeException based on a HttpStatus.

Parameters:
statusCode - the status code

HttpStatusCodeException

protected HttpStatusCodeException(HttpStatus statusCode,
                                  java.lang.String statusText)
Construct a new instance of HttpStatusCodeException based on a HttpStatus and status text.

Parameters:
statusCode - the status code
statusText - the status text

HttpStatusCodeException

protected HttpStatusCodeException(HttpStatus statusCode,
                                  java.lang.String statusText,
                                  byte[] responseBody,
                                  java.nio.charset.Charset responseCharset)
Construct a new instance of HttpStatusCodeException based on a HttpStatus, status text, and response body content.

Parameters:
statusCode - the status code
statusText - the status text
responseBody - the response body content, may be null
responseCharset - the response body charset, may be null
Since:
3.0.5
Method Detail

getStatusCode

public HttpStatus getStatusCode()
Returns the HTTP status code.


getStatusText

public java.lang.String getStatusText()
Returns the HTTP status text.


getResponseBodyAsByteArray

public byte[] getResponseBodyAsByteArray()
Returns the response body as a byte array.

Since:
3.0.5

getResponseBodyAsString

public java.lang.String getResponseBodyAsString()
Returns the response body as a string.

Since:
3.0.5

Spring Framework