Package org.netxms.client

Class NXCException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.netxms.client.NXCException

All Implemented Interfaces:

Serializable

public class NXCException
extends Exception

NetXMS client library exception. Used to report API call errors.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	additionalInfo	Additional information about this error
protected int	errorCode	Application-specific error code
protected long[]	relatedObjects	List of identifiers of any related objects (for example, objects referencing entity being deleted).

Constructor Summary

Constructors

Constructor	Description
NXCException(int errorCode)	Create new NXC exception.
NXCException(int errorCode, String additionalInfo)	Create new NXC exception with additional information.
NXCException(int errorCode, String additionalInfo, long[] relatedObjects)	Create new NXC exception with additional information.
NXCException(int errorCode, String additionalInfo, long[] relatedObjects, Throwable cause)	Create new NXC exception with additional information and root cause reference.
NXCException(int errorCode, Throwable cause)	Create new NXC exception with root cause reference.

Method Summary

Modifier and Type	Method	Description
String	getAdditionalInfo()	Get additional information associated with exception (for example, NXSL error message)
int	getErrorCode()	Get exception's error code.
protected String	getErrorMessage(int code, String lang)	Get error message text for given error code.
String	getLocalizedMessage()
String	getMessage()
long[]	getRelatedObjects()	Get list of identifiers of related objects.

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 Details

errorCode

protected int errorCode

Application-specific error code

additionalInfo

protected String additionalInfo

Additional information about this error

relatedObjects

protected long[] relatedObjects

List of identifiers of any related objects (for example, objects referencing entity being deleted).

Constructor Details

NXCException

public NXCException(int errorCode)

Create new NXC exception.

Parameters:

errorCode - Error code

NXCException

public NXCException(int errorCode,
 String additionalInfo)

Create new NXC exception with additional information.

Parameters:

errorCode - Error code

additionalInfo - Additional info

NXCException

public NXCException(int errorCode,
 String additionalInfo,
 long[] relatedObjects)

Create new NXC exception with additional information.

Parameters:

errorCode - Error code

additionalInfo - Additional info

relatedObjects - List of related object identifiers

NXCException

public NXCException(int errorCode,
 Throwable cause)

Create new NXC exception with root cause reference.

Parameters:

errorCode - Error code

cause - root cause exception

NXCException

public NXCException(int errorCode,
 String additionalInfo,
 long[] relatedObjects,
 Throwable cause)

Create new NXC exception with additional information and root cause reference.

Parameters:

errorCode - Error code

additionalInfo - Additional info

relatedObjects - List of related object identifiers

cause - root cause exception

Method Details

getErrorMessage

protected String getErrorMessage(int code,
 String lang)

Get error message text for given error code. Must not return null.

Parameters:

code - error code

lang - language code

Returns:

error message for given code

getErrorCode

public int getErrorCode()

Get exception's error code.

Returns:

the errorCode

getAdditionalInfo

public String getAdditionalInfo()

Get additional information associated with exception (for example, NXSL error message)

Returns:

additional information associated with exception

getRelatedObjects

public long[] getRelatedObjects()

Get list of identifiers of related objects.

Returns:

list of identifiers of related objects or null if not provided

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

See Also:

• Throwable.getMessage()

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable

See Also:

• Throwable.getLocalizedMessage()