Broker 10.5 | webMethods Broker Documentation | webMethods Broker Client Java API Programmer's Guide | API Exceptions
 
API Exceptions
This appendix describes the exceptions that can be thrown by the webMethods Broker Java API to report API, communications, and Broker failures.
You can use the BrokerException.toString method to obtain a character string that briefly describes the error associated with a particular BrokerException.
The BrokerException.toCompleteString method lets you obtain a character string that specifically describes the error associated with a particular BrokerException.
BrokerBadStateException
An API call was made that conflicts with the current system state. For example:
*You attempted to register a callback for a subscription ID before registering a general callback.
*You attempted to invoke a second BrokerClient.dispatch while in a callback method.
BrokerClientContentionException
An attempt was made to reconnect a Broker client, but the client is either already in use, or the client has shared state and the maximum number of shared clients has already been reached.
BrokerClientExistsException
The client ID specified when creating a new BrokerClient is already is use.
BrokerCommFailureException
A generic communications fault has occurred. Network failures cause this exception to be thrown.
BrokerConnectionClosedException
The connection to the Broker closed before or during the operation you requested.
BrokerCorruptDataException
The data object on which you are operating is corrupt. Currently only detected on BrokerEvent objects.
BrokerException
This class is the base exception type for all exceptions thrown by Information Broker client classes. It refers to specific exception sub-class for information about why the exception is thrown.
BrokerFailureException
An unexpected failure happened while the Broker was processing your request. This exception can have two possible meanings:
*The API could not correctly process an exception into one of the other exceptions.
*A Broker failure has occurred, such as running out of memory or a corrupted data store.
BrokerFieldNotFoundException
An attempt was made to operate on a BrokerEvent field that does not exist.
BrokerFieldTypeMismatchException
The specified event field is not of the expected type. For example, using the BrokerEvent.setStringField method on an event field of type int will cause this exception to be thrown.
BrokerFileNotFoundException
The specified file could not be found or could not be opened.
BrokerFilterParseException
An error occurred while parsing the filter string specified when creating a new BrokerFilter.
BrokerFilterRuntimeException
The filter specified with the BrokerFilter.matchFilter method caused a runtime error, such as division by zero.
BrokerFormatException
This can result from some protocol failures. It is mainly issued by the BrokerString calls to parse values out of strings.
BrokerHostNotFoundException
The host specified when creating or reconnecting a BrokerClient could not be found.
BrokerIncompatibleVersionException
The Broker is running an older version of the product than this API.
BrokerInterruptedException
A BrokerClient.getEvent or BrokerClient.getEvents method was interrupted by the invocation of the BrokerClient.interruptGetEvents method.
This exception can also be thrown if the BrokerClient.dispatch method was interrupted by a call to the BrokerClient.interruptDispatch method.
BrokerInvalidAcknowledgementException
An attempt was made to acknowledge a sequence number that was out of order or which was not been assigned to your Broker client.
BrokerInvalidClassException
The storage_class passed to the BrokerEvent constructor could not be instantiated using the class' newInstance method.
BrokerInvalidClientException
The BrokerClient object passed to the method is either disconnected or has been destroyed.
BrokerInvalidClientIdException
The client ID specified when creating a new BrokerClient contained illegal characters or was longer than 255 characters.
BrokerInvalidDescriptorException
The BrokerConnectionDescriptor object passed to the method has been deleted.
BrokerInvalidEventException
The BrokerEvent object passed to the method has been deleted.
BrokerInvalidEventTypeNameException
An event type name contained illegal characters, reserved words, or has components over 255 characters in length. See Parameter Naming Rules for information on valid event type names.
BrokerInvalidFieldNameException
A field name contains illegal characters, reserved words, or has components over 255 characters in length. See Parameter Naming Rules for information on valid event type names.
BrokerInvalidPlatformKeyException
An invalid platform key was specified.
BrokerInvalidSubscriptionException
A null event_type_name parameter, or a negative subscription ID parameter, or a filter string with a parse error were used when creating a new BrokerSubscription.
This exception can also be thrown if the subscription specified on BrokerClient.cancel was not found by the Broker.
BrokerInvalidTypeCacheException
An internal error occurred with the event type definition cache. This does not represent a user error.
BrokerInvalidTypeDefException
The BrokerTypeDef object passed to the method has been deleted. Either the client it was associated with was disconnected or destroyed, or the event type definition cache was flushed.
BrokerInvalidTypeException
An attempt was made to set an event's field to a value that didn't match the field's type while using a method such as BrokerEvent.setField.
This exception can also be thrown when internal failures occur.
BrokerNoPermissionException
You do not have the necessary permission to do the operation you attempted. For example:
*Attempting to write to a read-only envelope field.
*Using a client group that does not include your identity with the correct permissions when reconnecting or creating a new BrokerClient.
*Attempting to publish an event type that is not allowed by your BrokerClient object's client group.
For more information on client group permissions and can publish permissions see Administering webMethods Broker .
BrokerNotImplementedException
The method you requested is not implemented.
BrokerNotRunningException
While attempting to create or reconnect a BrokerClient, the specified host was found but no Broker was running on that host.
BrokerNullParamException
A null value was passed for a parameter that requires a value.
BrokerOutOfRangeException
A parameter value is outside the accepted range. For example, getting a sequence subset using negative indexes will cause this exception to be thrown.
BrokerPublishPauseException
An internal failure occurred while communicating with the Broker.
BrokerProtocolException
An internal failure occurred while communicating with the Broker.
BrokerSecurityException
A security problem occurred that prevented the operation from being completed.
BrokerSubscriptionExistsException
You attempted to create a new BrokerSubscription with an event type and filter that has already been used for another subscription.
BrokerTimeoutException
The requested operation timed out. This occurs for methods like BrokerClient.getEvent when an event is not received within the specified time-out interval.
BrokerTxClosedException
Action attempted on a BrokerClient transaction that has already been either committed or aborted.
BrokerUnknownBrokerNameException
The Broker specified when reconnecting or creating a new BrokerClient was not found.
BrokerUnknownClientGroupException
The client group specified when reconnecting or creating a new BrokerClient was not found.
BrokerUnknownClientIdException
The Client ID specified when reconnecting a BrokerClient was not found.
BrokerUnknownEventTypeException
The specified event type was not found on the Broker. This exception can be thrown, for example, if you attempt to create a new BrokerEvent with a non-existent type.
BrokerUnknownInfosetException
The specified infoset was not found for the event type.
BrokerUnknownKeyException
The platform specified key for BrokerClient.getPlatformInfo has no value defined.
BrokerUnknownNameException
The specified distinguished name does not exist in the appropriate SSL certificate file.
BrokerUnknownTxException
Specified name does not exist in the resource being accessed.