org.odpi.openmetadata.accessservices.connectedasset.server.properties

Class ConnectedAssetOMASAPIResponse

java.lang.Object

org.odpi.openmetadata.accessservices.connectedasset.server.properties.ConnectedAssetOMASAPIResponse

Direct Known Subclasses:

AssetUniverseResponse

public abstract class ConnectedAssetOMASAPIResponse
extends Object

ConnectedAssetOMASAPIResponse provides a common header for Asset Consumer OMAS managed rest to its REST API. It manages information about exceptions. If no exception has been raised exceptionClassName is null.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	exceptionClassName
protected String	exceptionErrorMessage
protected String	exceptionSystemAction
protected String	exceptionUserAction
protected int	relatedHTTPCode

Constructor Summary

Constructors

Constructor and Description
ConnectedAssetOMASAPIResponse() Default constructor

Method Summary

Modifier and Type	Method and Description
String	getExceptionClassName() Return the name of the Java class name to use to recreate the exception.
String	getExceptionErrorMessage() Return the error message associated with the exception.
String	getExceptionSystemAction() Return the description of the action taken by the system as a result of the exception.
String	getExceptionUserAction() Return the action that a user should take to resolve the problem.
int	getRelatedHTTPCode() Return the HTTP Code to use if forwarding response to HTTP client.
void	setExceptionClassName(String exceptionClassName) Set up the name of the Java class name to use to recreate the exception.
void	setExceptionErrorMessage(String exceptionErrorMessage) Set up the error message associated with the exception.
void	setExceptionSystemAction(String exceptionSystemAction) Set up the description of the action taken by the system as a result of the exception.
void	setExceptionUserAction(String exceptionUserAction) Set up the action that a user should take to resolve the problem.
void	setRelatedHTTPCode(int relatedHTTPCode) Set up the HTTP Code to use if forwarding response to HTTP client.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

relatedHTTPCode

protected int relatedHTTPCode

exceptionClassName

protected String exceptionClassName

exceptionErrorMessage

protected String exceptionErrorMessage

exceptionSystemAction

protected String exceptionSystemAction

exceptionUserAction

protected String exceptionUserAction

Constructor Detail

ConnectedAssetOMASAPIResponse

public ConnectedAssetOMASAPIResponse()

Default constructor

Method Detail

getRelatedHTTPCode

public int getRelatedHTTPCode()

Return the HTTP Code to use if forwarding response to HTTP client.

Returns:

integer HTTP status code

setRelatedHTTPCode

public void setRelatedHTTPCode(int relatedHTTPCode)

Set up the HTTP Code to use if forwarding response to HTTP client.

Parameters:

relatedHTTPCode - - integer HTTP status code

getExceptionClassName

public String getExceptionClassName()

Return the name of the Java class name to use to recreate the exception.

Returns:

String name of the fully-qualified java class name

setExceptionClassName

public void setExceptionClassName(String exceptionClassName)

Set up the name of the Java class name to use to recreate the exception.

Parameters:

exceptionClassName - - String name of the fully-qualified java class name

getExceptionErrorMessage

public String getExceptionErrorMessage()

Return the error message associated with the exception.

Returns:

string error message

setExceptionErrorMessage

public void setExceptionErrorMessage(String exceptionErrorMessage)

Set up the error message associated with the exception.

Parameters:

exceptionErrorMessage - - string error message

getExceptionSystemAction

public String getExceptionSystemAction()

Return the description of the action taken by the system as a result of the exception.

Returns:

- string description of the action taken

setExceptionSystemAction

public void setExceptionSystemAction(String exceptionSystemAction)

Set up the description of the action taken by the system as a result of the exception.

Parameters:

exceptionSystemAction - - string description of the action taken

getExceptionUserAction

public String getExceptionUserAction()

Return the action that a user should take to resolve the problem.

Returns:

string instructions

setExceptionUserAction

public void setExceptionUserAction(String exceptionUserAction)

Set up the action that a user should take to resolve the problem.

Parameters:

exceptionUserAction - - string instructions

toString

public String toString()

Overrides:

toString in class Object