Package akka.camel

Class CamelMessage

  • All Implemented Interfaces:
    java.io.Serializable, scala.Equals, scala.Product, scala.Serializable

    public class CamelMessage
    extends java.lang.Object
    implements scala.Serializable, scala.Product
    Deprecated.
    Akka Camel is deprecated in favour of 'Alpakka', the Akka Streams based collection of integrations to various endpoints (including Camel). Since 2.5.0.
    An immutable representation of a Camel message.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      CamelMessage​(java.lang.Object body, java.util.Map<java.lang.String,​java.lang.Object> headers)
      Deprecated.
       
      CamelMessage​(java.lang.Object body, java.util.Map<java.lang.String,​java.lang.Object> headers, java.util.Map<java.lang.String,​javax.activation.DataHandler> attachments)
      Deprecated.
       
      CamelMessage​(java.lang.Object body, scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers)
      Deprecated.
       
      CamelMessage​(java.lang.Object body, scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers, scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments)
      Deprecated.
       
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static CamelMessage apply​(java.lang.Object body, scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers)
      Deprecated.
      Returns a new CamelMessage based on the body and headers.
      static CamelMessage apply​(java.lang.Object body, scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers, scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments)
      Deprecated.
      Returns a new CamelMessage based on the body, headers and attachments.
      scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments()
      Deprecated.
       
      scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments​(scala.collection.immutable.Set<java.lang.String> names)
      Deprecated.
      Returns those attachments from this message whose name is contained in names.
      java.lang.Object body()
      Deprecated.
       
      <T> T bodyAs​(scala.reflect.ClassTag<T> t, org.apache.camel.CamelContext camelContext)
      Deprecated.
      Returns the body of the message converted to the type T.
      boolean canEqual​(java.lang.Object that)
      Deprecated.
      Indicates if some other object can be compared (based on type).
      static CamelMessage canonicalize​(java.lang.Object msg)
      Deprecated.
      Creates a canonical form of the given message msg.
      CamelMessage copy​(java.lang.Object body, scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers)
      Deprecated.
       
      java.lang.Object copy$default$1()
      Deprecated.
       
      scala.collection.immutable.Map<java.lang.String,​java.lang.Object> copy$default$2()
      Deprecated.
       
      static void copyContent​(CamelMessage from, org.apache.camel.Message to)
      Deprecated.
      INTERNAL API copies the content of this CamelMessageWithAttachments to an Apache Camel Message.
      boolean equals​(java.lang.Object that)
      Deprecated.
      Indicates whether some other object is "equal to" this one.
      static CamelMessage from​(org.apache.camel.Message camelMessage, scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers)
      Deprecated.
      Creates a new CamelMessage object from the Camel message.
      static CamelMessage from​(org.apache.camel.Message camelMessage, scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers, scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments)
      Deprecated.
      Creates a new CamelMessageWithAttachments object from the Camel message.
      java.util.Map<java.lang.String,​javax.activation.DataHandler> getAttachments()
      Deprecated.
      Java API: Returns all attachments from this message.
      java.util.Map<java.lang.String,​javax.activation.DataHandler> getAttachments​(java.util.Set<java.lang.String> names)
      Deprecated.
      Java API: Returns those attachments from this message whose name is contained in names.
      <T> T getBodyAs​(java.lang.Class<T> clazz, org.apache.camel.CamelContext camelContext)
      Deprecated.
      Java API: Returns the body of the message converted to the type as given by the clazz parameter.
      <T> T getHeaderAs​(java.lang.String name, java.lang.Class<T> clazz, org.apache.camel.CamelContext camelContext)
      Deprecated.
      Java API: Returns the header by given name parameter.
      java.util.Map<java.lang.String,​java.lang.Object> getHeaders()
      Deprecated.
      Java API: Returns all headers from this message.
      java.util.Map<java.lang.String,​java.lang.Object> getHeaders​(java.util.Set<java.lang.String> names)
      Deprecated.
      Java API: Returns those headers from this message whose name is contained in names.
      int hashCode()
      Deprecated.
      Returns a hash code value for the object.
      <T> scala.util.Try<T> headerAs​(java.lang.String name, scala.reflect.ClassTag<T> t, org.apache.camel.CamelContext camelContext)
      Deprecated.
      Returns the header by given name parameter in a Try.
      scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers()
      Deprecated.
       
      scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers​(scala.collection.immutable.Set<java.lang.String> names)
      Deprecated.
      Returns those headers from this message whose name is contained in names.
      <A,​B>
      CamelMessage
      mapBody​(Mapper<A,​B> transformer)
      Deprecated.
      Java API: Returns a new CamelMessage with a transformed body using a transformer function.
      <A,​B>
      CamelMessage
      mapBody​(scala.Function1<A,​B> transformer)
      Deprecated.
      Returns a new CamelMessage with a transformed body using a transformer function.
      static java.lang.String MessageExchangeId()
      Deprecated.
      CamelMessage header to correlate request with response messages.
      int productArity()
      Deprecated.
      Returns the size of this product.
      java.lang.Object productElement​(int n)
      Deprecated.
      Returns the n-th element of this product, 0-based.
      static scala.collection.Iterator<java.lang.Object> productIterator()
      Deprecated.
       
      static java.lang.String productPrefix()
      Deprecated.
       
      void resetStreamCache()
      Deprecated.
      Reset StreamCache body.
      java.lang.String toString()
      Deprecated.
       
      static scala.Option<scala.Tuple2<java.lang.Object,​scala.collection.immutable.Map<java.lang.String,​java.lang.Object>>> unapply​(CamelMessage camelMessage)
      Deprecated.
      Returns Some(body, headers).
      CamelMessage withAttachments​(java.util.Map<java.lang.String,​javax.activation.DataHandler> attachments)
      Deprecated.
      Java API: Creates a new CamelMessage with given attachments.
      CamelMessage withAttachments​(scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments)
      Deprecated.
      SCALA API: Creates a new CamelMessage with given attachments.
      <T> CamelMessage withBody​(T body)
      Deprecated.
      Java API: Returns a new CamelMessage with a new body, while keeping the same headers.
      <T> CamelMessage withBodyAs​(java.lang.Class<T> clazz, org.apache.camel.CamelContext camelContext)
      Deprecated.
      Java API: Creates a CamelMessage with current body converted to type clazz.
      <T> CamelMessage withBodyAs​(scala.reflect.ClassTag<T> t, org.apache.camel.CamelContext camelContext)
      Deprecated.
      Creates a CamelMessage with current body converted to type T.
      <A> CamelMessage withHeaders​(java.util.Map<java.lang.String,​A> headers)
      Deprecated.
      Java API: Creates a new CamelMessage with given headers.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface scala.Product

        productIterator, productPrefix
    • Constructor Detail

      • CamelMessage

        public CamelMessage​(java.lang.Object body,
                            scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers,
                            scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments)
        Deprecated.
      • CamelMessage

        public CamelMessage​(java.lang.Object body,
                            java.util.Map<java.lang.String,​java.lang.Object> headers)
        Deprecated.
      • CamelMessage

        public CamelMessage​(java.lang.Object body,
                            java.util.Map<java.lang.String,​java.lang.Object> headers,
                            java.util.Map<java.lang.String,​javax.activation.DataHandler> attachments)
        Deprecated.
      • CamelMessage

        public CamelMessage​(java.lang.Object body,
                            scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers)
        Deprecated.
    • Method Detail

      • apply

        public static CamelMessage apply​(java.lang.Object body,
                                         scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers)
        Deprecated.
        Returns a new CamelMessage based on the body and headers.
        Parameters:
        body - (undocumented)
        headers - (undocumented)
        Returns:
        (undocumented)
      • apply

        public static CamelMessage apply​(java.lang.Object body,
                                         scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers,
                                         scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments)
        Deprecated.
        Returns a new CamelMessage based on the body, headers and attachments.
        Parameters:
        body - (undocumented)
        headers - (undocumented)
        attachments - (undocumented)
        Returns:
        (undocumented)
      • unapply

        public static scala.Option<scala.Tuple2<java.lang.Object,​scala.collection.immutable.Map<java.lang.String,​java.lang.Object>>> unapply​(CamelMessage camelMessage)
        Deprecated.
        Returns Some(body, headers).
        Parameters:
        camelMessage - (undocumented)
        Returns:
        (undocumented)
      • MessageExchangeId

        public static java.lang.String MessageExchangeId()
        Deprecated.
        CamelMessage header to correlate request with response messages. Applications that send messages to a Producer actor may want to set this header on the request message so that it can be correlated with an asynchronous response. Messages send to Consumer actors have this header already set.
        Returns:
        (undocumented)
      • canonicalize

        public static CamelMessage canonicalize​(java.lang.Object msg)
        Deprecated.
        Creates a canonical form of the given message msg. If msg of type CamelMessage then msg is returned, otherwise msg is set as body of a newly created CamelMessage object.
        Parameters:
        msg - (undocumented)
        Returns:
        (undocumented)
      • from

        public static CamelMessage from​(org.apache.camel.Message camelMessage,
                                        scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers)
        Deprecated.
        Creates a new CamelMessage object from the Camel message.

        Parameters:
        headers - additional headers to set on the created CamelMessage in addition to those in the Camel message.
        camelMessage - (undocumented)
        Returns:
        (undocumented)
      • from

        public static CamelMessage from​(org.apache.camel.Message camelMessage,
                                        scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers,
                                        scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments)
        Deprecated.
        Creates a new CamelMessageWithAttachments object from the Camel message.

        Parameters:
        headers - additional headers to set on the created CamelMessageWithAttachments in addition to those in the Camel message.
        attachments - additional attachments to set on the created CamelMessageWithAttachments in addition to those in the Camel message.
        camelMessage - (undocumented)
        Returns:
        (undocumented)
      • copyContent

        public static void copyContent​(CamelMessage from,
                                       org.apache.camel.Message to)
        Deprecated.
        INTERNAL API copies the content of this CamelMessageWithAttachments to an Apache Camel Message.
        Parameters:
        from - (undocumented)
        to - (undocumented)
      • productIterator

        public static scala.collection.Iterator<java.lang.Object> productIterator()
        Deprecated.
      • productPrefix

        public static java.lang.String productPrefix()
        Deprecated.
      • body

        public java.lang.Object body()
        Deprecated.
      • headers

        public scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers()
        Deprecated.
      • attachments

        public scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments()
        Deprecated.
      • copy

        public CamelMessage copy​(java.lang.Object body,
                                 scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers)
        Deprecated.
      • copy$default$1

        public java.lang.Object copy$default$1()
        Deprecated.
      • copy$default$2

        public scala.collection.immutable.Map<java.lang.String,​java.lang.Object> copy$default$2()
        Deprecated.
      • toString

        public java.lang.String toString()
        Deprecated.
        Overrides:
        toString in class java.lang.Object
      • headers

        public scala.collection.immutable.Map<java.lang.String,​java.lang.Object> headers​(scala.collection.immutable.Set<java.lang.String> names)
        Deprecated.
        Returns those headers from this message whose name is contained in names.
        Parameters:
        names - (undocumented)
        Returns:
        (undocumented)
      • getHeaders

        public java.util.Map<java.lang.String,​java.lang.Object> getHeaders​(java.util.Set<java.lang.String> names)
        Deprecated.
        Java API: Returns those headers from this message whose name is contained in names. The returned headers map is backed up by an immutable headers map. Any attempt to modify the returned map will throw an exception.
        Parameters:
        names - (undocumented)
        Returns:
        (undocumented)
      • getHeaders

        public java.util.Map<java.lang.String,​java.lang.Object> getHeaders()
        Deprecated.
        Java API: Returns all headers from this message. The returned headers map is backed up by this message's immutable headers map. Any attempt to modify the returned map will throw an exception.
        Returns:
        (undocumented)
      • withHeaders

        public <A> CamelMessage withHeaders​(java.util.Map<java.lang.String,​A> headers)
        Deprecated.
        Java API: Creates a new CamelMessage with given headers. A copy of the headers map is made.
        Parameters:
        headers - (undocumented)
        Returns:
        (undocumented)
      • headerAs

        public <T> scala.util.Try<T> headerAs​(java.lang.String name,
                                              scala.reflect.ClassTag<T> t,
                                              org.apache.camel.CamelContext camelContext)
        Deprecated.
        Returns the header by given name parameter in a Try. The header is converted to type T, which is returned in a Success. If an exception occurs during the conversion to the type T or when the header cannot be found, the exception is returned in a Failure.

        The CamelContext is accessible in a UntypedConsumerActor and UntypedProducerActor using the getCamelContext method, and is available on the CamelExtension.

        Parameters:
        name - (undocumented)
        t - (undocumented)
        camelContext - (undocumented)
        Returns:
        (undocumented)
      • getHeaderAs

        public <T> T getHeaderAs​(java.lang.String name,
                                 java.lang.Class<T> clazz,
                                 org.apache.camel.CamelContext camelContext)
        Deprecated.
        Java API: Returns the header by given name parameter. The header is converted to type T as defined by the clazz parameter. An exception is thrown when the conversion to the type T fails or when the header cannot be found.

        The CamelContext is accessible in a UntypedConsumerActor and UntypedProducerActor using the getCamelContext method, and is available on the CamelExtension.

        Parameters:
        name - (undocumented)
        clazz - (undocumented)
        camelContext - (undocumented)
        Returns:
        (undocumented)
      • mapBody

        public <A,​B> CamelMessage mapBody​(scala.Function1<A,​B> transformer)
        Deprecated.
        Returns a new CamelMessage with a transformed body using a transformer function. This method will throw a ClassCastException if the body cannot be mapped to type A.
        Parameters:
        transformer - (undocumented)
        Returns:
        (undocumented)
      • mapBody

        public <A,​B> CamelMessage mapBody​(Mapper<A,​B> transformer)
        Deprecated.
        Java API: Returns a new CamelMessage with a transformed body using a transformer function. This method will throw a ClassCastException if the body cannot be mapped to type A.
        Parameters:
        transformer - (undocumented)
        Returns:
        (undocumented)
      • bodyAs

        public <T> T bodyAs​(scala.reflect.ClassTag<T> t,
                            org.apache.camel.CamelContext camelContext)
        Deprecated.
        Returns the body of the message converted to the type T. Conversion is done using Camel's type converter. The type converter is obtained from the CamelContext that is passed in. The CamelContext is accessible in a UntypedConsumerActor and UntypedProducerActor using the getCamelContext method, and is available on the CamelExtension.
        Parameters:
        t - (undocumented)
        camelContext - (undocumented)
        Returns:
        (undocumented)
      • getBodyAs

        public <T> T getBodyAs​(java.lang.Class<T> clazz,
                               org.apache.camel.CamelContext camelContext)
        Deprecated.
        Java API: Returns the body of the message converted to the type as given by the clazz parameter. Conversion is done using Camel's type converter. The type converter is obtained from the CamelContext that is passed in.

        The CamelContext is accessible in a UntypedConsumerActor and UntypedProducerActor using the getCamelContext method, and is available on the CamelExtension.

        Parameters:
        clazz - (undocumented)
        camelContext - (undocumented)
        Returns:
        (undocumented)
      • resetStreamCache

        public void resetStreamCache()
        Deprecated.
        Reset StreamCache body. Nothing is done if the body is not a StreamCache. See http://camel.apache.org/stream-caching.html
      • withBody

        public <T> CamelMessage withBody​(T body)
        Deprecated.
        Java API: Returns a new CamelMessage with a new body, while keeping the same headers.
        Parameters:
        body - (undocumented)
        Returns:
        (undocumented)
      • withBodyAs

        public <T> CamelMessage withBodyAs​(scala.reflect.ClassTag<T> t,
                                           org.apache.camel.CamelContext camelContext)
        Deprecated.
        Creates a CamelMessage with current body converted to type T. The CamelContext is accessible in a UntypedConsumerActor and UntypedProducerActor using the getCamelContext method, and is available on the CamelExtension.
        Parameters:
        t - (undocumented)
        camelContext - (undocumented)
        Returns:
        (undocumented)
      • withBodyAs

        public <T> CamelMessage withBodyAs​(java.lang.Class<T> clazz,
                                           org.apache.camel.CamelContext camelContext)
        Deprecated.
        Java API: Creates a CamelMessage with current body converted to type clazz.

        The CamelContext is accessible in a UntypedConsumerActor and UntypedProducerActor using the getCamelContext method, and is available on the CamelExtension.

        Parameters:
        clazz - (undocumented)
        camelContext - (undocumented)
        Returns:
        (undocumented)
      • attachments

        public scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments​(scala.collection.immutable.Set<java.lang.String> names)
        Deprecated.
        Returns those attachments from this message whose name is contained in names.
        Parameters:
        names - (undocumented)
        Returns:
        (undocumented)
      • getAttachments

        public java.util.Map<java.lang.String,​javax.activation.DataHandler> getAttachments​(java.util.Set<java.lang.String> names)
        Deprecated.
        Java API: Returns those attachments from this message whose name is contained in names. The returned headers map is backed up by an immutable headers map. Any attempt to modify the returned map will throw an exception.
        Parameters:
        names - (undocumented)
        Returns:
        (undocumented)
      • getAttachments

        public java.util.Map<java.lang.String,​javax.activation.DataHandler> getAttachments()
        Deprecated.
        Java API: Returns all attachments from this message. The returned attachments map is backed up by this message's immutable headers map. Any attempt to modify the returned map will throw an exception.
        Returns:
        (undocumented)
      • withAttachments

        public CamelMessage withAttachments​(java.util.Map<java.lang.String,​javax.activation.DataHandler> attachments)
        Deprecated.
        Java API: Creates a new CamelMessage with given attachments. A copy of the attachments map is made.
        Parameters:
        attachments - (undocumented)
        Returns:
        (undocumented)
      • withAttachments

        public CamelMessage withAttachments​(scala.collection.immutable.Map<java.lang.String,​javax.activation.DataHandler> attachments)
        Deprecated.
        SCALA API: Creates a new CamelMessage with given attachments.
        Parameters:
        attachments - (undocumented)
        Returns:
        (undocumented)
      • equals

        public boolean equals​(java.lang.Object that)
        Deprecated.
        Indicates whether some other object is "equal to" this one.
        Specified by:
        equals in interface scala.Equals
        Overrides:
        equals in class java.lang.Object
        Parameters:
        that - (undocumented)
        Returns:
        (undocumented)
      • hashCode

        public int hashCode()
        Deprecated.
        Returns a hash code value for the object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        (undocumented)
      • productElement

        public java.lang.Object productElement​(int n)
        Deprecated.
        Returns the n-th element of this product, 0-based.
        Specified by:
        productElement in interface scala.Product
        Parameters:
        n - (undocumented)
        Returns:
        (undocumented)
      • productArity

        public int productArity()
        Deprecated.
        Returns the size of this product.
        Specified by:
        productArity in interface scala.Product
        Returns:
        (undocumented)
      • canEqual

        public boolean canEqual​(java.lang.Object that)
        Deprecated.
        Indicates if some other object can be compared (based on type). This method should be called from every well-designed equals method that is open to be overridden in a subclass.
        Specified by:
        canEqual in interface scala.Equals
        Parameters:
        that - (undocumented)
        Returns:
        (undocumented)