org.springframework.cloud.servicebroker.controller

Class ServiceBrokerExceptionHandler

java.lang.Object

org.springframework.cloud.servicebroker.controller.ServiceBrokerExceptionHandler

Direct Known Subclasses:

ServiceBrokerWebFluxExceptionHandler, ServiceBrokerWebMvcExceptionHandler

public abstract class ServiceBrokerExceptionHandler
extends Object

Exception handling logic shared by all Controllers.

Author:

Scott Frederick, Roy Clarkson

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	UNPROCESSABLE_REQUEST

Constructor Summary

Constructors

Constructor and Description
ServiceBrokerExceptionHandler()

Method Summary

Modifier and Type	Method and Description
protected ErrorMessage	getErrorResponse(Exception ex) Format an error message for the exception
protected ErrorMessage	getErrorResponse(ServiceBrokerException ex) Format an error message for the exception
protected ErrorMessage	getErrorResponse(String message) Create an error message object
protected abstract org.slf4j.Logger	getLog() Callback to implementing classes to obtain the configured Logger
protected OperationInProgressMessage	getOperationInProgressMessage(ServiceBrokerOperationInProgressException ex) Format an operation in progress message for the exception
protected ErrorMessage	handleBindingException(Exception ex, BindingResult result) Creates an error message for binding errors
ErrorMessage	handleException(Exception ex) Handle a Exception
ErrorMessage	handleException(ServiceBrokerApiVersionException ex) Handle a ServiceBrokerApiVersionException
ErrorMessage	handleException(ServiceBrokerApiVersionMissingException ex) Handle a ServiceBrokerApiVersionMissingException
ErrorMessage	handleException(ServiceBrokerAsyncRequiredException ex) Handle a ServiceBrokerAsyncRequiredException
ErrorMessage	handleException(ServiceBrokerBindingRequiresAppException ex) Handle a ServiceBrokerBindingRequiresAppException
ErrorMessage	handleException(ServiceBrokerConcurrencyException ex) Handle a ServiceBrokerConcurrencyException
OperationInProgressMessage	handleException(ServiceBrokerCreateOperationInProgressException ex) Handle a ServiceBrokerCreateOperationInProgressException
OperationInProgressMessage	handleException(ServiceBrokerDeleteOperationInProgressException ex) Handle a ServiceBrokerDeleteOperationInProgressException
ErrorMessage	handleException(ServiceBrokerException ex) Handle a ServiceBrokerException
ErrorMessage	handleException(ServiceBrokerInvalidOriginatingIdentityException ex) Handle a ServiceBrokerInvalidOriginatingIdentityException
ErrorMessage	handleException(ServiceBrokerInvalidParametersException ex) Handle a ServiceBrokerInvalidParametersException
ErrorMessage	handleException(ServiceBrokerMaintenanceInfoConflictException ex) Handle a ServiceBrokerMaintenanceInfoConflictException
ErrorMessage	handleException(ServiceBrokerOperationInProgressException ex) Handle a ServiceBrokerOperationInProgressException
ErrorMessage	handleException(ServiceBrokerUnavailableException ex) Handle a ServiceBrokerUnavailableException
OperationInProgressMessage	handleException(ServiceBrokerUpdateOperationInProgressException ex) Handle a ServiceBrokerUpdateOperationInProgressException
ErrorMessage	handleException(ServiceDefinitionDoesNotExistException ex) Handle a ServiceDefinitionDoesNotExistException
ErrorMessage	handleException(ServiceDefinitionPlanDoesNotExistException ex) Handle a ServiceDefinitionPlanDoesNotExistException
ErrorMessage	handleException(ServiceInstanceBindingDoesNotExistException ex) Handle a ServiceInstanceBindingDoesNotExistException
ErrorMessage	handleException(ServiceInstanceBindingExistsException ex) Handle a ServiceInstanceBindingExistsException
ErrorMessage	handleException(ServiceInstanceDoesNotExistException ex) Handle a ServiceInstanceDoesNotExistException
ErrorMessage	handleException(ServiceInstanceExistsException ex) Handle a ServiceInstanceExistsException
ErrorMessage	handleException(ServiceInstanceUpdateNotSupportedException ex) Handle a ServiceInstanceUpdateNotSupportedException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNPROCESSABLE_REQUEST

protected static final String UNPROCESSABLE_REQUEST

See Also:

Constant Field Values

Constructor Detail

ServiceBrokerExceptionHandler

public ServiceBrokerExceptionHandler()

Method Detail

getLog

protected abstract org.slf4j.Logger getLog()

Callback to implementing classes to obtain the configured Logger

Returns:

the Logger

handleException

@ExceptionHandler(value=ServiceBrokerApiVersionException.class)
 @ResponseStatus(value=PRECONDITION_FAILED)
public ErrorMessage handleException(ServiceBrokerApiVersionException ex)

Handle a ServiceBrokerApiVersionException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerApiVersionMissingException.class)
 @ResponseStatus(value=BAD_REQUEST)
public ErrorMessage handleException(ServiceBrokerApiVersionMissingException ex)

Handle a ServiceBrokerApiVersionMissingException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceInstanceDoesNotExistException.class)
 @ResponseStatus(value=UNPROCESSABLE_ENTITY)
public ErrorMessage handleException(ServiceInstanceDoesNotExistException ex)

Handle a ServiceInstanceDoesNotExistException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceDefinitionDoesNotExistException.class)
 @ResponseStatus(value=BAD_REQUEST)
public ErrorMessage handleException(ServiceDefinitionDoesNotExistException ex)

Handle a ServiceDefinitionDoesNotExistException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceDefinitionPlanDoesNotExistException.class)
 @ResponseStatus(value=BAD_REQUEST)
public ErrorMessage handleException(ServiceDefinitionPlanDoesNotExistException ex)

Handle a ServiceDefinitionPlanDoesNotExistException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerAsyncRequiredException.class)
 @ResponseStatus(value=UNPROCESSABLE_ENTITY)
public ErrorMessage handleException(ServiceBrokerAsyncRequiredException ex)

Handle a ServiceBrokerAsyncRequiredException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerMaintenanceInfoConflictException.class)
 @ResponseStatus(value=UNPROCESSABLE_ENTITY)
public ErrorMessage handleException(ServiceBrokerMaintenanceInfoConflictException ex)

Handle a ServiceBrokerMaintenanceInfoConflictException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerInvalidParametersException.class)
 @ResponseStatus(value=BAD_REQUEST)
public ErrorMessage handleException(ServiceBrokerInvalidParametersException ex)

Handle a ServiceBrokerInvalidParametersException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerOperationInProgressException.class)
 @ResponseStatus(value=NOT_FOUND)
public ErrorMessage handleException(ServiceBrokerOperationInProgressException ex)

Handle a ServiceBrokerOperationInProgressException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerCreateOperationInProgressException.class)
 @ResponseStatus(value=ACCEPTED)
public OperationInProgressMessage handleException(ServiceBrokerCreateOperationInProgressException ex)

Handle a ServiceBrokerCreateOperationInProgressException

Parameters:

ex - the exception

Returns:

an operation in progress message

handleException

@ExceptionHandler(value=ServiceBrokerUpdateOperationInProgressException.class)
 @ResponseStatus(value=ACCEPTED)
public OperationInProgressMessage handleException(ServiceBrokerUpdateOperationInProgressException ex)

Handle a ServiceBrokerUpdateOperationInProgressException

Parameters:

ex - the exception

Returns:

an operation in progress message

handleException

@ExceptionHandler(value=ServiceBrokerDeleteOperationInProgressException.class)
 @ResponseStatus(value=ACCEPTED)
public OperationInProgressMessage handleException(ServiceBrokerDeleteOperationInProgressException ex)

Handle a ServiceBrokerDeleteOperationInProgressException

Parameters:

ex - the exception

Returns:

an operation in progress message

handleException

@ExceptionHandler(value=ServiceBrokerUnavailableException.class)
 @ResponseStatus(value=SERVICE_UNAVAILABLE)
public ErrorMessage handleException(ServiceBrokerUnavailableException ex)

Handle a ServiceBrokerUnavailableException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerConcurrencyException.class)
 @ResponseStatus(value=UNPROCESSABLE_ENTITY)
public ErrorMessage handleException(ServiceBrokerConcurrencyException ex)

Handle a ServiceBrokerConcurrencyException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerException.class)
 @ResponseStatus(value=INTERNAL_SERVER_ERROR)
public ErrorMessage handleException(ServiceBrokerException ex)

Handle a ServiceBrokerException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerInvalidOriginatingIdentityException.class)
 @ResponseStatus(value=UNPROCESSABLE_ENTITY)
public ErrorMessage handleException(ServiceBrokerInvalidOriginatingIdentityException ex)

Handle a ServiceBrokerInvalidOriginatingIdentityException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=java.lang.Exception.class)
 @ResponseStatus(value=INTERNAL_SERVER_ERROR)
public ErrorMessage handleException(Exception ex)

Handle a Exception

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceInstanceExistsException.class)
 @ResponseStatus(value=CONFLICT)
public ErrorMessage handleException(ServiceInstanceExistsException ex)

Handle a ServiceInstanceExistsException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceInstanceUpdateNotSupportedException.class)
 @ResponseStatus(value=UNPROCESSABLE_ENTITY)
public ErrorMessage handleException(ServiceInstanceUpdateNotSupportedException ex)

Handle a ServiceInstanceUpdateNotSupportedException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceInstanceBindingExistsException.class)
 @ResponseStatus(value=CONFLICT)
public ErrorMessage handleException(ServiceInstanceBindingExistsException ex)

Handle a ServiceInstanceBindingExistsException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceInstanceBindingDoesNotExistException.class)
 @ResponseStatus(value=UNPROCESSABLE_ENTITY)
public ErrorMessage handleException(ServiceInstanceBindingDoesNotExistException ex)

Handle a ServiceInstanceBindingDoesNotExistException

Parameters:

ex - the exception

Returns:

an error message

handleException

@ExceptionHandler(value=ServiceBrokerBindingRequiresAppException.class)
 @ResponseStatus(value=UNPROCESSABLE_ENTITY)
public ErrorMessage handleException(ServiceBrokerBindingRequiresAppException ex)

Handle a ServiceBrokerBindingRequiresAppException

Parameters:

ex - the exception

Returns:

an error message

getErrorResponse

protected ErrorMessage getErrorResponse(ServiceBrokerException ex)

Format an error message for the exception

Parameters:

ex - the exception

Returns:

the error message

getOperationInProgressMessage

protected OperationInProgressMessage getOperationInProgressMessage(ServiceBrokerOperationInProgressException ex)

Format an operation in progress message for the exception

Parameters:

ex - the exception

Returns:

the message

getErrorResponse

protected ErrorMessage getErrorResponse(Exception ex)

Format an error message for the exception

Parameters:

ex - the exception

Returns:

the error message

getErrorResponse

protected ErrorMessage getErrorResponse(String message)

Create an error message object

Parameters:

message - the text of the message

Returns:

the error message

handleBindingException

protected ErrorMessage handleBindingException(Exception ex,
                                              BindingResult result)

Creates an error message for binding errors

Parameters:

ex - the exception

result - the binding result

Returns:

the error message