org.odpi.openmetadata.commonservices.ocf.metadatamanagement.ffdc.exceptions

Class NoConnectedAssetException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.ffdc.exceptions.NoConnectedAssetException

All Implemented Interfaces:

Serializable

public class NoConnectedAssetException
extends OCFCheckedExceptionBase

The NoConnectedAssetException is thrown by the Connected Asset OMAS when there is no asset linked to the supplied connection object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NoConnectedAssetException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription) This is the typical constructor used for creating an OCFCheckedException.
NoConnectedAssetException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Map<String,Object> relatedProperties) This is the typical constructor used for creating an OCFCheckedException.
NoConnectedAssetException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError) This is the constructor used for creating an OCFCheckedException when an unexpected error has been caught.
NoConnectedAssetException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, Map<String,Object> relatedProperties) This is the constructor used for creating an OCFCheckedException when an unexpected error has been caught.
NoConnectedAssetException(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, Map<String,Object> relatedProperties) This is the constructor used when receiving an exception from a remote server.
NoConnectedAssetException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String connectionGUID) Deprecated.
NoConnectedAssetException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, String connectionGUID) Deprecated.
NoConnectedAssetException(String errorMessage, OCFCheckedExceptionBase template) This is the copy/clone constructor used for creating an exception.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Return comparison result based on the content of the properties.
String	getConnectionGUID() Return the GUID in error
int	hashCode() Return hash code for this object
String	toString() JSON-style toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase

getErrorMessage, getRelatedProperties, getReportedCaughtException, getReportedCaughtExceptionClassName, getReportedErrorMessage, getReportedErrorMessageId, getReportedErrorMessageParameters, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NoConnectedAssetException

public NoConnectedAssetException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription)

This is the typical constructor used for creating an OCFCheckedException.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

NoConnectedAssetException

public NoConnectedAssetException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 Map<String,Object> relatedProperties)

This is the typical constructor used for creating an OCFCheckedException. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

relatedProperties - arbitrary properties that may help with diagnosing the problem.

NoConnectedAssetException

public NoConnectedAssetException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 Throwable caughtError)

This is the constructor used for creating an OCFCheckedException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - previous error causing this exception

NoConnectedAssetException

public NoConnectedAssetException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 Throwable caughtError,
                                 Map<String,Object> relatedProperties)

This is the constructor used for creating an OCFCheckedException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - previous error causing this exception

relatedProperties - arbitrary properties that may help with diagnosing the problem.

NoConnectedAssetException

public NoConnectedAssetException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String errorMessageId,
                                 String[] errorMessageParameters,
                                 String systemAction,
                                 String userAction,
                                 String caughtErrorClassName,
                                 Map<String,Object> relatedProperties)

This is the constructor used when receiving an exception from a remote server. The values are stored directly in the response object and are passed explicitly to the new exception. Notice that the technical aspects of the exception - such as class name creating the exception are local values so that the implementation of the server is not exposed.

Parameters:

httpCode - http response code to use if this exception flows over a REST call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

errorMessageId - unique identifier for the message

errorMessageParameters - parameters that were inserted in the message

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

caughtErrorClassName - previous error causing this exception

relatedProperties - arbitrary properties that may help with diagnosing the problem.

NoConnectedAssetException

public NoConnectedAssetException(String errorMessage,
                                 OCFCheckedExceptionBase template)

This is the copy/clone constructor used for creating an exception.

Parameters:

errorMessage - associated message

template - object to copy

NoConnectedAssetException

@Deprecated
public NoConnectedAssetException(int httpCode,
                                             String className,
                                             String actionDescription,
                                             String errorMessage,
                                             String systemAction,
                                             String userAction,
                                             String connectionGUID)

Deprecated.

This is the typical constructor used for creating an exception.

Parameters:

httpCode - http response code to use if this exception flows over a rest call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

connectionGUID - unique identifier that is unrecognized

NoConnectedAssetException

@Deprecated
public NoConnectedAssetException(int httpCode,
                                             String className,
                                             String actionDescription,
                                             String errorMessage,
                                             String systemAction,
                                             String userAction,
                                             Throwable caughtError,
                                             String connectionGUID)

Deprecated.

This is the constructor used for creating an exception that resulted from a previous error.

Parameters:

httpCode - http response code to use if this exception flows over a rest call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

caughtError - the error that resulted in this exception.

connectionGUID - guid in error

Method Detail

getConnectionGUID

public String getConnectionGUID()

Return the GUID in error

Returns:

string identifier

toString

public String toString()

JSON-style toString

Overrides:

toString in class OCFCheckedExceptionBase

Returns:

string of property names and values for this enum

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class OCFCheckedExceptionBase

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class OCFCheckedExceptionBase

Returns:

int hash code