+

Search Tips | Advanced Search

.NET interfaces

This topic documents the .NET class interfaces and their properties and methods.

The following table summarizes all the interfaces, which are defined within the IBM.XMS namespace.

Table 1. Summary of the .NET class interfaces
Interface Description
IBytesMessage A bytes message is a message whose body comprises a stream of bytes.
IConnection A Connection object represents the active connection of the application to a messaging server.
IConnectionFactory An application uses a connection factory to create a connection.
IConnectionMetaData A ConnectionMetaData object provides information about a connection.
IDestination A destination is where an application sends messages, or it is a source from which an application receives messages, or both.
ExceptionListener An application uses an exception listener to be notified asynchronously of a problem with a connection.
IllegalStateException XMS throws this exception if an application calls a method at an incorrect or inappropriate time, or if XMS is not in an appropriate state for the requested operation.
InitialContext An application uses an InitialContext object to create objects from object definitions that are retrieved from a repository of administered objects.
InvalidClientIDException XMS throws this exception if an application attempts to set a client identifier for a connection, but the client identifier is not valid or is already in use.
InvalidDestinationException XMS throws this exception if an application specifies a destination that is not valid.
InvalidSelectorException XMS throws this exception if an application provides a message selector expression whose syntax is not valid.
IMapMessage A map message is a message whose body comprises a set of name-value pairs, where each value has an associated data type.
IMessage A Message object represents a message that an application sends or receives. IMessage is a superclass for the message classes such as IMapMessage.
IMessageConsumer An application uses a message consumer to receive messages sent to a destination.
MessageEOFException XMS throws this exception if XMS encounters the end of a bytes message stream when an application is reading the body of a bytes message.
MessageFormatException XMS throws this exception if XMS encounters a message with a format that is not valid.
IMessageListener (delegate) An application uses a message listener to receive messages asynchronously.
MessageNotReadableException XMS throws this exception if an application attempts to read the body of a message that is write only.
MessageNotWritableException XMS throws this exception if an application attempts to write to the body of a message that is read-only.
IMessageProducer An application uses a message producer to send messages to a destination.
IObjectMessage An object message is a message whose body comprises a serialized Java or .NET object.
IPropertyContext IPropertyContext is an abstract superclass that contains methods that get and set properties. These methods are inherited by other classes.
IQueueBrowser An application uses a queue browser to browse messages on a queue without removing them.
Requestor An application uses a requestor to send a request message and then wait for, and receive, the reply.
ResourceAllocationException XMS throws this exception if XMS cannot allocate the resources required by a method.
SecurityException XMS throws this exception if the user identifer and password provided to authenticate an application are rejected. XMS also throws this exception if an authority check fails and prevents a method from completing.
ISession A session is a single threaded context for sending and receiving messages.
IStreamMessage A stream message is a message whose body comprises a stream of values, where each value has an associated data type.
ITextMessage A text message is a message whose body comprises a string.
TransactionInProgressException XMS throws this exception if an application requests an operation that is not valid because a transaction is in progress.
TransactionRolledBackException XMS throws this exception if an application calls Session.commit() to commit the current transaction, but the transaction is then rolled back.
XMSC For .NET, XMS property names and values are defined in this class as public constants. For further details, see Properties of XMS objects.
XMSException If XMS detects an error while processing a call to a .NET method, XMS throws an exception. An exception is an object that encapsulates information about the error.

There are different types of XMS exception, and an XMSException object is just one type of exception. However, the XMSException class is a superclass of the other XMS exception classes. XMS throws an XMSException object in situations where none of the other types of exception are appropriate.
XMSFactoryFactory If an application is not using administered objects, use this class to create connection factories, queues, and topics.

The definition of each method lists the exception codes that XMS might return if it detects an error while processing a call to the method. Each exception code is represented by its named constant, which has a corresponding exception.