com.ibm.websphere.sib.api.jms

Interface JmsConnectionFactory

    • Method Detail

      • setBusName

        void setBusName(java.lang.String busName)
                        throws javax.jms.JMSException
        Set the name of the messaging bus to which you wish to connect when creating Connections using this ConnectionFactory object.

        The default value for this property is null, however this must be altered by the administrator/user to define the actual bus name. It will not be possible to create a connection with this property at its default value.

        Parameters:
        busName - The name of the bus to connect to.
        Throws:
        javax.jms.JMSException - If the supplied argument is not valid for this property - for example the busName parameter is null.
      • setClientID

        void setClientID(java.lang.String clientID)
                         throws javax.jms.JMSException
        Sets the clientID for this ConnectionFactory.

        The clientID property must be set to a non-null and non-empty value if durable subscriptions will be created or used from Connections created using this ConnectionFactory. Note that it is possible to set the clientID programmatically on the JMS Connection object.

        Note the getClientID method is inherited from the JmsManagedConnectionFactory interface.

        The default value for this property is null, however his must be changed by the administrator/user if durable subscriptions will be used.

        Parameters:
        clientID - the client ID
        Throws:
        javax.jms.JMSException - If the supplied clientID is not valid.
        See Also:
        JmsManagedConnectionFactory.getClientID(), Connection.setClientID(String)
      • setUserName

        void setUserName(java.lang.String userName)
                         throws javax.jms.JMSException
        Sets the default user name that will be used to create Connections from this ConnectionFactory when none is specified by the application or container.

        This property is null by default, but must be altered by the administrator or user if security is turned on, and the user name cannot be inherited from the container.

        Parameters:
        userName - the default user name
        Throws:
        javax.jms.JMSException - If the user name specified is violates any conditions (reserved for later use).
      • setPassword

        void setPassword(java.lang.String password)
                         throws javax.jms.JMSException
        Sets the default password that will be used to create Connections from this ConnectionFactory when none is specified by the application or container.

        This property is null by default, but must be altered by the administrator or user if security is turned on, and the password cannot be inherited from the container.

        Parameters:
        password - the default password
        Throws:
        javax.jms.JMSException - If the password specified is violates any conditions (reserved for later use).
      • setReadAhead

        void setReadAhead(java.lang.String value)
                          throws javax.jms.JMSException
        Set the required value for ReadAhead on all consumers created from this JmsConnectionFactory.

        The ReadAhead property defines whether messages may be pre-emptively streamed to remote client consumers of messages for the benefit of performance.

        Messages which are streamed to a consumer are locked on the server and may not be consumed by any other consumers of that destination. Messages which are streamed to the consumer but not consumed before the consumer is closed are subsequently unlocked on the server and available for receipt by other consumers.

        Permitted values for the ReadAhead property of a JmsConnectionFactory are as follows;



        Note that the value specified here may be overridden on a per Destination basis by use of the JmsDestination.setReadAhead(String) method.
        Parameters:
        value - The required value for ReadAhead on this JmsConnectionFactory
        Throws:
        javax.jms.JMSException - If the value specified is not one of the supported constants.
        See Also:
        ApiJmsConstants.READ_AHEAD_DEFAULT, ApiJmsConstants.READ_AHEAD_ON, ApiJmsConstants.READ_AHEAD_OFF, JmsDestination.setReadAhead(String)
      • setDurableSubscriptionHome

        void setDurableSubscriptionHome(java.lang.String home)
                                        throws javax.jms.JMSException
        Defines the name of the messaging engine used to store messages delivered to durable subscriptions created or used by objects created from this JmsConnectionFactory.

        Note that applications wishing to connect to a particular durable subscription must specify the same value for this property as was used when the durable subscription was created.

        This property must be specified on the ConnectionFactory before the Connection is created. Failure to do so will cause a javax.jms.IllegalStateException to be thrown by Session.createDurableSubscriber. The default value for this property is null, but this default does not allow applications to use durable subscriptions for the reasons described above.

        Parameters:
        home - The name of the messaging engine which is used to store durable subscriptions created through use of this JmsConnectionFactory.
        Throws:
        javax.jms.JMSException - Reserved for later use.
      • setSubscriptionHome

        void setSubscriptionHome(java.lang.String home)
                                 throws javax.jms.JMSException
        Defines the name of the messaging engine used to store messages delivered to subscriptions created or used by objects created from this JmsConnectionFactory.

        Note that applications wishing to connect to a particular subscription must specify the same value for this property as was used when the subscription was created.

        This property must be specified on the ConnectionFactory before the Connection is created. Failure to do so will cause a javax.jms.IllegalStateException to be thrown by Session.createDurableSubscriber (or) createSharedConsumer. The default value for this property is null, but this default does not allow applications to use subscriptions for the reasons described above.

        Parameters:
        home - The name of the messaging engine which is used to store subscriptions created through use of this JmsConnectionFactory.
        Throws:
        javax.jms.JMSException - Reserved for later use.
      • setTarget

        void setTarget(java.lang.String value)
                       throws javax.jms.JMSException
        Set the target, which is the name of a target that resolves to a group of messaging engines.

        The target is a bus member, custom user cluster or a messaging engine name.

        There is no default value for this property, which may be null.

        Parameters:
        value - The required value for targetGroup on this JmsConnectionFactory
        Throws:
        javax.jms.JMSException - if the value is badly formed
        See Also:
        setTargetSignificance(String), setTargetType(String)
      • setTargetTransportChain

        void setTargetTransportChain(java.lang.String value)
                                     throws javax.jms.JMSException
        Set the target transport chain, the name of the transport chain that should be used wjen connecting to a remote messaging engine.

        This is not the chain name specification string, but a short name that represents a particular chain.

        A null value is allowed, and results in the default value being used.

        Parameters:
        value - The required value for chain name on this JmsConnectionFactory
        Throws:
        javax.jms.JMSException - if the value is badly formed
      • setProviderEndpoints

        void setProviderEndpoints(java.lang.String value)
                                  throws javax.jms.JMSException
        Set the provider endpoints, which are a comma separated list of end point triples of the the form <host>:<port>:<chain>. If the host name is not specified a default of "localhost" will be used.

        If the port number is not specified then 7276 will be used as a default value.

        If the chain name is not specified for a triplet it will be defaulted to a predefined chain, eg "tcp/jfap".

        The default value for this property is null.

        Parameters:
        value - The provider endpoints to use
        Throws:
        javax.jms.JMSException - if the value is badly formed
      • setTemporaryQueueNamePrefix

        void setTemporaryQueueNamePrefix(java.lang.String prefix)
                                         throws javax.jms.JMSException
        Allows the user to supply a prefix of up to twelve characters of text that will be used as the beginning of the temporary destination name.

        There is a 12 character limit on the length of the prefix, which will result in a JMSException being thrown if this length is exceeded.

        The default for this property is null, which will result in no prefix being applied to temporary queue names.

        Parameters:
        prefix - The temporary queue prefix to be set.
        Throws:
        javax.jms.JMSException - if the prefix length limit is breached.
      • setTemporaryTopicNamePrefix

        void setTemporaryTopicNamePrefix(java.lang.String prefix)
                                         throws javax.jms.JMSException
        Allows the user to supply a prefix of up to twelve characters of text that will be used as the beginning of the temporary destination name.

        There is a 12 character limit on the length of the prefix, which will result in a JMSException being thrown if this length is exceeded.

        The default for this property is null, which will result in no prefix being applied to temporary topic names.

        Parameters:
        prefix - The temporary topic prefix to be set.
        Throws:
        javax.jms.JMSException - if the prefix length limit is breached.
      • setMulticastInterface

        void setMulticastInterface(java.lang.String multicastInterface)
                                   throws javax.jms.JMSException
        Determines the network adapter to use for multicast transmissions on a multi-homed system. If not set, the default adapter will be used.
        Parameters:
        multicastInterface -
        Throws:
        javax.jms.JMSException
      • setSubscriptionProtocol

        void setSubscriptionProtocol(java.lang.String protocol)
                                     throws javax.jms.JMSException
        Used to indicate the protocols that the client will accept for receiving messages. Only applicable to remote (tcp/ip) connections.
        Parameters:
        protocol -
        Throws:
        javax.jms.JMSException
      • setProducerDoesNotModifyPayloadAfterSet

        void setProducerDoesNotModifyPayloadAfterSet(java.lang.String propertyValue)
                                                     throws javax.jms.JMSException
        Sets the property that indicates if the producer will modify the payload after setting it.
        Parameters:
        propertyValue - containing the property value.
        Throws:
        javax.jms.JMSException - In the event of an invalid value
      • setConsumerDoesNotModifyPayloadAfterGet

        void setConsumerDoesNotModifyPayloadAfterGet(java.lang.String propertyValue)
                                                     throws javax.jms.JMSException
        Sets the property that indicates if the consumer will modify the payload after getting it.
        Parameters:
        propertyValue - containing the property value.
        Throws:
        javax.jms.JMSException - In the event of an invalid value
IBM WebSphere Application ServerTM
Release 9.0