KMConnectionFactory Class Reference
Inherits from | KCObject : NSObject |
Declared in | KMConnectionFactory.h |
Overview
A KMConnectionFactory object encapsulates a set of connection configuration parameters that has been defined by an administrator. A client uses it to create a connection with a JMS provider.
A KMConnectionFactory object is a JMS administered object and supports concurrent use.
JMS administered objects are objects containing configuration information that are created by an administrator and later used by JMS clients. They make it practical to administer the JMS API in the enterprise.
Clients should think of administered objects as local objects. Looking them up should not have any hidden side effects or use surprising amounts of local resources.
Warning: Use KMStompConnectionFactory to create JMS Connections.
Tasks
-
– createConnection
Creates a connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the [KMConnection start] method is explicitly called.
-
– createConnectionWithUsername:password:
Creates a connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the [KMConnection start] method is explicitly called.
Instance Methods
createConnection
Creates a connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the [KMConnection start] method is explicitly called.
- (KMConnection *)createConnection
Return Value
a newly created connection
Exceptions
- KMJMSException
if the JMS provider fails to create the connection due to some internal error.
- KMJMSSecurityException
if client authentication fails due to an invalid user name or password.
Declared In
KMConnectionFactory.h
createConnectionWithUsername:password:
Creates a connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the [KMConnection start] method is explicitly called.
- (KMConnection *)createConnectionWithUsername:(NSString *)userName password:(NSString *)password
Parameters
- userName
the caller’s user name
- password
the caller’s password
Return Value
a newly created connection
Exceptions
- KMJMSException
if the JMS provider fails to create the connection due to some internal error.
- KMJMSSecurityException
if client authentication fails due to an invalid user name or password.
Declared In
KMConnectionFactory.h