ITKMessagingException (ITK API and Reference Implementation mini-site 0.1-SNAPSHOT API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - uk.nhs.interoperability.infrastructure.ITKMessagingException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ITKCommsException, ITKSOAPException, ITKTransportTimeoutException
```
public class ITKMessagingException
extends Exception
```
Base exception for the ITK Messaging api. Has the capability to wrap standard java exceptions as well as being able to represent more structured errors such as SOAP Faults - e.g. by representing the <itk:ToolkitErrorInfo/> information elements

Since:

version 0.1

Author:

Michael Odling-Smee, Nicholas Jones

See Also:
ITKTransportTimeoutException, ITKCommsException, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESS_DENIED_CODE` Access Denied
`static String`	`ACCESS_DENIED_TEXT` Standard text associated with the `ACCESS_DENIED_CODE`
`static String`	`DEFAULT_ERROR_CODESYSTEM_OID` This is the OID to represent the default code system when raising SOAP faults etc.
`static int`	`INVALID_MESSAGE_CODE` Invalid Message - the message structure or content is unrecognised or incorrect
`static String`	`INVALID_MESSAGE_TEXT` Standard text associated with the `INVALID_MESSAGE_CODE`
`static int`	`NO_ERROR_CODE` Default error "code" that indicates that no error code is associated with this ITKMessagingException
`static int`	`PROCESSING_ERROR_NOT_RETRYABLE_CODE` Processing Error (not retryable) - a non-recoverable processing error has been encountered
`static String`	`PROCESSING_ERROR_NOT_RETRYABLE_TEXT` Standard text associated with the `PROCESSING_ERROR_NOT_RETRYABLE_CODE`
`static int`	`PROCESSING_ERROR_RETRYABLE_CODE` Processing Error (retryable) - a recoverable processing error has been encountered
`static String`	`PROCESSING_ERROR_RETRYABLE_TEXT` Standard text associated with the `PROCESSING_ERROR_RETRYABLE_CODE`

Constructor Summary

Constructors
Constructor and Description
`ITKMessagingException(int errorCode, String message)` Creates an ITKMessagingException with any relevant diagnostic information about the error - such as the likely cause.
`ITKMessagingException(int errorCode, String message, Throwable cause)` Creates an ITKMessagingException that wraps an underlying `Throwable` which has been encountered when sending/receiving a message Note: by default the `errorCode` is assumed to be a code associated with the `DEFAULT_ERROR_CODESYSTEM_OID` codeSystem
`ITKMessagingException(ITKMessageProperties itkMessageProperties, int errorCode, String arg0)`
`ITKMessagingException(ITKMessageProperties itkMessageProperties, int errorCode, String message, Throwable cause)`
`ITKMessagingException(ITKTransportProperties itkTransportProperties, ITKMessageProperties itkMessageProperties, int errorCode, String message)`
`ITKMessagingException(ITKTransportProperties itkTransportProperties, ITKMessageProperties itkMessageProperties, int errorCode, String message, Throwable cause)`
`ITKMessagingException(String message)` Creates an ITKMessagingException with any relevant diagnostic information about the error - such as the likely cause
`ITKMessagingException(String message, Throwable cause)` Creates an ITKMessagingException that wraps an underlying `Throwable` which has been encountered when sending/receiving a message
`ITKMessagingException(Throwable cause)` Creates an ITKMessagingException that wraps an underlying `Throwable` which has been encountered when sending/receiving a message

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`decodeErrorCode()` Convenience method to decode any `errorCode` from the `DEFAULT_ERROR_CODESYSTEM_OID`.
`int`	`getErrorCode()` Obtains the `errorCode` associated with the ITKMessagingException.
`String`	`getErrorCodeSystem()` Obtains the `errorCodeSystem` for any `errorCode` associated with the ITKMessagingException.
`String`	`getErrorId()` Obtains the unique errorId for the ITKMessagingException The `errorId` is typically expected to be used in applications logs to uniquely tie log messages / exception traces together to aid in diagnostics
`String`	`getLocalizedMessage()` Obtains the standard (human readable message) associated with the ITKMessagingException in the language for the `Locale` where it localised messages are available.
`String`	`getMessage()` Obtains the standard (human readable message) associated with the ITKMessagingException.
`ITKTransportProperties`	`getRelatedItkTransportProperties()`
`ITKMessageProperties`	`getRelatedMessageProperties()`
`void`	`setErrorCode(int errorCode)` Sets the `errorCode` associated with the ITKMessagingException.
`void`	`setErrorCodeSystem(String errorCodeSystem)` Sets the `errorCodeSystem` for any `errorCode` associated with the ITKMessagingException.
`void`	`setErrorId(String errorId)` Obtains the unique errorId for the ITKMessagingException The `errorId` is typically expected to be used in applications logs to uniquely tie log messages / exception traces together to aid in diagnostics
`void`	`setRelatedItkTransportProperties(ITKTransportProperties relatedItkTransportProperties)`
`void`	`setRelatedMessageProperties(ITKMessageProperties relatedMessageProperties)`

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, 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

- Field Detail
  - DEFAULT_ERROR_CODESYSTEM_OID
```
public static final String DEFAULT_ERROR_CODESYSTEM_OID
```
    This is the OID to represent the default code system when raising SOAP faults etc. OID is 2.16.840.1.1138883.2.1.3.2.4.17.268
    
    See Also:
    Constant Field Values
  - NO_ERROR_CODE
```
public static final int NO_ERROR_CODE
```
    Default error "code" that indicates that no error code is associated with this ITKMessagingException
    
    See Also:
    Constant Field Values
  - INVALID_MESSAGE_CODE
```
public static final int INVALID_MESSAGE_CODE
```
    Invalid Message - the message structure or content is unrecognised or incorrect
    
    See Also:
    Constant Field Values
  - PROCESSING_ERROR_RETRYABLE_CODE
```
public static final int PROCESSING_ERROR_RETRYABLE_CODE
```
    Processing Error (retryable) - a recoverable processing error has been encountered
    
    See Also:
    Constant Field Values
  - PROCESSING_ERROR_NOT_RETRYABLE_CODE
```
public static final int PROCESSING_ERROR_NOT_RETRYABLE_CODE
```
    Processing Error (not retryable) - a non-recoverable processing error has been encountered
    
    See Also:
    Constant Field Values
  - ACCESS_DENIED_CODE
```
public static final int ACCESS_DENIED_CODE
```
    Access Denied
    
    See Also:
    Constant Field Values
  - INVALID_MESSAGE_TEXT
```
public static final String INVALID_MESSAGE_TEXT
```
    Standard text associated with the INVALID_MESSAGE_CODE
    
    See Also:
    Constant Field Values
  - PROCESSING_ERROR_RETRYABLE_TEXT
```
public static final String PROCESSING_ERROR_RETRYABLE_TEXT
```
    Standard text associated with the PROCESSING_ERROR_RETRYABLE_CODE
    
    See Also:
    Constant Field Values
  - PROCESSING_ERROR_NOT_RETRYABLE_TEXT
```
public static final String PROCESSING_ERROR_NOT_RETRYABLE_TEXT
```
    Standard text associated with the PROCESSING_ERROR_NOT_RETRYABLE_CODE
    
    See Also:
    Constant Field Values
  - ACCESS_DENIED_TEXT
```
public static final String ACCESS_DENIED_TEXT
```
    Standard text associated with the ACCESS_DENIED_CODE
    
    See Also:
    Constant Field Values
- Constructor Detail
  - ITKMessagingException
```
public ITKMessagingException(String message)
```
    Creates an ITKMessagingException with any relevant diagnostic information about the error - such as the likely cause
    
    Parameters:
    message - The diagnostic message about the the error condition
  - ITKMessagingException
```
public ITKMessagingException(Throwable cause)
```
    Creates an ITKMessagingException that wraps an underlying Throwable which has been encountered when sending/receiving a message
    
    Parameters:
    cause - The Throwable containing the root cause
  - ITKMessagingException
```
public ITKMessagingException(int errorCode,
                     String message)
```
    Creates an ITKMessagingException with any relevant diagnostic information about the error - such as the likely cause. An error code associated with the exception indicates the characteristics of the underlying issue - e.g. whether or not it is retryable or not getErrorCode().
    
    Note: by default the errorCode is assumed to be a code associated with the DEFAULT_ERROR_CODESYSTEM_OID codeSystem
    
    Parameters:
    errorCode - The appropriate errorCode associated with the exception - INVALID_MESSAGE_CODE; PROCESSING_ERROR_RETRYABLE_CODE; PROCESSING_ERROR_NOT_RETRYABLE_CODE and ACCESS_DENIED_CODE
    message - The diagnostic message about the the error condition
  - ITKMessagingException
```
public ITKMessagingException(String message,
                     Throwable cause)
```
    Creates an ITKMessagingException that wraps an underlying Throwable which has been encountered when sending/receiving a message
    
    Parameters:
    message - The diagnostic message about the the error condition
    cause - The Throwable containing the root cause
  - ITKMessagingException
```
public ITKMessagingException(int errorCode,
                     String message,
                     Throwable cause)
```
    Creates an ITKMessagingException that wraps an underlying Throwable which has been encountered when sending/receiving a message
    
    Note: by default the errorCode is assumed to be a code associated with the DEFAULT_ERROR_CODESYSTEM_OID codeSystem
    
    Parameters:
    errorCode - The appropriate errorCode associated with the exception - INVALID_MESSAGE_CODE; PROCESSING_ERROR_RETRYABLE_CODE; PROCESSING_ERROR_NOT_RETRYABLE_CODE and ACCESS_DENIED_CODE
    message - The diagnostic message about the the error condition
    cause - The Throwable containing the root cause
  - ITKMessagingException
```
public ITKMessagingException(ITKTransportProperties itkTransportProperties,
                     ITKMessageProperties itkMessageProperties,
                     int errorCode,
                     String message)
```
  - ITKMessagingException
```
public ITKMessagingException(ITKTransportProperties itkTransportProperties,
                     ITKMessageProperties itkMessageProperties,
                     int errorCode,
                     String message,
                     Throwable cause)
```
  - ITKMessagingException
```
public ITKMessagingException(ITKMessageProperties itkMessageProperties,
                     int errorCode,
                     String arg0)
```
  - ITKMessagingException
```
public ITKMessagingException(ITKMessageProperties itkMessageProperties,
                     int errorCode,
                     String message,
                     Throwable cause)
```
- Method Detail
  - getErrorCode
```
public int getErrorCode()
```
    Obtains the errorCode associated with the ITKMessagingException. Note: by default the errorCode is assumed to be a code associated with the DEFAULT_ERROR_CODESYSTEM_OID codeSystem
    
    Returns:
    the errorCode associated with the exception and appropriate to the getErrorCodeSystem()}. If no error code has been defined NO_ERROR_CODE (the int -1) is returned
  - setErrorCode
```
public void setErrorCode(int errorCode)
```
    Sets the errorCode associated with the ITKMessagingException. Note: by default the errorCode is assumed to be a code associated with the DEFAULT_ERROR_CODESYSTEM_OID codeSystem. To use and alternative system set the errorCodeSystem via the setErrorCodeSystem(String) method
    
    Parameters:
    errorCode - The appropriate errorCode associated with the exception - INVALID_MESSAGE_CODE; PROCESSING_ERROR_RETRYABLE_CODE; PROCESSING_ERROR_NOT_RETRYABLE_CODE and ACCESS_DENIED_CODE
  - getErrorCodeSystem
```
public String getErrorCodeSystem()
```
    Obtains the errorCodeSystem for any errorCode associated with the ITKMessagingException. This is only relevant if the getErrorCode() returns anything other than NO_ERROR_CODE
    
    Returns:
    The errorCodeSystem associated with the errorCode for with the ITKMessagingException. The default error code system is indicated by the DEFAULT_ERROR_CODESYSTEM_OID
  - setErrorCodeSystem
```
public void setErrorCodeSystem(String errorCodeSystem)
```
    Sets the errorCodeSystem for any errorCode associated with the ITKMessagingException. This is only relevant if the setErrorCode(int) (or an appropriate constructor) is used to set the errorCode to something other than NO_ERROR_CODE
    
    Parameters:
    errorCodeSystem - The errorCodeSystem associated with the errorCode for with the ITKMessagingException. The default error code system is indicated by the DEFAULT_ERROR_CODESYSTEM_OID
  - getRelatedMessageProperties
```
public ITKMessageProperties getRelatedMessageProperties()
```
  - setRelatedMessageProperties
```
public void setRelatedMessageProperties(ITKMessageProperties relatedMessageProperties)
```
  - getErrorId
```
public String getErrorId()
```
    Obtains the unique errorId for the ITKMessagingException The errorId is typically expected to be used in applications logs to uniquely tie log messages / exception traces together to aid in diagnostics
    
    Returns:
    the errorId associated with this ITKMessagingException.
  - setErrorId
```
public void setErrorId(String errorId)
```
    Obtains the unique errorId for the ITKMessagingException The errorId is typically expected to be used in applications logs to uniquely tie log messages / exception traces together to aid in diagnostics
    
    Parameters:
    errorId - the errorId associated with this ITKMessagingException.
  - getMessage
```
public String getMessage()
```
    Obtains the standard (human readable message) associated with the ITKMessagingException. The text also contains the errorId to ensure it is represented in logs/stack traces
    
    Overrides:
    
    getMessage in class Throwable
  - getLocalizedMessage
```
public String getLocalizedMessage()
```
    Obtains the standard (human readable message) associated with the ITKMessagingException in the language for the Locale where it localised messages are available. The text also contains the errorId to ensure it is represented in logs/stack traces
    
    Overrides:
    
    getLocalizedMessage in class Throwable
  - decodeErrorCode
```
public String decodeErrorCode()
```
    Convenience method to decode any errorCode from the DEFAULT_ERROR_CODESYSTEM_OID.
    
    Returns:
    The appropriate error text. If the codeSystem is not the DEFAULT_ERROR_CODESYSTEM_OID returns the getMessage() text.
  - getRelatedItkTransportProperties
```
public ITKTransportProperties getRelatedItkTransportProperties()
```
  - setRelatedItkTransportProperties
```
public void setRelatedItkTransportProperties(ITKTransportProperties relatedItkTransportProperties)
```

All content is available under the Open Government Licence, except where otherwise stated
All example source code is available under Apache 2.0, except where otherwise stated

Class ITKMessagingException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ERROR_CODESYSTEM_OID

NO_ERROR_CODE

INVALID_MESSAGE_CODE

PROCESSING_ERROR_RETRYABLE_CODE

PROCESSING_ERROR_NOT_RETRYABLE_CODE

ACCESS_DENIED_CODE

INVALID_MESSAGE_TEXT

PROCESSING_ERROR_RETRYABLE_TEXT

PROCESSING_ERROR_NOT_RETRYABLE_TEXT

ACCESS_DENIED_TEXT

Constructor Detail

ITKMessagingException

ITKMessagingException

ITKMessagingException

ITKMessagingException

ITKMessagingException

ITKMessagingException

ITKMessagingException

ITKMessagingException

ITKMessagingException

Method Detail

getErrorCode

setErrorCode

getErrorCodeSystem

setErrorCodeSystem

getRelatedMessageProperties

setRelatedMessageProperties

getErrorId

setErrorId

getMessage

getLocalizedMessage

decodeErrorCode

getRelatedItkTransportProperties

setRelatedItkTransportProperties