com.ibm.broker.config.proxy

Class DataCaptureEntry

  • java.lang.Object
    • com.ibm.broker.config.proxy.DataCaptureEntry


  • public class DataCaptureEntry
    extends java.lang.Object

    The DataCaptureEntry class represents a data point that has previously been recorded by an execution group. The class also provides a set of constants that can be used as filter criteria for the ExecutionGroupProxy.getDataCaptureProxy() call; see the documentation for DataCaptureProxy for more information.

    com.ibm.broker.config.proxy.DataCaptureEntry

    Responsibilities Represents a single DataCapture entry from a DataCaptureDataStore.
    Internal Collaborators None
     
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     80006.8  2011-10-04  HDDJS           v8 Release
     
     
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String BUSINESS_TRANSACTION_DEFINITION_ID
      Sets the filter value for the BTD_NAME column, for use with a call to DataCaptureProxy.getDataCapture().
      static java.lang.String BUSINESS_TRANSACTION_ID
      Sets the filter value for the ID column, for use with a call to DataCaptureProxy.getDataCapture().
      static java.lang.String BUSINESS_TRANSACTION_LAST_UPDATE_TIMESTAMP
      Constant field name for a business transactions datacapture response.
      static java.lang.String BUSINESS_TRANSACTION_START_TIMESTAMP
      Constant field name for a business transactions datacapture response.
      static java.lang.String BUSINESS_TRANSACTION_STATUS
      Sets the filter value for the STATUS column (as a comma separated list of integers), for use with a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_APPL_NAME
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_APPL_UUID
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_BROKER_NAME
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_BROKER_UUID
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_DETAILS
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_EVENT_NAME
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_EVENT_SRCADDR
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_EVENT_TIMESTAMP
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_EVENT_TYPE
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_EXGRP_NAME
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_EXGRP_UUID
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_GLOBAL_TRANSACTION_ID
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_HAS_BITSTREAM
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_HAS_EXCEPTION
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_HAS_USERDATA
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_KEY_FLD_1_NM
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_KEY_FLD_2_NM
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_KEY_FLD_3_NM
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_KEY_FLD_4_NM
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_KEY_FLD_5_NM
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_LIBRARY_NAME
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_LIBRARY_UUID
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_LOCAL_TRANSACTION_ID
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_MSGFLOW_NAME
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_MSGFLOW_UUID
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_NODE_NAME
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_NODE_TYPE
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_PARENT_TRANSACTION_ID
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_PAYLOAD
      A property that will return the requested payload for the message.
      static java.lang.String PROPERTY_PAYLOAD_ENCODING
      A property that will return the encoding for the requested payload.
      static java.lang.String PROPERTY_TERMINAL_NAME
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
      static java.lang.String PROPERTY_WMBMSG_KEY
      A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
    • Constructor Summary

      Constructors 
      Constructor and Description
      DataCaptureEntry()
      Use to hold Data Capture results returned from the Brokers Data Capture Proxy
      DataCaptureEntry(java.util.Properties props)
      The DataCaptureEntry class instantiated here
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Properties getAllProperties()
      Returns all the stored message properties for this DataCaptureEntry
      java.lang.String[] getPropertyNames() 
      java.lang.String getPropertyValue(java.lang.String property)
      Returns the value of the property with the supplied name.
      void setProperty(java.lang.String property, java.lang.String value)
      Adds the individual property and value to this Data Capture Entry preceded by DataCaptureEntry.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • PROPERTY_WMBMSG_KEY

        public static final java.lang.String PROPERTY_WMBMSG_KEY
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_HAS_BITSTREAM

        public static final java.lang.String PROPERTY_HAS_BITSTREAM
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_HAS_EXCEPTION

        public static final java.lang.String PROPERTY_HAS_EXCEPTION
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_HAS_USERDATA

        public static final java.lang.String PROPERTY_HAS_USERDATA
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_EVENT_TYPE

        public static final java.lang.String PROPERTY_EVENT_TYPE
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_EVENT_NAME

        public static final java.lang.String PROPERTY_EVENT_NAME
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_EVENT_SRCADDR

        public static final java.lang.String PROPERTY_EVENT_SRCADDR
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_BROKER_NAME

        public static final java.lang.String PROPERTY_BROKER_NAME
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_BROKER_UUID

        public static final java.lang.String PROPERTY_BROKER_UUID
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_EXGRP_NAME

        public static final java.lang.String PROPERTY_EXGRP_NAME
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_EXGRP_UUID

        public static final java.lang.String PROPERTY_EXGRP_UUID
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_MSGFLOW_NAME

        public static final java.lang.String PROPERTY_MSGFLOW_NAME
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_MSGFLOW_UUID

        public static final java.lang.String PROPERTY_MSGFLOW_UUID
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_APPL_NAME

        public static final java.lang.String PROPERTY_APPL_NAME
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_APPL_UUID

        public static final java.lang.String PROPERTY_APPL_UUID
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_LIBRARY_NAME

        public static final java.lang.String PROPERTY_LIBRARY_NAME
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_LIBRARY_UUID

        public static final java.lang.String PROPERTY_LIBRARY_UUID
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_NODE_NAME

        public static final java.lang.String PROPERTY_NODE_NAME
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_NODE_TYPE

        public static final java.lang.String PROPERTY_NODE_TYPE
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_TERMINAL_NAME

        public static final java.lang.String PROPERTY_TERMINAL_NAME
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_DETAILS

        public static final java.lang.String PROPERTY_DETAILS
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_KEY_FLD_1_NM

        public static final java.lang.String PROPERTY_KEY_FLD_1_NM
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_KEY_FLD_2_NM

        public static final java.lang.String PROPERTY_KEY_FLD_2_NM
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_KEY_FLD_3_NM

        public static final java.lang.String PROPERTY_KEY_FLD_3_NM
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_KEY_FLD_4_NM

        public static final java.lang.String PROPERTY_KEY_FLD_4_NM
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_KEY_FLD_5_NM

        public static final java.lang.String PROPERTY_KEY_FLD_5_NM
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_EVENT_TIMESTAMP

        public static final java.lang.String PROPERTY_EVENT_TIMESTAMP
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_LOCAL_TRANSACTION_ID

        public static final java.lang.String PROPERTY_LOCAL_TRANSACTION_ID
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_PARENT_TRANSACTION_ID

        public static final java.lang.String PROPERTY_PARENT_TRANSACTION_ID
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • PROPERTY_GLOBAL_TRANSACTION_ID

        public static final java.lang.String PROPERTY_GLOBAL_TRANSACTION_ID
        A property that can be used as filter criteria on a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • BUSINESS_TRANSACTION_STATUS

        public static final java.lang.String BUSINESS_TRANSACTION_STATUS
        Sets the filter value for the STATUS column (as a comma separated list of integers), for use with a call to DataCaptureProxy.getDataCapture().
        See Also:
        Constant Field Values
      • BUSINESS_TRANSACTION_ID

        public static final java.lang.String BUSINESS_TRANSACTION_ID
        Sets the filter value for the ID column, for use with a call to DataCaptureProxy.getDataCapture(). Value will be wrapped in wildcards unless quoted. This value is the unique ID of a Business Transaction result record
        See Also:
        Constant Field Values
      • BUSINESS_TRANSACTION_DEFINITION_ID

        public static final java.lang.String BUSINESS_TRANSACTION_DEFINITION_ID
        Sets the filter value for the BTD_NAME column, for use with a call to DataCaptureProxy.getDataCapture(). Value will be wrapped in wildcards unless quoted. This value is the reference to the Business Transaction Definition
        See Also:
        Constant Field Values
      • BUSINESS_TRANSACTION_START_TIMESTAMP

        public static final java.lang.String BUSINESS_TRANSACTION_START_TIMESTAMP
        Constant field name for a business transactions datacapture response. Business transaction's start timestamp
        See Also:
        Constant Field Values
      • BUSINESS_TRANSACTION_LAST_UPDATE_TIMESTAMP

        public static final java.lang.String BUSINESS_TRANSACTION_LAST_UPDATE_TIMESTAMP
        Constant field name for a business transactions datacapture response. Business transaction's last update timestamp
        See Also:
        Constant Field Values
      • PROPERTY_PAYLOAD

        public static final java.lang.String PROPERTY_PAYLOAD
        A property that will return the requested payload for the message. The payload is only returned if the property AttributeConstants.DATACAPTURE_PAYLOAD is set to AttributeConstants.DATACAPTURE_PAYLOAD_BITSTREAM or AttributeConstants.DATACAPTURE_PAYLOAD_EXCEPTIONLIST on the input filter (the DataCaptureEntry passed to DataCaptureProxy.getDataCapture()).
        See Also:
        Constant Field Values
      • PROPERTY_PAYLOAD_ENCODING

        public static final java.lang.String PROPERTY_PAYLOAD_ENCODING
        A property that will return the encoding for the requested payload.
        See Also:
        Constant Field Values
    • Constructor Detail

      • DataCaptureEntry

        public DataCaptureEntry()
        Use to hold Data Capture results returned from the Brokers Data Capture Proxy
      • DataCaptureEntry

        public DataCaptureEntry(java.util.Properties props)
        The DataCaptureEntry class instantiated here
        Parameters:
        props - (Name, Value) pair list of properties
    • Method Detail

      • getAllProperties

        public java.util.Properties getAllProperties()
        Returns all the stored message properties for this DataCaptureEntry
      • getPropertyValue

        public java.lang.String getPropertyValue(java.lang.String property)
        Returns the value of the property with the supplied name. If a property of the supplied name does not exist, null is returned.
        Parameters:
        property -
        Returns:
        String containing the property value or null
      • getPropertyNames

        public java.lang.String[] getPropertyNames()
        Returns:
        String[] list of property names on this Data Capture Entry
      • setProperty

        public void setProperty(java.lang.String property,
                                java.lang.String value)
        Adds the individual property and value to this Data Capture Entry preceded by DataCaptureEntry.
        Parameters:
        property - the property Name
        value - the property Value