JmsAccessor (Spring Framework) - Spring Framework 1.2.9 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.jms.support
Class JmsAccessor

java.lang.Object
  org.springframework.jms.support.JmsAccessor

All Implemented Interfaces:: InitializingBean

Direct Known Subclasses:: JmsDestinationAccessor

public abstract class JmsAccessor
extends Object
implements InitializingBean
extends Object
implements InitializingBean

Base class for JmsTemplate and other JMS-accessing gateway helpers, defining common properties such as the ConnectionFactory. The subclass JmsDestinationAccessor adds further, destination-related properties.

Not intended to be used directly. See JmsTemplate.

Since:: 1.2
Author:: Juergen Hoeller
See Also:: JmsDestinationAccessor, JmsTemplate

Field Summary

protected Log logger


Constructor Summary

JmsAccessor()


Method Summary

void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

protected JmsException convertJmsAccessException(JMSException ex)
          Convert the specified checked JMSException to a Spring runtime JmsException equivalent.

ConnectionFactory getConnectionFactory()
          Return the ConnectionFactory that this accessor uses for obtaining JMS Connections.

int getSessionAcknowledgeMode()
          Return the acknowledgement mode for JMS Sessions.

boolean isSessionTransacted()
          Return whether the JMS Sessions used are transacted.

void setConnectionFactory(ConnectionFactory connectionFactory)
          Set the ConnectionFactory used for obtaining JMS Connections.

void setSessionAcknowledgeMode(int sessionAcknowledgeMode)
          Set the JMS acknowledgement mode that is used when creating a JMS Session.

void setSessionAcknowledgeModeName(String constantName)
          Set the JMS acknowledgement mode by the name of the corresponding constant in the JMS Session interface, e.g.

void setSessionTransacted(boolean sessionTransacted)
          Set the transaction mode that is used when creating a JMS Session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Summary
`protected Log`	`logger`

Constructor Summary
`JmsAccessor()`

Method Summary
`void`	`afterPropertiesSet()` Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
`protected JmsException`	`convertJmsAccessException(JMSException ex)` Convert the specified checked `JMSException` to a Spring runtime `JmsException` equivalent.
`ConnectionFactory`	`getConnectionFactory()` Return the ConnectionFactory that this accessor uses for obtaining JMS Connections.
`int`	`getSessionAcknowledgeMode()` Return the acknowledgement mode for JMS Sessions.
`boolean`	`isSessionTransacted()` Return whether the JMS Sessions used are transacted.
`void`	`setConnectionFactory(ConnectionFactory connectionFactory)` Set the ConnectionFactory used for obtaining JMS Connections.
`void`	`setSessionAcknowledgeMode(int sessionAcknowledgeMode)` Set the JMS acknowledgement mode that is used when creating a JMS Session.
`void`	`setSessionAcknowledgeModeName(String constantName)` Set the JMS acknowledgement mode by the name of the corresponding constant in the JMS Session interface, e.g.
`void`	`setSessionTransacted(boolean sessionTransacted)` Set the transaction mode that is used when creating a JMS Session.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

logger

protected final Log logger

Constructor Detail

JmsAccessor

public JmsAccessor()

Method Detail

setConnectionFactory

public void setConnectionFactory(ConnectionFactory connectionFactory)

Set the ConnectionFactory used for obtaining JMS Connections.

getConnectionFactory

public ConnectionFactory getConnectionFactory()

Return the ConnectionFactory that this accessor uses for obtaining JMS Connections.

setSessionTransacted

public void setSessionTransacted(boolean sessionTransacted)

Set the transaction mode that is used when creating a JMS Session. Default is "false".

Note that within a JTA transaction, the parameters passed to create(Queue/Topic)Session(boolean transacted, int acknowledgeMode) method are not taken into account. Depending on the J2EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since the accessor operates on an existing JMS Session in this case.

Parameters:: sessionTransacted - the transaction mode
See Also:: Connection.createSession(boolean, int)

isSessionTransacted

public boolean isSessionTransacted()

Return whether the JMS Sessions used are transacted.

setSessionAcknowledgeModeName

public void setSessionAcknowledgeModeName(String constantName)

Set the JMS acknowledgement mode by the name of the corresponding constant in the JMS Session interface, e.g. "CLIENT_ACKNOWLEDGE".

Parameters:: constantName - name of the constant
See Also:: Session.AUTO_ACKNOWLEDGE, Session.CLIENT_ACKNOWLEDGE, Session.DUPS_OK_ACKNOWLEDGE, Connection.createSession(boolean, int)

setSessionAcknowledgeMode

public void setSessionAcknowledgeMode(int sessionAcknowledgeMode)

Set the JMS acknowledgement mode that is used when creating a JMS Session. Vendor extensions to the acknowledgment mode can be set here as well. Default is "AUTO_ACKNOWLEDGE".

Note that that inside an EJB the parameters to create(Queue/Topic)Session(boolean transacted, int acknowledgeMode) method are not taken into account. Depending on the transaction context in the EJB, the container makes its own decisions on these values. See section 17.3.5 of the EJB Spec.

Parameters:: sessionAcknowledgeMode - the acknowledgement mode
See Also:: Session.AUTO_ACKNOWLEDGE, Session.CLIENT_ACKNOWLEDGE, Session.DUPS_OK_ACKNOWLEDGE, Connection.createSession(boolean, int)

getSessionAcknowledgeMode

public int getSessionAcknowledgeMode()

Return the acknowledgement mode for JMS Sessions.

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:: afterPropertiesSet in interface InitializingBean

convertJmsAccessException

protected JmsException convertJmsAccessException(JMSException ex)

Convert the specified checked JMSException to a Spring runtime JmsException equivalent.

Default implementation delegates to JmsUtils.

Parameters:: ex - the original checked JMSException to convert
Returns:: the Spring runtime JmsException wrapping ex
See Also:: JmsUtils.convertJmsAccessException(javax.jms.JMSException)