Sonic Management API

com.sonicsw.mq.common.runtime
Class MFDurableOperationException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.sonicsw.mf.common.MFException
              extended by com.sonicsw.mq.common.runtime.MFDurableOperationException
All Implemented Interfaces:
java.io.Serializable

public class MFDurableOperationException
extends MFException

An MFDurableOperationException can be thrown from a number of methods that interact with durable subscriptions. If there is an error that is generated as a result of a runtime operation on a durable subscription, an MFDurableOperationException will be propagated via a ProxyRuntimeException to the application.

The MFDurableOperationException can be accessed via a MBeanException that can be retrieved via the ProxyRuntimeException.getTargetException() method. Use the MBeanException.getTargetException() method to retrieve the MFDurableOperationException. The MFDurableOperationException has a corresponding error code that can be utilized to further determine the cause of the exception. An explanation of the errors are provided for each code (see ERR_<> below).

See Also:
IBrokerProxy.closeBrowser( com.sonicsw.mq.common.runtime.IBrowseToken ), IBrokerProxy.createDurableBrowseToken(java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Boolean ), IBrokerProxy.createDurableBrowseTokenFromDSD(com.sonicsw.mq.common.runtime.IDurableSubscriptionData, java.lang.Boolean ), IBrokerProxy.createDurableMessageHeaderToken(java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.String ), IBrokerProxy.createDurableMessageHeaderTokenDSD( com.sonicsw.mq.common.runtime.IDurableSubscriptionData, java.lang.String ), IBrokerProxy.getBrowseMessages(com.sonicsw.mq.common.runtime.IBrowseToken, java.lang.Integer ), IBrokerProxy.getMessage(com.sonicsw.mq.common.runtime.IMessageHeaderToken), IBrokerProxy.removeMessage(com.sonicsw.mq.common.runtime.IMessageHeaderToken), IBrokerProxy.searchMessage(com.sonicsw.mq.common.runtime.IMessageHeaderToken), IBrokerProxy.setBrowseInactiveTimeout(com.sonicsw.mq.common.runtime.IBrowseToken, java.lang.Integer), ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException, Serialized Form

Field Summary
static int ERR_BROWSER_NOT_FOUND
          The browser is not found.
static int ERR_MESSAGE_NOT_FOUND
          The specified message is not found.
static int ERR_SUBSCRIBER_ACTIVE
          The durable subscriber is currently connected.
static int ERR_SUBSCRIBER_NOT_FOUND
          The specified subscriber is not found.
static int ERR_UNABLE_TO_COMPLETE
          The request was unable to complete due to a failure.
static int NO_ERROR
          There is no error
 
Constructor Summary
MFDurableOperationException(int errorcode)
          Create a durable operation exception
 
Method Summary
 int getErrorCode()
          Get the error code
 
Methods inherited from class com.sonicsw.mf.common.MFException
getMessage
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ERR_BROWSER_NOT_FOUND

public static final int ERR_BROWSER_NOT_FOUND
The browser is not found. The IBrowseToken provided does not correspond to any known IBrowseToken on this broker.

See Also:
Constant Field Values

ERR_MESSAGE_NOT_FOUND

public static final int ERR_MESSAGE_NOT_FOUND
The specified message is not found. The message could not be located in order to perform a search, remove, or retrieval of the message.

See Also:
Constant Field Values

ERR_SUBSCRIBER_ACTIVE

public static final int ERR_SUBSCRIBER_ACTIVE
The durable subscriber is currently connected. It is invalid to perform certain durable operations while the durable subscriber is still connected. This includes searching for a message, removing a message, retreiving a message, or browsing messages.

See Also:
Constant Field Values

ERR_SUBSCRIBER_NOT_FOUND

public static final int ERR_SUBSCRIBER_NOT_FOUND
The specified subscriber is not found. The subscriber information provided to utilize or create an IBrowseToken does not match any known durable subscriber.

See Also:
Constant Field Values

ERR_UNABLE_TO_COMPLETE

public static final int ERR_UNABLE_TO_COMPLETE
The request was unable to complete due to a failure. This may be due to a broker in a cluster becomming unavailable while browsing durable messages, or searching for a durable message.

See Also:
Constant Field Values

NO_ERROR

public static final int NO_ERROR
There is no error

See Also:
Constant Field Values
Constructor Detail

MFDurableOperationException

public MFDurableOperationException(int errorcode)
Create a durable operation exception

Parameters:
errorcode - The error code that indicates the type of error.
Method Detail

getErrorCode

public int getErrorCode()
Get the error code

Returns:
The error code

Sonic Management API

Copyright © 2001-2010 Progress Software Corporation. All Rights Reserved.
HTML formatted on 16-Sep-2010.