com.prosysopc.ua

Class StatusException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.prosysopc.ua.UaException

com.prosysopc.ua.StatusException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MethodCallStatusException, PubSubException

public class StatusException
extends UaException

An operation level exception.

The exception is raised when a read or write operation to an OPC UA server returns a status code of bad quality.

Read the status code for the status and DiagnosticInfo for additional diagnostics, provided by the server. Note that the diagnostics are only returned, when requested by the client application (by defining Server.OperationDiagnosticMask).

See Also:

StatusCodes, Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusException(ServiceFaultException ex) Creates a new StatusException from a ServiceFaultException.
StatusException(ServiceResultException ex) Creates a new StatusException from an ServiceResultException.
StatusException(StatusCode statusCode) Creates a new StatusException.
StatusException(StatusCode statusCode, DiagnosticInfo diagnosticInfo) Creates new StatusException having the given StatusCode and DiagnosticInfo.
StatusException(StatusCode statusCode, Throwable cause) Creates a new StatusException.
StatusException(String msg) Creates a new StatusException with StatusCodes.Bad_UnexpectedError.
StatusException(String msg, ServiceFaultException ex) Creates a new StatusException with a custom message and fault.
StatusException(String msg, ServiceResultException ex) Creates a new StatusException with a custom message and exception.
StatusException(String msg, StatusCode statusCode) Creates a new StatusException with a custom message and status code.
StatusException(String msg, StatusCode statusCode, DiagnosticInfo diagnosticInfo, Throwable cause) Creates a new StatusException.
StatusException(String msg, Throwable cause) Creates a new StatusException with StatusCode = Bad_UnexpectedError.
StatusException(String msg, UnsignedInteger statusCode) Creates a new StatusException.
StatusException(String msg, UnsignedInteger statusCode, DiagnosticInfo diagnosticInfo, Throwable cause) Creates a new StatusException.
StatusException(UnsignedInteger statusCode) Creates a new StatusException.
StatusException(UnsignedInteger statusCode, DiagnosticInfo diagnosticInfo) Creates a new StatusException with a status code and diagnostics.
StatusException(UnsignedInteger statusCode, Throwable cause) Creates a new StatusException.

Method Summary

Modifier and Type	Method and Description
DiagnosticInfo	getDiagnosticInfo() The diagnostics of the error.
StatusCode	getStatusCode() The status code of the error.
static DiagnosticInfo	toDiagnosticInfo(ServiceFault serviceFault) Get the diagnotsics from a service fault.
String	toString()

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StatusException

public StatusException(ServiceFaultException ex)

Creates a new StatusException from a ServiceFaultException.

StatusException

public StatusException(ServiceResultException ex)

Creates a new StatusException from an ServiceResultException.

StatusException

public StatusException(StatusCode statusCode)

Creates a new StatusException.

Parameters:

statusCode - The error status code defining the actual service call error.

StatusException

public StatusException(StatusCode statusCode,
                       DiagnosticInfo diagnosticInfo)

Creates new StatusException having the given StatusCode and DiagnosticInfo.

StatusException

public StatusException(StatusCode statusCode,
                       Throwable cause)

Creates a new StatusException.

Parameters:

statusCode - The error status code defining the actual service call error.

cause - The original exception.

StatusException

public StatusException(String msg)

Creates a new StatusException with StatusCodes.Bad_UnexpectedError.

StatusException

public StatusException(String msg,
                       ServiceFaultException ex)

Creates a new StatusException with a custom message and fault.

StatusException

public StatusException(String msg,
                       ServiceResultException ex)

Creates a new StatusException with a custom message and exception.

StatusException

public StatusException(String msg,
                       StatusCode statusCode)

Creates a new StatusException with a custom message and status code.

Parameters:

msg - Error message.

statusCode - The error status code value defining the actual service call error.

StatusException

public StatusException(String msg,
                       StatusCode statusCode,
                       DiagnosticInfo diagnosticInfo,
                       Throwable cause)

Creates a new StatusException.

Parameters:

msg - Error message.

statusCode - The error status code defining the actual service call error.

diagnosticInfo - The additional diagnostic information as returned from the server.

cause - the original exception

StatusException

public StatusException(String msg,
                       Throwable cause)

Creates a new StatusException with StatusCode = Bad_UnexpectedError.

Parameters:

msg - Error message.

cause - nested exception causing this exception

StatusException

public StatusException(String msg,
                       UnsignedInteger statusCode)

Creates a new StatusException.

Parameters:

msg - Error message.

statusCode - The error status code value defining the actual service call error.

StatusException

public StatusException(String msg,
                       UnsignedInteger statusCode,
                       DiagnosticInfo diagnosticInfo,
                       Throwable cause)

Creates a new StatusException.

Parameters:

msg - Error message.

statusCode - The error status code value defining the actual service call error.

cause - The original exception

StatusException

public StatusException(UnsignedInteger statusCode)

Creates a new StatusException.

Parameters:

statusCode - The error status code value defining the actual service call error.

StatusException

public StatusException(UnsignedInteger statusCode,
                       DiagnosticInfo diagnosticInfo)

Creates a new StatusException with a status code and diagnostics.

Parameters:

statusCode - The error status code defining the actual service call error.

diagnosticInfo - The diagnostics

StatusException

public StatusException(UnsignedInteger statusCode,
                       Throwable cause)

Creates a new StatusException.

Parameters:

statusCode - The error status code defining the actual service call error.

cause - The original exception.

Method Detail

toDiagnosticInfo

public static DiagnosticInfo toDiagnosticInfo(ServiceFault serviceFault)

Get the diagnotsics from a service fault.

Parameters:

serviceFault - the fault

Returns:

the diagnosticInfo from the fault

getDiagnosticInfo

public DiagnosticInfo getDiagnosticInfo()

The diagnostics of the error.

Returns:

the diagnosticInfo

getStatusCode

public StatusCode getStatusCode()

The status code of the error.

Returns:

the statusCode

toString

public String toString()

Overrides:

toString in class Throwable