Package org.springframework.cloud.servicebroker.exception

Class ServiceBrokerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.cloud.servicebroker.exception.ServiceBrokerException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ServiceBrokerApiVersionException, ServiceBrokerApiVersionMissingException, ServiceBrokerAsyncRequiredException, ServiceBrokerBindingRequiresAppException, ServiceBrokerConcurrencyException, ServiceBrokerInvalidOriginatingIdentityException, ServiceBrokerInvalidParametersException, ServiceBrokerMaintenanceInfoConflictException, ServiceBrokerOperationInProgressException, ServiceBrokerUnavailableException, ServiceDefinitionDoesNotExistException, ServiceDefinitionPlanDoesNotExistException, ServiceInstanceBindingDoesNotExistException, ServiceInstanceBindingExistsException, ServiceInstanceDoesNotExistException, ServiceInstanceExistsException, ServiceInstanceUpdateNotSupportedException

public class ServiceBrokerException
extends RuntimeException

Thrown to indicate underlying service broker errors (like connectivity to the service being brokered) not covered by a more specific exception.

Throwing this exception will result in an HTTP status code 500 INTERNAL SERVER ERROR being returned to the platform.

Author:

S Greenberg, Roy Clarkson

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ServiceBrokerException(String message)	Construct an exception with the provided message.
ServiceBrokerException(String errorCode, String message)	Construct an exception with the provided error code and message.
ServiceBrokerException(String errorCode, String message, Boolean instanceUsable, Boolean updateRepeatable)	Construct an exception with the provided error code, message and cause.
ServiceBrokerException(String errorCode, String message, Boolean instanceUsable, Boolean updateRepeatable, Throwable cause)	Construct an exception with the provided error code, message and cause.
ServiceBrokerException(String errorCode, String message, Throwable cause)	Construct an exception with the provided error code, message and cause.
ServiceBrokerException(String message, Throwable cause)	Construct an exception with the provided message and cause.
ServiceBrokerException(Throwable cause)	Construct an exception without a message and with the provided cause.

Method Summary

Modifier and Type	Method	Description
ErrorMessage	getErrorMessage()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceBrokerException

public ServiceBrokerException(String message)

Construct an exception with the provided message.

Parameters:

message - the exception message

ServiceBrokerException

public ServiceBrokerException(String errorCode,
 String message)

Construct an exception with the provided error code and message.

Parameters:

errorCode - a single word in camel case that uniquely identifies the error condition

message - the exception message

ServiceBrokerException

public ServiceBrokerException(String message,
 Throwable cause)

Construct an exception with the provided message and cause.

Parameters:

message - the exception message

cause - the cause of the exception

ServiceBrokerException

public ServiceBrokerException(String errorCode,
 String message,
 Throwable cause)

Construct an exception with the provided error code, message and cause.

Parameters:

errorCode - a single word in camel case that uniquely identifies the error condition

message - the exception message

cause - the cause of the exception

ServiceBrokerException

public ServiceBrokerException(String errorCode,
 String message,
 Boolean instanceUsable,
 Boolean updateRepeatable)

Construct an exception with the provided error code, message and cause.

Parameters:

errorCode - a single word in camel case that uniquely identifies the error condition

message - the exception message

instanceUsable - if an update or deprovisioning operation failed, this flag indicates whether or not the Service Instance is still usable. If true, the Service Instance can still be used, false otherwise. This field MUST NOT be present for errors of other operations.

updateRepeatable - if an update operation failed, this flag indicates whether this update can be repeated or not. If true, the same update operation MAY be repeated and MAY succeed; if false, repeating the same update operation will fail again. This field MUST NOT be present for errors of other operations.

ServiceBrokerException

public ServiceBrokerException(String errorCode,
 String message,
 Boolean instanceUsable,
 Boolean updateRepeatable,
 Throwable cause)

Construct an exception with the provided error code, message and cause.

Parameters:

errorCode - a single word in camel case that uniquely identifies the error condition

message - the exception message

instanceUsable - if an update or deprovisioning operation failed, this flag indicates whether or not the Service Instance is still usable. If true, the Service Instance can still be used, false otherwise. This field MUST NOT be present for errors of other operations.

updateRepeatable - if an update operation failed, this flag indicates whether this update can be repeated or not. If true, the same update operation MAY be repeated and MAY succeed; if false, repeating the same update operation will fail again. This field MUST NOT be present for errors of other operations.

cause - the cause of the exception

ServiceBrokerException

public ServiceBrokerException(Throwable cause)

Construct an exception without a message and with the provided cause.

Parameters:

cause - the cause of the exception

Method Details

getErrorMessage

public ErrorMessage getErrorMessage()