类 MarshallingMessageConverter

构造器详细资料

• MarshallingMessageConverter

  public MarshallingMessageConverter()

  Construct a new MarshallingMessageConverter with no Marshaller or Unmarshaller set. The marshaller must be set after construction by invoking setMarshaller(Marshaller) and setUnmarshaller(Unmarshaller) .

• MarshallingMessageConverter

  public MarshallingMessageConverter​(Marshaller marshaller)

  Construct a new MarshallingMessageConverter with the given Marshaller set.

  If the given Marshaller also implements the Unmarshaller interface, it is used for both marshalling and unmarshalling. Otherwise, an exception is thrown.

  Note that all Marshaller implementations in Spring also implement the Unmarshaller interface, so that you can safely use this constructor.

  参数:

  marshaller - object used as marshaller and unmarshaller

  抛出:

  IllegalArgumentException - when marshaller does not implement the Unmarshaller interface as well

• MarshallingMessageConverter

  public MarshallingMessageConverter​(Marshaller marshaller,
                                     Unmarshaller unmarshaller)

  Construct a new MarshallingMessageConverter with the given Marshaller and Unmarshaller.

  参数:

  marshaller - the Marshaller to use

  unmarshaller - the Unmarshaller to use

方法详细资料

• setMarshaller

  public void setMarshaller​(Marshaller marshaller)

  Set the Marshaller to be used by this message converter.

• setUnmarshaller

  public void setUnmarshaller​(Unmarshaller unmarshaller)

  Set the Unmarshaller to be used by this message converter.

• setTargetType

  public void setTargetType​(MessageType targetType)

  Specify whether toMessage(Object, Session) should marshal to a BytesMessage or a TextMessage.

  The default is MessageType.BYTES, i.e. this converter marshals to a BytesMessage. Note that the default version of this converter supports MessageType.BYTES and MessageType.TEXT only.

  另请参阅:

  MessageType.BYTES, MessageType.TEXT

• afterPropertiesSet

  public void afterPropertiesSet()

  从接口复制的说明: InitializingBean
  Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

  This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

  指定者:

  afterPropertiesSet 在接口中 InitializingBean

• toMessage

  public Message toMessage​(Object object,
                           Session session)
                    throws JMSException,
                           MessageConversionException

  This implementation marshals the given object to a TextMessage or BytesMessage. The desired message type can be defined by setting the "marshalTo" property.

  指定者:

  toMessage 在接口中 MessageConverter

  参数:

  object - the object to convert

  session - the Session to use for creating a JMS Message

  返回:

  the JMS Message

  抛出:

  JMSException - if thrown by JMS API methods

  MessageConversionException - in case of conversion failure

  另请参阅:

  marshalToTextMessage(java.lang.Object, javax.jms.Session, org.springframework.oxm.Marshaller), marshalToBytesMessage(java.lang.Object, javax.jms.Session, org.springframework.oxm.Marshaller)

• fromMessage

  public Object fromMessage​(Message message)
                     throws JMSException,
                            MessageConversionException

  This implementation unmarshals the given Message into an object.

  指定者:

  fromMessage 在接口中 MessageConverter

  参数:

  message - the message to convert

  返回:

  the converted Java object

  抛出:

  JMSException - if thrown by JMS API methods

  MessageConversionException - in case of conversion failure

  另请参阅:

  unmarshalFromTextMessage(javax.jms.TextMessage, org.springframework.oxm.Unmarshaller), unmarshalFromBytesMessage(javax.jms.BytesMessage, org.springframework.oxm.Unmarshaller)

• marshalToTextMessage

  protected TextMessage marshalToTextMessage​(Object object,
                                             Session session,
                                             Marshaller marshaller)
                                      throws JMSException,
                                             IOException,
                                             XmlMappingException

  Marshal the given object to a TextMessage.

  参数:

  object - the object to be marshalled

  session - current JMS session

  marshaller - the marshaller to use

  返回:

  the resulting message

  抛出:

  JMSException - if thrown by JMS methods

  IOException - in case of I/O errors

  XmlMappingException - in case of OXM mapping errors

  另请参阅:

  Session.createTextMessage(), Marshaller.marshal(Object, Result)

• marshalToBytesMessage

  protected BytesMessage marshalToBytesMessage​(Object object,
                                               Session session,
                                               Marshaller marshaller)
                                        throws JMSException,
                                               IOException,
                                               XmlMappingException

  Marshal the given object to a BytesMessage.

  参数:

  object - the object to be marshalled

  session - current JMS session

  marshaller - the marshaller to use

  返回:

  the resulting message

  抛出:

  JMSException - if thrown by JMS methods

  IOException - in case of I/O errors

  XmlMappingException - in case of OXM mapping errors

  另请参阅:

  Session.createBytesMessage(), Marshaller.marshal(Object, Result)

• marshalToMessage

  protected Message marshalToMessage​(Object object,
                                     Session session,
                                     Marshaller marshaller,
                                     MessageType targetType)
                              throws JMSException,
                                     IOException,
                                     XmlMappingException

  Template method that allows for custom message marshalling. Invoked when setTargetType(org.springframework.jms.support.converter.MessageType) is not MessageType.TEXT or MessageType.BYTES.

  The default implementation throws an IllegalArgumentException.

  参数:

  object - the object to marshal

  session - the JMS session

  marshaller - the marshaller to use

  targetType - the target message type (other than TEXT or BYTES)

  返回:

  the resulting message

  抛出:

  JMSException - if thrown by JMS methods

  IOException - in case of I/O errors

  XmlMappingException - in case of OXM mapping errors

• unmarshalFromTextMessage

  protected Object unmarshalFromTextMessage​(TextMessage message,
                                            Unmarshaller unmarshaller)
                                     throws JMSException,
                                            IOException,
                                            XmlMappingException

  Unmarshal the given TextMessage into an object.

  参数:

  message - the message

  unmarshaller - the unmarshaller to use

  返回:

  the unmarshalled object

  抛出:

  JMSException - if thrown by JMS methods

  IOException - in case of I/O errors

  XmlMappingException - in case of OXM mapping errors

  另请参阅:

  Unmarshaller.unmarshal(Source)

• unmarshalFromBytesMessage

  protected Object unmarshalFromBytesMessage​(BytesMessage message,
                                             Unmarshaller unmarshaller)
                                      throws JMSException,
                                             IOException,
                                             XmlMappingException

  Unmarshal the given BytesMessage into an object.

  参数:

  message - the message

  unmarshaller - the unmarshaller to use

  返回:

  the unmarshalled object

  抛出:

  JMSException - if thrown by JMS methods

  IOException - in case of I/O errors

  XmlMappingException - in case of OXM mapping errors

  另请参阅:

  Unmarshaller.unmarshal(Source)

• unmarshalFromMessage

  protected Object unmarshalFromMessage​(Message message,
                                        Unmarshaller unmarshaller)
                                 throws JMSException,
                                        IOException,
                                        XmlMappingException

  Template method that allows for custom message unmarshalling. Invoked when fromMessage(Message) is invoked with a message that is not a TextMessage or BytesMessage.

  The default implementation throws an IllegalArgumentException.

  参数:

  message - the message

  unmarshaller - the unmarshaller to use

  返回:

  the unmarshalled object

  抛出:

  JMSException - if thrown by JMS methods

  IOException - in case of I/O errors

  XmlMappingException - in case of OXM mapping errors