IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.sib.api.jms
Interface JmsManagedConnectionFactory

All Superinterfaces:
javax.jms.ConnectionFactory, java.io.Serializable
All Known Subinterfaces:
JmsConnectionFactory, JmsQueueConnectionFactory, JmsTopicConnectionFactory

public interface JmsManagedConnectionFactory
extends javax.jms.ConnectionFactory, java.io.Serializable

Interface which provides read only access to some of the properties of a ConnectionFactory for use in the managed environment.

Note that this is a super interface of JmsConnectionFactory which provides setters for the getters defined here, and also getters and setters for other properties of the JmsConnectionFactory.

The ability of applications to use the other properties defined on JmsConnectionFactory is dependent on the environment in which it is being run.


Method Summary
 java.lang.String getBusName()
          Retrieves the name of the bus to which Connections created from this ConnectionFactory will be connected.
 java.lang.String getClientID()
          Returns the default clientID for this Connections created from this ConnectionFactory.
 java.lang.String getConnectionProximity()
          Gets the connection proximity, which specifies the proximity of acceptable messaging engines.
 java.lang.String getConsumerDoesNotModifyPayloadAfterGet()
          Gets the property indicating if the consumer will modify the payload after getting it.
 java.lang.String getDurableSubscriptionHome()
          Retrieves the current value of the durable subscription home property.
 java.lang.String getMulticastInterface()
          Determines the network adapter to use for multicast transmissions on a multi-homed system.
 java.lang.String getNonPersistentMapping()
          Retrieve the Reliability that should be used for non persistent messages.
 java.lang.String getPersistentMapping()
          Retrieve the Reliability that should be used for persistent messages.
 java.lang.String getProducerDoesNotModifyPayloadAfterSet()
          Returns the property indicating if the producer will modify the payload after setting it.
 java.lang.String getProviderEndpoints()
          Gets the provider endpoints, which are a comma separated list of end point triples of the the form {<host>:<port>:<chain>}.
 java.lang.String getReadAhead()
          Retrieve the current setting for the ReadAhead property for this JmsConnectionFactory.
 java.lang.String getShareDurableSubscriptions()
          Gets the current setting for the policy towards sharing of durable subscriptions.
 java.lang.String getSubscriptionProtocol()
          Used to indicate the protocols that the client will accept for receiving messages.
 java.lang.String getTarget()
          Gets the target, the name of a target that resolves to a group of messaging engines.
 java.lang.String getTargetSignificance()
          Gets the target significance, which indicates the significance of the target group.
 java.lang.String getTargetTransportChain()
          Gets the target transport chain, which is the name of the chain that should be used when connecting to a remote messaging engine.
 java.lang.String getTargetType()
          Gets the target type, specifying the type of name in the Target Group property.
 java.lang.String getTemporaryQueueNamePrefix()
          Gets the temporary queue name prefix.
 java.lang.String getTemporaryTopicNamePrefix()
          Gets the temporary topic name prefix.
 java.lang.String getUserName()
          Returns the default uesr name that will be used to create Connections when none is specified by the application or container.
 boolean isManaged()
          Is this connection factory in a managed environment?
 
Methods inherited from interface javax.jms.ConnectionFactory
createConnection, createConnection
 

Method Detail

getClientID

java.lang.String getClientID()
Returns the default clientID for this Connections created from this ConnectionFactory.

Returns:
The clientID string
See Also:
JmsConnectionFactory.setClientID(String)

getNonPersistentMapping

java.lang.String getNonPersistentMapping()
Retrieve the Reliability that should be used for non persistent messages.

Returns:
The current setting for reliability of non persistent messages.
See Also:
JmsConnectionFactory.setNonPersistentMapping(String)

getPersistentMapping

java.lang.String getPersistentMapping()
Retrieve the Reliability that should be used for persistent messages.

Returns:
The current setting for reliability of persistent messages.
See Also:
JmsConnectionFactory.setPersistentMapping(String)

isManaged

boolean isManaged()
Is this connection factory in a managed environment?

Returns:
true if in a managed environment, false otherwise.

getReadAhead

java.lang.String getReadAhead()
Retrieve the current setting for the ReadAhead property for this JmsConnectionFactory.

Returns:
The current setting for ReadAhead.
See Also:
JmsConnectionFactory.setReadAhead(String)

getDurableSubscriptionHome

java.lang.String getDurableSubscriptionHome()
Retrieves the current value of the durable subscription home property.

Returns:
String The current durable subscription home property.
See Also:
JmsConnectionFactory.setDurableSubscriptionHome(String)

getTemporaryQueueNamePrefix

java.lang.String getTemporaryQueueNamePrefix()
Gets the temporary queue name prefix.

Will return null if the prefix has not been set.

Returns:
String The temporary queue name prefix.

getTemporaryTopicNamePrefix

java.lang.String getTemporaryTopicNamePrefix()
Gets the temporary topic name prefix.

Will return null if the prefix has not been set.

Returns:
The temporary queue name prefix.

getBusName

java.lang.String getBusName()
Retrieves the name of the bus to which Connections created from this ConnectionFactory will be connected.

Returns:
The name of the bus to connect to.

getUserName

java.lang.String getUserName()
Returns the default uesr name that will be used to create Connections when none is specified by the application or container.

Returns:
the default user name

getTarget

java.lang.String getTarget()
Gets the target, the name of a target that resolves to a group of messaging engines.

May return null if value has not been set.

Returns:
the target

getTargetType

java.lang.String getTargetType()
Gets the target type, specifying the type of name in the Target Group property. Will be set to ApiJmsConstants.TARGET_TYPE_BUSMEMBER by default.

Returns:
the target type
See Also:
ApiJmsConstants.TARGET_TYPE_BUSMEMBER, ApiJmsConstants.TARGET_TYPE_CUSTOM, ApiJmsConstants.TARGET_TYPE_ME

getTargetSignificance

java.lang.String getTargetSignificance()
Gets the target significance, which indicates the significance of the target group.

Returns:
the target significance
See Also:
ApiJmsConstants.TARGET_SIGNIFICANCE_PREFERRED, ApiJmsConstants.TARGET_SIGNIFICANCE_REQUIRED

getTargetTransportChain

java.lang.String getTargetTransportChain()
Gets the target transport chain, which is the name of the chain that should be used when connecting to a remote messaging engine.

Returns:
the target transport chain

getProviderEndpoints

java.lang.String getProviderEndpoints()
Gets the provider endpoints, which are a comma separated list of end point triples of the the form {<host>:<port>:<chain>}.

The default value for this property is null.

Returns:
the provider endpoints

getConnectionProximity

java.lang.String getConnectionProximity()
Gets the connection proximity, which specifies the proximity of acceptable messaging engines. Will be set to ApiJmsConstants.CONNECTION_PROXIMITY_BUS by default.

Returns:
the connection proximity
See Also:
ApiJmsConstants.CONNECTION_PROXIMITY_BUS

getShareDurableSubscriptions

java.lang.String getShareDurableSubscriptions()
Gets the current setting for the policy towards sharing of durable subscriptions.

See Also:
JmsConnectionFactory.setShareDurableSubscriptions(String)

getMulticastInterface

java.lang.String getMulticastInterface()
Determines the network adapter to use for multicast transmissions on a multi-homed system. If not set, the default adapter will be used.

Parameters:
the - multicast interface property
Throws:
javax.jms.JMSException

getSubscriptionProtocol

java.lang.String getSubscriptionProtocol()
Used to indicate the protocols that the client will accept for receiving messages. Only applicable to remote (tcp/ip) connections.

Parameters:
the - subscription protocol property
Throws:
javax.jms.JMSException

getProducerDoesNotModifyPayloadAfterSet

java.lang.String getProducerDoesNotModifyPayloadAfterSet()
Returns the property indicating if the producer will modify the payload after setting it.

Returns:
String containing the property value.

getConsumerDoesNotModifyPayloadAfterGet

java.lang.String getConsumerDoesNotModifyPayloadAfterGet()
Gets the property indicating if the consumer will modify the payload after getting it.

Returns:
String containing the property value.

IBM WebSphere Application ServerTM
Release 7