Package org.oasis_open.docs.ebxml_msg.ebms.v3_0.ns.core._200704

Class Messaging

  • public class Messaging
extends Object
    The eb:Messaging element is the top element of ebMS-3 headers, and it is placed within the SOAP Header element (either SOAP 1.1 or SOAP 1.2). The eb:Messaging element may contain several instances of eb:SignalMessage and eb:UserMessage elements. However in the core part of the ebMS-3 specification, only one instance of either eb:UserMessage or eb:SignalMessage must be present. The second part of ebMS-3 specification may need to include multiple instances of either eb:SignalMessage, eb:UserMessage or both. Therefore, this schema is allowing multiple instances of eb:SignalMessage and eb:UserMessage elements for part 2 of the ebMS-3 specification. Note that the eb:Messaging element cannot be empty (at least one of eb:SignalMessage or eb:UserMessage element must present).

    Java class for Messaging complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="Messaging">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="SignalMessage" type="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}SignalMessage" maxOccurs="unbounded" minOccurs="0"/>
         <element name="UserMessage" type="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}UserMessage" maxOccurs="unbounded" minOccurs="0"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attGroup ref="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}headerExtension"/>
       <anyAttribute processContents='lax' namespace='##other'/>
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • mustUnderstand

        protected Boolean mustUnderstand
        if SOAP 1.1 is being used, this attribute is required

      • mustUnderstand12

        protected Boolean mustUnderstand12
        if SOAP 1.2 is being used, this attribute is required

    • Constructor Detail

      • Messaging

        public Messaging()

    • Method Detail

      • getSignalMessage

        public List<SignalMessage> getSignalMessage()
        Gets the value of the signalMessage property.

        This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the signalMessage property.

        For example, to add a new item, do as follows: 

         getSignalMessage().add(newItem);

        Objects of the following type(s) are allowed in the list SignalMessage

        Returns:
        The value of the signalMessage property.

      • getUserMessage

        public List<UserMessage> getUserMessage()
        Gets the value of the userMessage property.

        This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the userMessage property.

        For example, to add a new item, do as follows: 

         getUserMessage().add(newItem);

        Objects of the following type(s) are allowed in the list UserMessage

        Returns:
        The value of the userMessage property.

      • getAny

        public List<Object> getAny()
        Gets the value of the any property.

        This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the any property.

        For example, to add a new item, do as follows: 

         getAny().add(newItem);

        Objects of the following type(s) are allowed in the list Object Element

        Returns:
        The value of the any property.

      • getId

        public String getId()
        Gets the value of the id property.
        Returns:
        possible object is String

      • setId

        public void setId​(String value)
        Sets the value of the id property.
        Parameters:
        value - allowed object is String

      • isMustUnderstand

        public Boolean isMustUnderstand()
        if SOAP 1.1 is being used, this attribute is required
        Returns:
        possible object is String

      • setMustUnderstand

        public void setMustUnderstand​(Boolean value)
        Sets the value of the mustUnderstand property.
        Parameters:
        value - allowed object is String
        See Also:
        isMustUnderstand()

      • isMustUnderstand12

        public boolean isMustUnderstand12()
        if SOAP 1.2 is being used, this attribute is required
        Returns:
        possible object is Boolean

      • setMustUnderstand12

        public void setMustUnderstand12​(Boolean value)
        Sets the value of the mustUnderstand12 property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isMustUnderstand12()

      • getOtherAttributes

        public Map<QName,​String> getOtherAttributes()
        Gets a map that contains attributes that aren't bound to any typed property on this class.

        the map is keyed by the name of the attribute and the value is the string value of the attribute. the map returned by this method is live, and you can add new attribute by updating the map directly. Because of this design, there's no setter.

        Returns:
        always non-null