Management Console API exceptions

The API throws different exceptions that can be caught and handled by your Java™ programs and applications. This section identifies each exception and describes the situations that result in the exception being raised.

ApiException

This exception encompasses all other recognized API exceptions (CommunicationException, DataNotFoundException, DuplicateException, and UnsupportedFeatureException), and is raised in a variety of situations by different methods. For instance, it will be raised if a value passed through a method parameter is not valid or a connection to Access Server cannot be established.

CommunicationException

This exception is raised when a communications problem has been detected

DataNotFoundException

This exception is typically raised when an attempt to retrieve data of a particular type cannot be performed. It is also raised in certain situations where an attempt is made to assign a value to a setting that does not exist.

DuplicateException

This exception is raised when an attempt is made to define an entity in a replication configuration that already exists. For instance, it is raised when an attempt is made to define a subscription that has the same name as another subscription.

UnsupportedFeatureException

This exception is raised when an attempt is made to work with functions that are not supported by the type of datastore with which you are working. For instance, it is raised if the datastore does not support the definition of derived columns.

Note: Methods are provided to indicate which functions are currently supported. The names of these methods typically start with is (for example, isAlarmFilteringSupported). It is recommended that you use these methods before working with functions that may not be available for a particular datastore. Checking the availability of these functions before working with them will avoid this exception from being raised.