Package COM.activesw.api.client

Class BrokerException

java.lang.Object
java.lang.Throwable
java.lang.Exception
COM.activesw.api.client.BrokerException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BrokerBadStateException, BrokerClientContentionException, BrokerClientExistsException, BrokerClientGroupExistsException, BrokerClientQueueLockException, BrokerClusterPublisherException, BrokerCommFailureException, BrokerConnectionClosedException, BrokerCorruptDataException, BrokerDependencyException, BrokerExistsException, BrokerFailureException, BrokerFieldNotFoundException, BrokerFieldTypeMismatchException, BrokerFileNotFoundException, BrokerFilterParseException, BrokerFilterRuntimeException, BrokerFormatException, BrokerHostNotFoundException, BrokerIncompatibleVersionException, BrokerInputParseException, BrokerInTerritoryException, BrokerInterruptedException, BrokerInvalidAccessListException, BrokerInvalidAcknowledgementException, BrokerInvalidBrokerNameException, BrokerInvalidClientException, BrokerInvalidClientGroupNameException, BrokerInvalidClientIdException, BrokerInvalidClientLicenseIDException, BrokerInvalidEventException, BrokerInvalidEventTypeNameException, BrokerInvalidFieldNameException, BrokerInvalidLicenseException, BrokerInvalidLogConfigException, BrokerInvalidNameException, BrokerInvalidPlatformKeyException, BrokerInvalidPortException, BrokerInvalidSubscriptionException, BrokerInvalidTerritoryNameException, BrokerInvalidTxException, BrokerInvalidTypeCacheException, BrokerInvalidTypeDefException, BrokerInvalidTypeException, BrokerNoPermissionException, BrokerNotImplementedException, BrokerNotInClusterException, BrokerNotInTerritoryException, BrokerNotRunningException, BrokerNullParameterException, BrokerOutOfRangeException, BrokerProtocolException, BrokerPublishPauseException, BrokerQueueBrowserException, BrokerSecurityException, BrokerSSLConfigException, BrokerSubscriptionExistsException, BrokerTimeoutException, BrokerTxClosedException, BrokerUnknownBrokerNameException, BrokerUnknownClientGroupException, BrokerUnknownClientIdException, BrokerUnknownClusterException, BrokerUnknownEventTypeException, BrokerUnknownInfosetException, BrokerUnknownKeyException, BrokerUnknownNameException, BrokerUnknownServerException, BrokerUnknownSessionIdException, BrokerUnknownTerritoryException
public class BrokerException extends Exception
This class is the base exception type for all exception thrown by Information Broker client classes. Refer to specific exception sub-classes for information on why those exceptions are thrown.
See Also:

  • Field Details

    • DIAG_NONE

      public static final int DIAG_NONE
      Setting the "brokerexc.setdiag" Java System property to BrokerException.DIAG_NONE will disable diagnostics.
      Ex: System.setProperty("brokerexc.setdiag", BrokerException.DIAG_NONE);
      See Also:

    • DIAG_SHOW_FATAL_ERRORS

      public static final int DIAG_SHOW_FATAL_ERRORS
      Setting the "brokerexc.setdiag" Java System property to BrokerException.DIAG_SHOW_FATAL_ERRORS will enable all fatal errors diagnostics.
      Ex: System.setProperty("brokerexc.setdiag", BrokerException.DIAG_SHOW_FATAL_ERRORS);
      See Also:

    • DIAG_SHOW_ALL_ERRORS

      public static final int DIAG_SHOW_ALL_ERRORS
      Setting the "brokerexc.setdiag" Java System property to BrokerException.DIAG_SHOW_ALL_ERRORS will enable all errors diagnostics.
      Ex: System.setProperty("brokerexc.setdiag", BrokerException.DIAG_SHOW_ALL_ERRORS);
      See Also:

    • DIAG_SHOW_SOCKET_ACTIVITY

      public static final int DIAG_SHOW_SOCKET_ACTIVITY
      Setting the "brokerexc.setdiag" Java System property to BrokerException.DIAG_SHOW_SOCKET_ACTIVITY will enable socket activity diagnostics.
      Ex: System.setProperty("brokerexc.setdiag", BrokerException.DIAG_SHOW_SOCKET_ACTIVITY);
      See Also:

    • DIAG_SHOW_SOCKET_TRAFFIC

      public static final int DIAG_SHOW_SOCKET_TRAFFIC
      Setting the "brokerexc.setdiag" Java System property to BrokerException.DIAG_SHOW_SOCKET_TRAFFIC will enable socket traffic diagnostics.
      Ex: System.setProperty("brokerexc.setdiag", BrokerException.DIAG_SHOW_SOCKET_TRAFFIC);
      See Also:

    • DIAG_SHOW_SOCKET_PARSING

      public static final int DIAG_SHOW_SOCKET_PARSING
      Setting the "brokerexc.setdiag" Java System property to BrokerException.DIAG_SHOW_SOCKET_PARSING will enable socket parsing diagnostics.
      Ex: System.setProperty("brokerexc.setdiag", BrokerException.DIAG_SHOW_SOCKET_PARSING);
      See Also:

    • DIAG_SHOW_QUEUE_INFO

      public static final int DIAG_SHOW_QUEUE_INFO
      Setting the "brokerexc.setdiag" Java System property to BrokerException.DIAG_SHOW_QUEUE_INFO will enable queue info diagnostics.
      Ex: System.setProperty("brokerexc.setdiag", BrokerException.DIAG_SHOW_QUEUE_INFO);
      See Also:

    • DIAG_SHOW_JAVA_API

      public static final int DIAG_SHOW_JAVA_API
      Setting the "brokerexc.setdiag" Java System property to BrokerException.DIAG_SHOW_JAVA_API will enable queue info diagnostics.
      Ex: System.setProperty("brokerexc.setdiag", BrokerException.DIAG_SHOW_JAVA_API);
      See Also:

    • DIAG_SHOW_ALL

      public static final int DIAG_SHOW_ALL
      Setting the "brokerexc.setdiag" Java System property to BrokerException.DIAG_SHOW_ALL will enable all diagnostics.
      Ex: System.setProperty("brokerexc.setdiag", BrokerException.DIAG_SHOW_ALL);
      See Also:

    • BROKER_EXCEPTION_SET_DIAG_LEVEL

      public static final String BROKER_EXCEPTION_SET_DIAG_LEVEL
      BrokerException.setDiagnostics(...) can now be set via the Java System property "brokerexc.setdiag" .

      See the public static final fields starting with DIAG_ for more possible diagnostics levels.

      See Also:

    • BROKER_EXCEPTION_SET_DIAG_FILE

      public static final String BROKER_EXCEPTION_SET_DIAG_FILE
      Broker Java API diagnostic tracing can now be redirected to a file via the Java System property "brokerexc.diagfile" .
      See Also:

    • MINOR_UNKNOWN_TRANSACTION

      public static final int MINOR_UNKNOWN_TRANSACTION
      See Also:

    • MINOR_TRANSACTION_CLOSED

      public static final int MINOR_TRANSACTION_CLOSED
      See Also:

    • MINOR_TRANSACTION_CLIENT_MISMATCH

      public static final int MINOR_TRANSACTION_CLIENT_MISMATCH
      See Also:

    • MINOR_TRANSACTION_NOT_OPEN

      public static final int MINOR_TRANSACTION_NOT_OPEN
      See Also:

    • MINOR_TRANSACTION_STATE_MISMATCH

      public static final int MINOR_TRANSACTION_STATE_MISMATCH
      See Also:

    • MINOR_TRANSACTION_HEURISTICALLY_COMMITTED

      public static final int MINOR_TRANSACTION_HEURISTICALLY_COMMITTED
      See Also:

    • MINOR_TRANSACTION_HEURISTICALLY_ROLLED_BACK

      public static final int MINOR_TRANSACTION_HEURISTICALLY_ROLLED_BACK
      See Also:

    • MINOR_TRANSACTION_HEURISTICALLY_ROLLED_BACK_TIMEOUT

      public static final int MINOR_TRANSACTION_HEURISTICALLY_ROLLED_BACK_TIMEOUT
      See Also:

    • MINOR_TRANSACTION_UNABLE_TO_REOPEN

      public static final int MINOR_TRANSACTION_UNABLE_TO_REOPEN
      See Also:

    • MINOR_TRANSACTION_INVALID_VALUE

      public static final int MINOR_TRANSACTION_INVALID_VALUE
      See Also:

    • MINOR_TRANSACTION_ID_NOT_VALID

      public static final int MINOR_TRANSACTION_ID_NOT_VALID
      See Also:

    • MINOR_TRANSACTION_ALREADY_PREPARED

      public static final int MINOR_TRANSACTION_ALREADY_PREPARED
      See Also:

    • MINOR_TRANSACTION_TIMEOUT_VALUE_INVALID

      public static final int MINOR_TRANSACTION_TIMEOUT_VALUE_INVALID
      See Also:

    • MINOR_TRANSACTION_ALREADY_EXISTS

      public static final int MINOR_TRANSACTION_ALREADY_EXISTS
      See Also:

    • MINOR_TRANSACTION_ALREADY_EXISTS_HEURISTICALLY

      public static final int MINOR_TRANSACTION_ALREADY_EXISTS_HEURISTICALLY
      See Also:

  • Constructor Details

    • BrokerException

      protected BrokerException(int ex_id, int ex_code, int ex_minor_code)
      System use only.

  • Method Details

    • toString

      public String toString()
      Get a printable version of the exception. Supports only US locale.
      Overrides:
      toString in class Throwable

    • toString

      public String toString(Locale locale)
      Get a printable version of the exception. Supports different locales.

    • toCompleteString

      public String toCompleteString()
      Get a printable version of the exception. This produces a longer form with additional information. Supports only US locale.

    • toCompleteString

      public String toCompleteString(Locale locale)
      Get a printable version of the exception. This produces a longer form with additional information. Support different locales.

    • getMessage

      public String getMessage()
      Get the message string for the exception without the error code and other information. Supports only US locale.
      Overrides:
      getMessage in class Throwable

    • getMessage

      public String getMessage(Locale locale)
      Get the message string for the exception without the error code and other information. Supports different locales.

    • logDebugMessage

      public static void logDebugMessage(String message)

    • getCode

      public int getCode()
      Get the exception code.

    • getMinorCode

      public int getMinorCode()
      Get the exception minor code.

    • setDiagnostics

      public static void setDiagnostics(int diag)
      Set the system diagnostics level. This controls how much output the program can send to the console.
      0 produces no output. 1 produces only major error output. 2 produces all error output.
      The default value is 1.
      See the public static final fields starting with DIAG_ for more possible diagnostics levels.

    • getDiagnostics

      public static int getDiagnostics()
      Get the system diagnostics level.