GatewayErrorController (SMART COSMOS Gateway 3.1.0 API)

java.lang.Object
- net.smartcosmos.cluster.gateway.resource.GatewayErrorController

All Implemented Interfaces:: org.springframework.boot.autoconfigure.web.ErrorController

@RestController
 @ResponseBody
 @PreAuthorize(value="permitAll()")
public class GatewayErrorController
extends Object
implements org.springframework.boot.autoconfigure.web.ErrorController

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTR_ERROR_EXCEPTION`
`static String`	`ATTR_ERROR_MESSAGE`
`static String`	`ATTR_ERROR_STATUS_CODE`
`static String`	`ATTR_PROXY`
`static String`	`ATTR_SERVICE_ID`
`static String`	`ERROR_MESSAGE_GENERAL`
`static String`	`ERROR_MESSAGE_TIMEOUT`
`static String`	`ERROR_PATH`
`static String`	`ZUUL_REQUEST_URI`

Constructor Summary

Constructors
Constructor and Description

GatewayErrorController()

Constructors
Constructor and Description
`GatewayErrorController()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.springframework.http.ResponseEntity<?>`	`error()` Error handling method that evalutes the current `RequestContext` and extracts information on the request, matching routes and error or exceptions that occurred during routing.
`protected org.springframework.http.ResponseEntity`	`errorResponse(org.springframework.http.HttpStatus httpStatus, String message, String path)` Builds an `ResponseEntity` containing a `ErrorResponse` body to return JSON error responses.
`protected com.netflix.zuul.context.RequestContext`	`getCurrentContext()`
`protected String`	`getErrorMessageFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)`
`String`	`getErrorPath()`
`protected Exception`	`getExceptionFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)`
`protected org.springframework.http.HttpStatus`	`getHttpStatusFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)`
`protected String`	`getRequestUriFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)`
`protected String`	`getRouteFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)`
`protected String`	`getServiceIdFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)`
`protected boolean`	`isGatewayTimeout(Throwable throwable)` Checks if a given throwable matches any of the exception types that are expected to return a HTTP status code of 504 Gateway Timeout.
`protected boolean`	`isServiceUnavailable(Throwable throwable)` Checks if a given throwable matches any of the exception types that are expected to return a HTTP status code of 503 Service Unavailable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ERROR_PATH
```
public static final String ERROR_PATH
```
    See Also:
    
    Constant Field Values
  - ATTR_ERROR_EXCEPTION
```
public static final String ATTR_ERROR_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - ATTR_ERROR_MESSAGE
```
public static final String ATTR_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - ATTR_ERROR_STATUS_CODE
```
public static final String ATTR_ERROR_STATUS_CODE
```
    See Also:
    
    Constant Field Values
  - ATTR_PROXY
```
public static final String ATTR_PROXY
```
    See Also:
    
    Constant Field Values
  - ATTR_SERVICE_ID
```
public static final String ATTR_SERVICE_ID
```
    See Also:
    
    Constant Field Values
  - ZUUL_REQUEST_URI
```
public static final String ZUUL_REQUEST_URI
```
    See Also:
    
    Constant Field Values
  - ERROR_MESSAGE_GENERAL
```
public static final String ERROR_MESSAGE_GENERAL
```
    See Also:
    
    Constant Field Values
  - ERROR_MESSAGE_TIMEOUT
```
public static final String ERROR_MESSAGE_TIMEOUT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GatewayErrorController
```
public GatewayErrorController()
```
- Method Detail
  - error
```
@RequestMapping(value="/error")
public org.springframework.http.ResponseEntity<?> error()
```
    Error handling method that evalutes the current RequestContext and extracts information on the request, matching routes and error or exceptions that occurred during routing.
    
    It returns a ResponseEntity with an ErrorResponse body and one of these HTTP status codes, depending on the request context information:
    - 500 Internal Server Error
    - 503 Service Unavailable
    - 504 Gateway Timeout
    Returns:
    
    the response entity
  - isServiceUnavailable
```
protected boolean isServiceUnavailable(Throwable throwable)
```
    Checks if a given throwable matches any of the exception types that are expected to return a HTTP status code of 503 Service Unavailable.
    
    In case of encountering exceptions that should return this response instead of 500 Internal Server Error, they need to be added to this method.
    
    Parameters:
    
    throwable - the exception
    
    Returns:
    
    true if it's an exception type that should result in a 503 Service Unavailable HTTP status response
  - isGatewayTimeout
```
protected boolean isGatewayTimeout(Throwable throwable)
```
    Checks if a given throwable matches any of the exception types that are expected to return a HTTP status code of 504 Gateway Timeout.
    
    In case of encountering exceptions that should return this response instead of 500 Internal Server Error, they need to be added to this method.
    
    Parameters:
    
    throwable - the exception
    
    Returns:
    
    true if it's an exception type that should result in a 504 Gateway Timeout HTTP status response
  - errorResponse
```
protected org.springframework.http.ResponseEntity errorResponse(org.springframework.http.HttpStatus httpStatus,
                                                                String message,
                                                                String path)
```
    Builds an ResponseEntity containing a ErrorResponse body to return JSON error responses.
    
    Parameters:
    
    httpStatus - the HTTP status code to return
    
    message - the error message
    
    path - the request path where the error occurred
    
    Returns:
    
    the response entity
  - getRequestUriFromRequestContext
```
protected String getRequestUriFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)
```
  - getHttpStatusFromRequestContext
```
protected org.springframework.http.HttpStatus getHttpStatusFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)
```
  - getRouteFromRequestContext
```
protected String getRouteFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)
```
  - getServiceIdFromRequestContext
```
protected String getServiceIdFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)
```
  - getExceptionFromRequestContext
```
protected Exception getExceptionFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)
```
  - getErrorMessageFromRequestContext
```
protected String getErrorMessageFromRequestContext(com.netflix.zuul.context.RequestContext requestContext)
```
  - getCurrentContext
```
protected com.netflix.zuul.context.RequestContext getCurrentContext()
```
  - getErrorPath
```
public String getErrorPath()
```
    Specified by:
    
    getErrorPath in interface org.springframework.boot.autoconfigure.web.ErrorController

Class GatewayErrorController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR_PATH

ATTR_ERROR_EXCEPTION

ATTR_ERROR_MESSAGE

ATTR_ERROR_STATUS_CODE

ATTR_PROXY

ATTR_SERVICE_ID

ZUUL_REQUEST_URI

ERROR_MESSAGE_GENERAL

ERROR_MESSAGE_TIMEOUT

Constructor Detail

GatewayErrorController

Method Detail

error

isServiceUnavailable

isGatewayTimeout

errorResponse

getRequestUriFromRequestContext

getHttpStatusFromRequestContext

getRouteFromRequestContext

getServiceIdFromRequestContext

getExceptionFromRequestContext

getErrorMessageFromRequestContext

getCurrentContext

getErrorPath