weblogic.management.configuration
Interface JMSSessionPoolMBean

All Superinterfaces:

ConfigurationMBean, JMSConstants

public interface JMSSessionPoolMBean
extends ConfigurationMBean, JMSConstants

This class represents a JMS session pool, a server-managed pool of server sessions that enables an application to process messages concurrently.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX."

Access limited to the following security roles:

Deployer

getConnectionConsumers

JMSConnectionConsumerMBean[] getConnectionConsumers()

Deprecated. 9.0.0.0 Replaced with message-driven beans.

The connection consumers for this JMS session pool. JMS connection consumers are queues (Point-To-Point) or topics (Pub/Sub) that retrieve server sessions and process messages. Once you have defined a session pool, you can configure one or more connection consumers for each session pool. This method is provided for backward compatibility.

Returns:

The connectionConsumers value

setConnectionConsumers

void setConnectionConsumers(JMSConnectionConsumerMBean[] consumers)
                            throws InvalidAttributeValueException

Deprecated. 9.0.0.0 Replaced with message-driven beans.

The connection consumers for this JMS session pool. JMS connection consumers are queues (Point-To-Point) or topics (Pub/Sub) that retrieve server sessions and process messages. Once you have defined a session pool, you can configure one or more connection consumers for each session pool. This method is provided for backward compatibility.

Throws:

InvalidAttributeValueException

addConnectionConsumer

boolean addConnectionConsumer(JMSConnectionConsumerMBean connectionConsumer)
                              throws InvalidAttributeValueException,
                                     DistributedManagementException

Deprecated. 9.0.0.0 Replaced with message-driven beans.

Add a connection consumer to the session pool. This method is provided for backward compatibility.

Parameters:

connectionConsumer - the connection consumer to add

Throws:

InvalidAttributeValueException

DistributedManagementException

Changes take effect after you redeploy the module or restart the server.

removeConnectionConsumer

boolean removeConnectionConsumer(JMSConnectionConsumerMBean connectionConsumer)
                                 throws InvalidAttributeValueException,
                                        DistributedManagementException

Deprecated. 9.0.0.0 Replaced with message-driven beans.

Remove a connection consumer from the session pool. This method is provided for backward compatibility.

Parameters:

connectionConsumer - a reference to JMSConnectionConsumerMBean

Throws:

InvalidAttributeValueException

DistributedManagementException

Changes take effect after you redeploy the module or restart the server.

getJMSConnectionConsumers

JMSConnectionConsumerMBean[] getJMSConnectionConsumers()

Deprecated. 

The connection consumers for this JMS session pool. JMS connection consumers are queues (Point-To-Point) or topics (Pub/Sub) that retrieve server sessions and process messages. Once you have defined a session pool, you can configure one or more connection consumers for each session pool.

Returns:

The connectionConsumers value

createJMSConnectionConsumer

JMSConnectionConsumerMBean createJMSConnectionConsumer(String name)
                                                       throws InvalidAttributeValueException,
                                                              DistributedManagementException

Deprecated. 

The connection consumers for this JMS session pool. JMS connection consumers are queues (Point-To-Point) or topics (Pub/Sub) that retrieve server sessions and process messages. Once you have defined a session pool, you can configure one or more connection consumers for each session pool.

Create a connection consumer for the session pool.

Parameters:

name - the name of the connection consumer to create

Throws:

InvalidAttributeValueException

DistributedManagementException

destroyJMSConnectionConsumer

void destroyJMSConnectionConsumer(JMSConnectionConsumerMBean connectionConsumer)

Deprecated. 

Remove a connection consumer from the session pool.

Parameters:

connectionConsumer - a reference to JMSConnectionConsumerMBean

lookupJMSConnectionConsumer

JMSConnectionConsumerMBean lookupJMSConnectionConsumer(String name)

Deprecated. 

Get a connection consumer from the session pool by name.

getConnectionFactory

String getConnectionFactory()

Deprecated. 

The JNDI name of the connection factory for this JMS session pool. Connection factories are used to create connections with predefined attributes.

Returns:

The connectionFactory value

setConnectionFactory

void setConnectionFactory(String connectionFactory)
                          throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ConnectionFactory attribute.

Parameters:

connectionFactory - The new connectionFactory value

Throws:

InvalidAttributeValueException

See Also:

JMSSessionPoolMBean.getConnectionFactory()

Default Value:

null

getListenerClass

String getListenerClass()

Deprecated. 

The name of the server-side listener class for this JMS session pool, which is used to receive and process messages concurrently.

Returns:

The listenerClass value

setListenerClass

void setListenerClass(String name)
                      throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ListenerClass attribute.

Parameters:

name - The new listenerClass value

Throws:

InvalidAttributeValueException

See Also:

JMSSessionPoolMBean.getListenerClass()

getAcknowledgeMode

String getAcknowledgeMode()

Deprecated. 

The acknowledge mode used by non-transacted sessions within this JMS session pool.

For transacted sessions, messages are acknowledged automatically when the session is committed and this value is ignored.

Returns:

The acknowledgeMode value

setAcknowledgeMode

void setAcknowledgeMode(String acknowledgeMode)
                        throws InvalidAttributeValueException

Deprecated. 

Sets the value of the AcknowledgeMode attribute.

Parameters:

acknowledgeMode - The new acknowledgeMode value

Throws:

InvalidAttributeValueException

See Also:

JMSSessionPoolMBean.getAcknowledgeMode()

Default Value:

JMSConstants.ACKNOWLEDGE_MODE_AUTO

Valid Values:

JMSConstants.ACKNOWLEDGE_MODE_AUTO, JMSConstants.ACKNOWLEDGE_MODE_CLIENT, JMSConstants.ACKNOWLEDGE_MODE_DUPS_OK, JMSConstants.ACKNOWLEDGE_MODE_NONE

getSessionsMaximum

int getSessionsMaximum()

Deprecated. 

The maximum number of sessions allowed for this JMS session pool. A value of -1 indicates that there is no maximum.

This attribute is dynamically configurable; however, it does not take effect until the session pool is restarted.

Returns:

The sessionsMaximum value

setSessionsMaximum

void setSessionsMaximum(int maxSessions)
                        throws InvalidAttributeValueException,
                               DistributedManagementException

Deprecated. 

Sets the value of the SessionsMaximum attribute.

Parameters:

maxSessions - The new sessionsMaximum value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSSessionPoolMBean.getSessionsMaximum()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

-1

isTransacted

boolean isTransacted()

Deprecated. 

Indicates whether this JMS session pool creates transacted sessions.

Returns:

The transacted value

setTransacted

void setTransacted(boolean transacted)
                   throws InvalidAttributeValueException

Deprecated. 

Sets the value of the Transacted attribute.

Parameters:

transacted - The new transacted value

Throws:

InvalidAttributeValueException

See Also:

JMSSessionPoolMBean.isTransacted()

Default Value:

false