com.ibm.websphere.sca.jms.data.impl

Class JMSDataBindingImplXML

  • java.lang.Object
    • com.ibm.ws.sca.databinding.impl.DataBindingImplXML
      • com.ibm.websphere.sca.jms.data.impl.JMSDataBindingImplXML
  • All Implemented Interfaces:
    JMSDataBinding, JMSDataBindingXML, com.ibm.wsspi.sca.jms.data.JMSDataBindingNativeBytes, commonj.connector.runtime.BindingContext, commonj.connector.runtime.DataBinding, java.io.Serializable


    public class JMSDataBindingImplXML
    extends com.ibm.ws.sca.databinding.impl.DataBindingImplXML
    implements JMSDataBinding, commonj.connector.runtime.BindingContext, JMSDataBindingXML, com.ibm.wsspi.sca.jms.data.JMSDataBindingNativeBytes
    JMS Data Binding that converts between SDO and its String XML representation.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String $sccsid 
      static java.lang.String COPYRIGHT 
      • Fields inherited from class com.ibm.ws.sca.databinding.impl.DataBindingImplXML

        fieldDataObject
      • Fields inherited from interface commonj.connector.runtime.BindingContext

        BINDING_COMMUNICATION, BINDING_COMMUNICATION_INBOUND, BINDING_COMMUNICATION_OUTBOUND, BINDING_CONFIGURATION, BINDING_INVOCATION, BINDING_INVOCATION_FAULT, BINDING_INVOCATION_REQUEST, BINDING_INVOCATION_RESPONSE, BINDING_NAME, BINDING_REGISTRY, BINDING_TYPE, BINDING_TYPE_EIS, BINDING_TYPE_HTTP, BINDING_TYPE_JMS, EXPECTED_TYPE, INTERACTION_SPEC
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object obj)
      Check if two JMSDataBindingImplXML's are equal.
      commonj.sdo.DataObject getDataObject() 
      int getMessageType()
      Return the Text Message type
      int hashCode()
      Any instance of JMSDataBindingImplXML equals each other, so a constant value 31 is returned as hashCode
      boolean isBusinessException()
      Queries the DataBinding to determine whether the received message contains a fault (carried within a BusinessException).
      boolean outputWrappedXML()
      Used by the runtime to determine whether a doc-lit wrapped input type should be unwrapped before passing it to the data binding, and whether to doc-lit wrap the output type.
      void read(byte[] nativeBytes, boolean isBusinessException) 
      void read(javax.jms.Message message)
      Read the contents of the incoming JMS Message into a DataObject.
      void setBindingContext(java.util.Map bindingContext)
      This method is used to set a BindingContext map into the data binding.
      void setBusinessException(boolean isBusinessException)
      This method is called by the runtime if the outgoing message contains a BusinessException.
      void write(javax.jms.Message message)
      Write the DataObject into an outgoing JMS Message.
      • Methods inherited from class com.ibm.ws.sca.databinding.impl.DataBindingImplXML

        getAsByteArray, getAsString, read, setDataObject, setEncoding, setFromByteArray, setFromString, write
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface commonj.connector.runtime.DataBinding

        setDataObject
    • Constructor Detail

      • JMSDataBindingImplXML

        public JMSDataBindingImplXML()
    • Method Detail

      • isBusinessException

        public boolean isBusinessException()
        Description copied from interface: JMSDataBinding
        Queries the DataBinding to determine whether the received message contains a fault (carried within a BusinessException).
        Specified by:
        isBusinessException in interface JMSDataBinding
        Returns:
        A boolean value stating whether the message payload is a fault.
      • setBusinessException

        public void setBusinessException(boolean isBusinessException)
        Description copied from interface: JMSDataBinding
        This method is called by the runtime if the outgoing message contains a BusinessException. An implementation of this method may set some internal state if this information is important to propagate - and in this case, the interanl state will be acted on by the write() method.
        Specified by:
        setBusinessException in interface JMSDataBinding
        Parameters:
        isBusinessException - True or false, specified by the caller.
      • read

        public void read(javax.jms.Message message)
                  throws javax.jms.JMSException
        Description copied from interface: JMSDataBinding
        Read the contents of the incoming JMS Message into a DataObject. Called before the getDataObject method is called by the runtime. An implementation of this method will process the payload of the incoming JMS message and will parse the data into the appropriate DataObject, created like this:

        BOFactory bof =
        (BOFactory)ServiceManager.INSTANCE.locateService("com/ibm/websphere/bo/BOFactory");
        sampleBO = bof.create("http://namespace", "BOName");

        Specified by:
        read in interface JMSDataBinding
        Parameters:
        message - The message whose payload is to be parsed.
        Throws:
        javax.jms.JMSException - Thrown if an error occurs during reading of the message.
        See Also:
        JMSDataBinding.read(javax.jms.Message)
      • read

        public void read(byte[] nativeBytes,
                boolean isBusinessException)
        Specified by:
        read in interface com.ibm.wsspi.sca.jms.data.JMSDataBindingNativeBytes
      • write

        public void write(javax.jms.Message message)
                   throws javax.jms.JMSException
        Description copied from interface: JMSDataBinding
        Write the DataObject into an outgoing JMS Message. Called after the setDataObject method is called by the runtime. The supplied message must be of the same type as returned by getMessageType.

        This method will be the converse of the read method, and will serialize the contents of the DataObject the the wire format in the JMS message.

        Specified by:
        write in interface JMSDataBinding
        Parameters:
        message - The message to be populated with the serialized DataObject.
        Throws:
        javax.jms.JMSException - Thrown if an error occurs during writing of the message.
        See Also:
        JMSDataBinding.write(javax.jms.Message)
      • getDataObject

        public commonj.sdo.DataObject getDataObject()
        Specified by:
        getDataObject in interface commonj.connector.runtime.DataBinding
        Overrides:
        getDataObject in class com.ibm.ws.sca.databinding.impl.DataBindingImplXML
        See Also:
        com.ibm.websphere.eis.DataBinding#getDataObject()
      • setBindingContext

        public void setBindingContext(java.util.Map bindingContext)
        This method is used to set a BindingContext map into the data binding.
        Specified by:
        setBindingContext in interface commonj.connector.runtime.BindingContext
      • outputWrappedXML

        public boolean outputWrappedXML()
        Description copied from interface: JMSDataBindingXML
        Used by the runtime to determine whether a doc-lit wrapped input type should be unwrapped before passing it to the data binding, and whether to doc-lit wrap the output type.
        Specified by:
        outputWrappedXML in interface JMSDataBindingXML
        Returns:
        A boolean specifying either wrapped XML or unwrapped XML (false implies unwrapped)
      • equals

        public boolean equals(java.lang.Object obj)
        Check if two JMSDataBindingImplXML's are equal.
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(java.lang.Object)
      • hashCode

        public int hashCode()
        Any instance of JMSDataBindingImplXML equals each other, so a constant value 31 is returned as hashCode
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()
IBM Business Process ManagerTM
Release 8