java.lang.AutoCloseable
, javax.jms.Connection
, javax.jms.QueueConnection
, javax.jms.TopicConnection
public interface WLConnection
javax.jms.Connection
.Connection
,
QueueConnection
,
TopicConnection
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
CLIENT_ID_POLICY_RESTRICTED |
Only one connection that uses this policy exists in a cluster at any given time for a particular
ClientID . |
static java.lang.String |
CLIENT_ID_POLICY_UNRESTRICTED |
Connections created using this policy can specify any
ClientID , even when other restricted
or unrestricted connections already use the same ClientID . |
static java.lang.String |
RECONNECT_POLICY_ALL |
|
static java.lang.String |
RECONNECT_POLICY_NONE |
|
static java.lang.String |
RECONNECT_POLICY_PRODUCER |
|
static java.lang.String |
SUBSCRIPTION_EXCLUSIVE |
All subscribers created using this connection do not share
subscriptions with any other subscribers.
|
static java.lang.String |
SUBSCRIPTION_SHARABLE |
Subscribers created using this connection factory can share their subscriptions
with other subscribers, regardless of whether those subscribers are created using
the same connection factory or a different connection factory.
|
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getClientIDPolicy() |
The ClientIdPolicy on this connection.
|
long |
getReconnectBlockingMillis() |
Deprecated.
12.2.1.3.0 The WebLogic JMS Automatic Reconnect feature is deprecated.
|
java.lang.String |
getReconnectPolicy() |
Deprecated.
12.2.1.3.0 The WebLogic JMS Automatic Reconnect feature is deprecated.
|
java.lang.String |
getSubscriptionSharingPolicy() |
The SubscriptionSharingPolicy on this connection.
|
long |
getTotalReconnectPeriodMillis() |
Deprecated.
12.2.1.3.0 The WebLogic JMS Automatic Reconnect feature is deprecated.
|
void |
setClientID(java.lang.String clientID,
java.lang.String clientIDPolicy) |
Sets the ClientID and ClientIdPolicy on the connection.
|
void |
setReconnectBlockingMillis(long timeout) |
Deprecated.
12.2.1.3.0 The WebLogic JMS Automatic Reconnect feature is deprecated.
|
void |
setReconnectPolicy(java.lang.String reconnectPolicy) |
Deprecated.
12.2.1.3.0 The WebLogic JMS Automatic Reconnect feature is deprecated.
|
void |
setSubscriptionSharingPolicy(java.lang.String subscriptionSharingPolicy) |
Sets the SubscriptionSharingPolicy on this connection.
|
void |
setTotalReconnectPeriodMillis(long timeout) |
Deprecated.
12.2.1.3.0 The WebLogic JMS Automatic Reconnect feature is deprecated.
|
static final java.lang.String RECONNECT_POLICY_NONE
static final java.lang.String RECONNECT_POLICY_PRODUCER
static final java.lang.String RECONNECT_POLICY_ALL
static final java.lang.String CLIENT_ID_POLICY_RESTRICTED
ClientID
.getClientIDPolicy()
,
setClientID(String,String)
static final java.lang.String CLIENT_ID_POLICY_UNRESTRICTED
ClientID
, even when other restricted
or unrestricted connections already use the same ClientID
.getClientIDPolicy()
,
setClientID(String,String)
static final java.lang.String SUBSCRIPTION_EXCLUSIVE
static final java.lang.String SUBSCRIPTION_SHARABLE
void setReconnectPolicy(java.lang.String reconnectPolicy) throws java.lang.IllegalArgumentException
Sets the JMS client reconnection policy after a lost network connection with a server or upon a server reboot.
weblogic.jms.extensions.WLConnection.RECONNECT_POLICY_NONE
-- Prevents reconnection attempts.weblogic.jms.extensions.WLConnection.RECONNECT_POLICY_PRODUCER
-- Explicitly refreshes Producer
objects and implicitly refreshes any related Session and Connection objects.
However, this value does not refresh Consumers, QueueBrowsers, and Connections with a configured ClientID
for a durable subscriber.weblogic.jms.extensions.WLConnection.RECONNECT_POLICY_ALL
-- Explicitly refreshes all Consumer and
Producer objects and implicitly refreshes any related Session and Connection objects.
However, this value does not refresh QueueBrowsers and Connections with a configured
ClientID for a durable subscriber.reconnectPolicy
- reconnectPolicy is the new reconnect policy.java.lang.IllegalArgumentException
- when the argument is not:
weblogic.jms.extensions.WLConnection.RECONNECT_POLICY_NONE
weblogic.jms.extensions.WLConnection.RECONNECT_POLICY_PRODUCER
weblogic.jms.extensions.WLConnection.RECONNECT_POLICY_ALLgetReconnectPolicy()
,
RECONNECT_POLICY_NONE
,
RECONNECT_POLICY_PRODUCER
,
RECONNECT_POLICY_ALL
,
WLMessage.getJMSRedeliveryLimit()
java.lang.String getReconnectPolicy()
setReconnectPolicy(java.lang.String)
void setReconnectBlockingMillis(long timeout) throws java.lang.IllegalArgumentException
Sets the maximum length of time that any synchronous JMS calls, such as a
producer.send()
, consumer.receive()
, or session.createBrowser()
,
will block the calling thread before giving up on a JMS client reconnect in progress.
timeout
- The number of milliseconds JMS operations will wait trying
to reconnect to a disconnected server before throwing a JMSException.
When the timeout is zero, the reconnect starts but this call does not block waiting for the reconnected objects.
When the timeout is -1, the call blocks as long as reconnects are possible. For example, send() can block until close() is called, and send() will throw a JMSException.
IllegalArgumentExcaption
- is thrown when timeout is less than -1.java.lang.IllegalArgumentException
getReconnectBlockingMillis()
long getReconnectBlockingMillis()
The maximum length of time that any synchronous JMS calls block the calling thread before giving up on a JMS client reconnect in progress.
setReconnectBlockingMillis(long)
void setTotalReconnectPeriodMillis(long timeout) throws java.lang.IllegalArgumentException
Sets the maximum length of time that JMS client operations continue to try to reconnect to the server after either the initial network disconnect or the last synchronous call attempt, whichever occurred most recently, before giving up retrying.
timeout
- The number of milliseconds that JMS reconnect timers are
permitted to reconnect a disconnected server.
When the timeout is -1, there is no limit. Reconnection timers are always scheduled until close() is called.
IllegalArgumentExcaption
- is thrown when timeout is less than -1.java.lang.IllegalArgumentException
getTotalReconnectPeriodMillis()
long getTotalReconnectPeriodMillis()
The maximum length of time that JMS client operations continue to try to reconnect to the server.
setTotalReconnectPeriodMillis(long)
void setClientID(java.lang.String clientID, java.lang.String clientIDPolicy) throws javax.jms.JMSException, java.lang.IllegalArgumentException
The ClientID and ClientIdPolicy can be set administratively through the connection
factory. If a client sets the ClientID explicitly, it must do so immediately after
it creates the connection and before any other action on the connection is taken. After
this point, setting the ClientID throws
an IllegalStateException
.
If the ClientID is specified on the connection factory, an attempt to use this setter to change it
throws IllegalStateException
. If the ClientIdPolicy is specified on the connection factory without
a ClientID, calling this setter with a ClientID and a different ClientIdPolicy
overrides the policy as well as sets the ClientID.
Note: A durable subscription that is created using a Unrestricted client
ID can only be unsubscribed using
WLSession.unsubscribe(String name, Topic topic) method. An attempt of
unsubscribing such a subscription using standard
javax.jms.Session.unsubscribe(String name) will get an
InvalidDestinationException
.
clientID
- the ClientID to be setclientIDPolicy
- the ClientIdPolicy to be setjavax.jms.JMSException
- if the JMS provider fails to set the client ID for this connection due
to some internal error.javax.jms.IllegalStateException
- if the JMS client attempts to set a connection's client ID at
the wrong time or when it has been administratively configured.javax.jms.InvalidClientIDException
- if the JMS client specifies an invalid or duplicate client ID using the RESTRICTED policy.java.lang.IllegalArgumentException
- if the policy is not valid.getClientIDPolicy()
,
CLIENT_ID_POLICY_RESTRICTED
,
CLIENT_ID_POLICY_UNRESTRICTED
java.lang.String getClientIDPolicy()
setClientID(String,String)
,
CLIENT_ID_POLICY_RESTRICTED
,
CLIENT_ID_POLICY_UNRESTRICTED
java.lang.String getSubscriptionSharingPolicy()
setSubscriptionSharingPolicy(java.lang.String)
,
SUBSCRIPTION_EXCLUSIVE
,
SUBSCRIPTION_SHARABLE
void setSubscriptionSharingPolicy(java.lang.String subscriptionSharingPolicy) throws javax.jms.JMSException, java.lang.IllegalArgumentException
subscriptionSharingPolicy
- new subscription sharing policy to be set.javax.jms.JMSException
- if the JMS provider fails to set the Subsrciption Sharing Policy for this
connection due to some internal error.java.lang.IllegalArgumentException
- if the policy is not validSUBSCRIPTION_EXCLUSIVE
,
SUBSCRIPTION_SHARABLE
,
getSubscriptionSharingPolicy()