com.ibm.websphere.sib.api.jms

Interface JmsManagedConnectionFactory

All Superinterfaces:
javax.jms.ConnectionFactory, java.io.Serializable
All known subinterfaces:
JmsConnectionFactory, JmsQueueConnectionFactory, JmsTopicConnectionFactory

  1. public interface JmsManagedConnectionFactory
  2. 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

Modifier and Type Method and Description
  1. java.lang.String
getBusName()
Retrieves the name of the bus to which Connections created from this ConnectionFactory will be connected.
  1. java.lang.String
getClientID()
Returns the default clientID for this Connections created from this ConnectionFactory.
  1. java.lang.String
getConnectionProximity()
Gets the connection proximity, which specifies the proximity of acceptable messaging engines.
  1. java.lang.String
getConsumerDoesNotModifyPayloadAfterGet()
Gets the property indicating if the consumer will modify the payload after getting it.
  1. java.lang.String
getDurableSubscriptionHome()
Retrieves the current value of the durable subscription home property.
  1. java.lang.String
getMulticastInterface()
Determines the network adapter to use for multicast transmissions on a multi-homed system.
  1. java.lang.String
getNonPersistentMapping()
Retrieve the Reliability that should be used for non persistent messages.
  1. java.lang.String
getPersistentMapping()
Retrieve the Reliability that should be used for persistent messages.
  1. java.lang.String
getProducerDoesNotModifyPayloadAfterSet()
Returns the property indicating if the producer will modify the payload after setting it.
  1. 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>}.
  1. java.lang.String
getReadAhead()
Retrieve the current setting for the ReadAhead property for this JmsConnectionFactory.
  1. java.lang.String
getShareDurableSubscriptions()
Gets the current setting for the policy towards sharing of durable subscriptions.
  1. java.lang.String
getSubscriptionProtocol()
Used to indicate the protocols that the client will accept for receiving messages.
  1. java.lang.String
getTarget()
Gets the target, the name of a target that resolves to a group of messaging engines.
  1. java.lang.String
getTargetSignificance()
Gets the target significance, which indicates the significance of the target group.
  1. 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.
  1. java.lang.String
getTargetType()
Gets the target type, specifying the type of name in the Target Group property.
  1. java.lang.String
getTemporaryQueueNamePrefix()
Gets the temporary queue name prefix.
  1. java.lang.String
getTemporaryTopicNamePrefix()
Gets the temporary topic name prefix.
  1. 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.
  1. boolean
isManaged()
Is this connection factory in a managed environment?
Methods inherited from interface javax.jms.ConnectionFactory
createConnection, createConnection

Method Detail

getClientID

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

Returns:
The clientID string
See Also:

getNonPersistentMapping

  1. 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:

getPersistentMapping

  1. 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:

isManaged

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

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

getReadAhead

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

Returns:
The current setting for ReadAhead.
See Also:

getDurableSubscriptionHome

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

Returns:
String The current durable subscription home property.
See Also:

getTemporaryQueueNamePrefix

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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:

getTargetSignificance

  1. java.lang.String getTargetSignificance( )
Gets the target significance, which indicates the significance of the target group.
Returns:
the target significance
See Also:

getTargetTransportChain

  1. 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

  1. 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

  1. 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:

getShareDurableSubscriptions

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

getMulticastInterface

  1. 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.
Throws:
javax.jms.JMSException

getSubscriptionProtocol

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

getProducerDoesNotModifyPayloadAfterSet

  1. 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

  1. java.lang.String getConsumerDoesNotModifyPayloadAfterGet( )
Gets the property indicating if the consumer will modify the payload after getting it.
Returns:
String containing the property value.