Package COM.activesw.api.client

Class BrokerJMSEvent

  • All Implemented Interfaces:
    java.io.Serializable
    public class BrokerJMSEvent
extends BrokerEvent
implements java.io.Serializable
    Represents an Information Broker event. Events have an event type. If the event is created with an associated client, then the event becomes associated with that client's broker and type and field name checking is performed as operations on the event are performed. Otherwise, no type or field checking is performed.
    All field_name parameters take fully qualified field names, which are formatted like C or Java variable accessing. Fields in a structure are accessed with a '.' like this "field1.subfield1". Fields in a sequence are accessed with array brackets like this "field2[3]". These can be combined to make complex names such as "field3.x[1][35].a.y[2]".

    All event_type_name parameters take fully qualified event type names, such as "MyScope::MyEvent".

    See Also:
    Serialized Form

    • Constructor Detail

      • BrokerJMSEvent

        public BrokerJMSEvent​(BrokerClient client,
                      java.lang.String event_type_name)
               throws BrokerException
        Create an event of the appropriate type with an associated client. If the client is specified, the event will be typechecked and all fields in the type definition will appear to be there at all times. If the client is null, the event will not be typechecked and only fields which have actively been set will appear in the event.
        Throws:
        BrokerInvalidEventTypeNameException - If the type name is not valid.
        BrokerNoPermissionException - If a client is specified and the client does not have permission to publish or subscribe to the event type.
        BrokerNullParameterException - If event_type_name is null.
        BrokerUnknownEventTypeException - If a client is specified and the broker does not have an event type with the specified name.
        BrokerException

      • BrokerJMSEvent

        public BrokerJMSEvent​(BrokerClient client,
                      java.lang.String event_type_name,
                      java.lang.Class storage_class)
               throws BrokerException
        Create an event of the appropriate type with the associated client and Java class.

        If both a client and a class are provided, the event will be typechecked and all fields in the type definition that also appear in the Java class will appear to be there at all times. Fields that appear only in the type definition are not accessible. Field types in the class must match exactly. There is no implicit type conversion.

        If no client is provided, then fields will still be typechecked, but only ones in the Java class will be accessible.

        Throws:
        BrokerFieldNotFoundException - If the event is typechecked and a public data member exists in the class when there is no field in the event type using the same name.
        BrokerFieldTypeMismatchException - If the event is typechecked and a data member in the class is a different type than the same field in the event type.
        BrokerInvalidClassException - If the storage_class cannot be instantiated using the Class.newInstance() method.
        BrokerInvalidEventTypeNameException - If the type name is not valid.
        BrokerNoPermissionException - If a client is specified and the client does not have permission to publish or subscribe to the event type. Or if the class provided cannot be instantiated.
        BrokerNullParameterException - If event_type_name or storage_class are null.
        BrokerUnknownEventTypeException - If a client is specified and the broker does not have an event type with the specified name.
        BrokerException

      • BrokerJMSEvent

        public BrokerJMSEvent​(BrokerClient client,
                      java.lang.String event_type_name,
                      java.lang.Object storage_object)
               throws BrokerException
        Create an event of the appropriate type with the associated client and Java object. The Java object is itself used for storage by this event instance. If both a client and an object are provided, the event will be typechecked and all fields in the type definition that also appear in the Java object will appear to be there at all times. Fields that appear only in the object or only in the type definition are not accessible. Field types in the class must match exactly. There is no implicit type conversion. If no client is provided, then fields will still be typechecked, but only ones in the Java object will be accessible.
        Throws:
        BrokerFieldNotFoundException - If the event is typechecked and a public data member exists in the object's class when there is no field in the event type using the same name.
        BrokerFieldTypeMismatchException - If the event is typechecked and a data member in the object's class is a different type than the same field in the event type.
        BrokerInvalidEventTypeNameException - If the type name is not valid.
        BrokerNoPermissionException - If a client is specified and the client does not have permission to publish or subscribe to the event type.
        BrokerNullParameterException - If event_type_name or storage_object are null.
        BrokerUnknownEventTypeException - If a client is specified and the broker does not have an event type with the specified name.
        BrokerException

    • Method Detail

      • getEventId

        public long getEventId()
        Get the event ID (as set by the broker) for this event. Always zero if not received from the broker, or if the event was published by a client using a pre-3.0 release of the product.
        Overrides:
        getEventId in class BrokerEvent

      • getFieldType

        public short getFieldType​(java.lang.String field_name)
                   throws BrokerException
        Gets the type for the specified field. Sequence fields can use "[]" if it is the last part of the name on an event without a client, or always on events with a client.
        Overrides:
        getFieldType in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setByteField

        public void setByteField​(java.lang.String field_name,
                         byte value)
                  throws BrokerException
        Sets the value of a byte field.
        Overrides:
        setByteField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setShortField

        public void setShortField​(java.lang.String field_name,
                          short value)
                   throws BrokerException
        Sets the value of a short field.
        Overrides:
        setShortField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setIntegerField

        public void setIntegerField​(java.lang.String field_name,
                            int value)
                     throws BrokerException
        Sets the value of an integer field.
        Overrides:
        setIntegerField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setLongField

        public void setLongField​(java.lang.String field_name,
                         long value)
                  throws BrokerException
        Sets the value of a long field.
        Overrides:
        setLongField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setFloatField

        public void setFloatField​(java.lang.String field_name,
                          float value)
                   throws BrokerException
        Sets the value of a float field.
        Overrides:
        setFloatField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setDoubleField

        public void setDoubleField​(java.lang.String field_name,
                           double value)
                    throws BrokerException
        Sets the value of a double field.
        Overrides:
        setDoubleField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setBooleanField

        public void setBooleanField​(java.lang.String field_name,
                            boolean value)
                     throws BrokerException
        Sets the value of a boolean field.
        Overrides:
        setBooleanField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setDateField

        public void setDateField​(java.lang.String field_name,
                         BrokerDate value)
                  throws BrokerException
        Sets the value of a date field.
        Overrides:
        setDateField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerException

      • setCharField

        public void setCharField​(java.lang.String field_name,
                         char value)
                  throws BrokerException
        Sets the value of a char field. Characters which do not map to ANSI/ISO-Latin-1 will become underscores ('_').
        Overrides:
        setCharField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setUCCharField

        public void setUCCharField​(java.lang.String field_name,
                           char value)
                    throws BrokerException
        Sets the value of a unicode char field.
        Overrides:
        setUCCharField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setStringField

        public void setStringField​(java.lang.String field_name,
                           java.lang.String value)
                    throws BrokerException
        Sets the value of a string field. Characters which do not map to ANSI/ISO-Latin-1 will become underscores ('_'). Can also be used to set the value of a unicode string field if your event is typechecked or the named field already is set to a unicode value.
        Overrides:
        setStringField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerException

      • setUCStringField

        public void setUCStringField​(java.lang.String field_name,
                             java.lang.String value)
                      throws BrokerException
        Sets the value of a unicode string field.
        Overrides:
        setUCStringField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerException

      • setStringFieldToSubstring

        public void setStringFieldToSubstring​(java.lang.String field_name,
                                      int offset,
                                      int nc,
                                      java.lang.String value)
                               throws BrokerException
        Sets the value of a string field to a substring of another string. If nc is AUTO_SIZE (-1), take the rest of the string. Characters which do not map to ANSI/ISO-Latin-1 will become underscores ('_').
        Overrides:
        setStringFieldToSubstring in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If offset is not within the size of the string, or if nc would exceed the size of the string.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If offset is not within the size of the string, or if nc would exceed the size of the string.
        BrokerException

      • setUCStringFieldToSubstring

        public void setUCStringFieldToSubstring​(java.lang.String field_name,
                                        int offset,
                                        int nc,
                                        java.lang.String value)
                                 throws BrokerException
        Sets the value of a unicode string field to a substring of another string. If nc is AUTO_SIZE (-1), take the rest of the string.
        Overrides:
        setUCStringFieldToSubstring in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If offset is not within the size of the string, or if nc would exceed the size of the string.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If offset is not within the size of the string, or if nc would exceed the size of the string.
        BrokerException

      • setByteSeqField

        public void setByteSeqField​(java.lang.String field_name,
                            int src_offset,
                            int dest_offset,
                            int n,
                            byte[] value)
                     throws BrokerException
        Sets the value of a subrange of a byte sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setByteSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setShortSeqField

        public void setShortSeqField​(java.lang.String field_name,
                             int src_offset,
                             int dest_offset,
                             int n,
                             short[] value)
                      throws BrokerException
        Sets the value of a subrange of a short sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setShortSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setIntegerSeqField

        public void setIntegerSeqField​(java.lang.String field_name,
                               int src_offset,
                               int dest_offset,
                               int n,
                               int[] value)
                        throws BrokerException
        Sets the value of a subrange of an integer sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setIntegerSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setLongSeqField

        public void setLongSeqField​(java.lang.String field_name,
                            int src_offset,
                            int dest_offset,
                            int n,
                            long[] value)
                     throws BrokerException
        Sets the value of a subrange of a long sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setLongSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setFloatSeqField

        public void setFloatSeqField​(java.lang.String field_name,
                             int src_offset,
                             int dest_offset,
                             int n,
                             float[] value)
                      throws BrokerException
        Sets the value of a subrange of a float sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setFloatSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setDoubleSeqField

        public void setDoubleSeqField​(java.lang.String field_name,
                              int src_offset,
                              int dest_offset,
                              int n,
                              double[] value)
                       throws BrokerException
        Sets the value of a subrange of a double sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setDoubleSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setBooleanSeqField

        public void setBooleanSeqField​(java.lang.String field_name,
                               int src_offset,
                               int dest_offset,
                               int n,
                               boolean[] value)
                        throws BrokerException
        Sets the value of a subrange of a boolean sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setBooleanSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setDateSeqField

        public void setDateSeqField​(java.lang.String field_name,
                            int src_offset,
                            int dest_offset,
                            int n,
                            BrokerDate[] value)
                     throws BrokerException
        Sets the value of a subrange of a date sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setDateSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null, or if any of the elements of the value array are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null, or if any of the elements of the value array are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setCharSeqField

        public void setCharSeqField​(java.lang.String field_name,
                            int src_offset,
                            int dest_offset,
                            int n,
                            char[] value)
                     throws BrokerException
        Sets the value of a subrange of a char sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set. Characters which do not map to ANSI/ISO-Latin-1 will become underscores ('_').
        Overrides:
        setCharSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setUCCharSeqField

        public void setUCCharSeqField​(java.lang.String field_name,
                              int src_offset,
                              int dest_offset,
                              int n,
                              char[] value)
                       throws BrokerException
        Sets the value of a subrange of a unicode char sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setUCCharSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setStringSeqField

        public void setStringSeqField​(java.lang.String field_name,
                              int src_offset,
                              int dest_offset,
                              int n,
                              java.lang.String[] value)
                       throws BrokerException
        Sets the value of a subrange of a string sequence field. Can also be used to set the value of a unicode string sequence field if your event is typechecked or the named field already is set to a unicode string sequence value. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set. Characters which do not map to ANSI/ISO-Latin-1 will become underscores ('_').
        Overrides:
        setStringSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null, or if any of the elements of the value array are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null, or if any of the elements of the value array are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setUCStringSeqField

        public void setUCStringSeqField​(java.lang.String field_name,
                                int src_offset,
                                int dest_offset,
                                int n,
                                java.lang.String[] value)
                         throws BrokerException
        Sets the value of a subrange of a unicode string sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Overrides:
        setUCStringSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null, or if any of the elements of the value array are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null, or if any of the elements of the value array are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setSequenceField

        public void setSequenceField​(java.lang.String field_name,
                             short field_type,
                             int src_offset,
                             int dest_offset,
                             int n,
                             java.lang.Object value)
                      throws BrokerException
        Sets the value of a subrange of a sequence field. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set. The 'value' parameter should be the proper kind of array to match the 'field_type' parameter. For 'field_type' set to BrokerTypeDef.FIELD_TYPE_*: BYTE = byte[], SHORT = short[], INT = int[], LONG = long[], FLOAT = float[], DOUBLE = double[], BOOLEAN = boolean[], DATE = BrokerDate[], CHAR = char[], UNICODE_CHAR = char[], STRING = String[], UNICODE_STRING = String[], STRUCT = BrokerJMSEvent[]. A sequence of sequences cannot be set with this operation. A value of STRING can also be used to set the value of a UNICODE_STRING sequence field if your event is typechecked or the named field already is set to a unicode string sequence value.
        Overrides:
        setSequenceField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or if the value field is not of the type required for the field_type specified, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If field_type is BrokerTypeDef.FIELD_TYPE_SEQUENCE or is not a supported field type.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or if the value field is not of the type required for the field_type specified, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If field_type is BrokerTypeDef.FIELD_TYPE_SEQUENCE or is not a supported field type.
        BrokerNullParameterException - If field_name or value are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setSequenceFieldSize

        public void setSequenceFieldSize​(java.lang.String field_name,
                                 int size)
                          throws BrokerException
        Set the size of a sequence field.
        Overrides:
        setSequenceFieldSize in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not a sequence, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If size is less than zero.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not a sequence, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If size is less than zero.
        BrokerException

      • setStructFieldFromEvent

        public void setStructFieldFromEvent​(java.lang.String field_name,
                                    BrokerJMSEvent value)
                             throws BrokerException
        Sets the value of a structure field. The value event should contain the appropriate fields for the structure. The type of the value event and any envelope fields on the value event are ignored. If field_name is "" or null, the top level of the event is modified.
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not a structure, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If value is null.
        BrokerException

      • setStructSeqFieldFromEvents

        public void setStructSeqFieldFromEvents​(java.lang.String field_name,
                                        int src_offset,
                                        int dest_offset,
                                        int n,
                                        BrokerJMSEvent[] value)
                                 throws BrokerException
        Sets the value of a structure sequence field. The value events should contain the appropriate fields for the structures being set. The type of the value events and any envelope fields on the value events are ignored. The 'n' parameter can be set to AUTO_SIZE (-1) to use the actual array size. The 'dest_offset' parameter can be set to ENTIRE_SEQUENCE (-1) to set the sequence size to the number of elements being set.
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name or value are null, or if any of the elements in the value array are null.
        BrokerOutOfRangeException - If src_offset is not within the size of the the passed in value, if dest_offset is less than zero, or if n is less than -1.
        BrokerException

      • setField

        public void setField​(java.lang.String field_name,
                     short field_type,
                     java.lang.Object value)
              throws BrokerException
        Sets the value of a field. The 'value' parameter should be the proper kind of object to match the 'field_type' parameter. For 'field_type' set to BrokerTypeDef.FIELD_TYPE_*: BYTE = Byte, SHORT = Short, INT = Integer, LONG = Long, FLOAT = Float, DOUBLE = Double, BOOLEAN = Boolean, DATE = BrokerDate, CHAR = Character, UNICODE_CHAR = Character, STRING = String, UNICODE_STRING = String, STRUCT = BrokerEvent. A sequence cannot be set with this operation. Use setSequenceField() for sequences. A value of STRING can also be used to set the value of a UNICODE_STRING field if your event is typechecked or the named field already is set to a unicode string value.
        Overrides:
        setField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the value object type does not match the field_type specified, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If field_type is BrokerTypeDef.FIELD_TYPE_SEQUENCE or is not a supported field type.
        BrokerNullParameterException - If field_name or value are null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the value object type does not match the field_type specified, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If field_type is BrokerTypeDef.FIELD_TYPE_SEQUENCE or is not a supported field type.
        BrokerNullParameterException - If field_name or value are null.
        BrokerException

      • setField

        public void setField​(java.lang.String field_name,
                     BrokerField field)
              throws BrokerException
        Sets the value of a field. Does not accept sequences. The 'value' field in the BrokerField should be the proper kind of object to match the 'field_type' field. For 'field_type' set to BrokerTypeDef.FIELD_TYPE_*: BYTE = Byte, SHORT = Short, INT = Integer, LONG = Long, FLOAT = Float, DOUBLE = Double, BOOLEAN = Boolean, DATE = BrokerDate, CHAR = Character, UNICODE_CHAR = Character, STRING= String, UNICODE_STRING = String, STRUCT = BrokerJMSEvent. A sequence cannot be set with this operation. Use setSequenceField() for sequences.
        Overrides:
        setField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the value object type does not match the field_type specified, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If the field_type field is BrokerTypeDef.FIELD_TYPE_SEQUENCE or is not a supported field type.
        BrokerNullParameterException - If field_name, field, or the value field in 'field' are null.
        BrokerFieldNotFoundException - If the event is associated with a client and the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the value object type does not match the field_type specified, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If the field_type field is BrokerTypeDef.FIELD_TYPE_SEQUENCE or is not a supported field type.
        BrokerNullParameterException - If field_name, field, or the value field in 'field' are null.
        BrokerException

      • getByteField

        public byte getByteField​(java.lang.String field_name)
                  throws BrokerException
        Get the value of a byte field.
        Overrides:
        getByteField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getShortField

        public short getShortField​(java.lang.String field_name)
                    throws BrokerException
        Get the value of a short field.
        Overrides:
        getShortField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getIntegerField

        public int getIntegerField​(java.lang.String field_name)
                    throws BrokerException
        Get the value of an integer field.
        Overrides:
        getIntegerField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getLongField

        public long getLongField​(java.lang.String field_name)
                  throws BrokerException
        Get the value of a long field.
        Overrides:
        getLongField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getFloatField

        public float getFloatField​(java.lang.String field_name)
                    throws BrokerException
        Get the value of a float field.
        Overrides:
        getFloatField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getDoubleField

        public double getDoubleField​(java.lang.String field_name)
                      throws BrokerException
        Get the value of a double field.
        Overrides:
        getDoubleField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getBooleanField

        public boolean getBooleanField​(java.lang.String field_name)
                        throws BrokerException
        Get the value of a boolean field.
        Overrides:
        getBooleanField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getDateField

        public BrokerDate getDateField​(java.lang.String field_name)
                        throws BrokerException
        Get the value of a date field.
        Overrides:
        getDateField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getCharField

        public char getCharField​(java.lang.String field_name)
                  throws BrokerException
        Get the value of a char field.
        Overrides:
        getCharField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getUCCharField

        public char getUCCharField​(java.lang.String field_name)
                    throws BrokerException
        Get the value of a unicode char field.
        Overrides:
        getUCCharField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getStringField

        public java.lang.String getStringField​(java.lang.String field_name)
                                throws BrokerException
        Get the value of a string field. Can also be used to get the value of a unicode string field.
        Overrides:
        getStringField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getUCStringField

        public java.lang.String getUCStringField​(java.lang.String field_name)
                                  throws BrokerException
        Get the value of a unicode string field.
        Overrides:
        getUCStringField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getByteSeqField

        public byte[] getByteSeqField​(java.lang.String field_name,
                              int offset,
                              int max_n)
                       throws BrokerException
        Get the value of a byte sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getByteSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getShortSeqField

        public short[] getShortSeqField​(java.lang.String field_name,
                                int offset,
                                int max_n)
                         throws BrokerException
        Get the value of a short sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getShortSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getIntegerSeqField

        public int[] getIntegerSeqField​(java.lang.String field_name,
                                int offset,
                                int max_n)
                         throws BrokerException
        Get the value of an integer sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getIntegerSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getLongSeqField

        public long[] getLongSeqField​(java.lang.String field_name,
                              int offset,
                              int max_n)
                       throws BrokerException
        Get the value of a long sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getLongSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getFloatSeqField

        public float[] getFloatSeqField​(java.lang.String field_name,
                                int offset,
                                int max_n)
                         throws BrokerException
        Get the value of a float sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getFloatSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getDoubleSeqField

        public double[] getDoubleSeqField​(java.lang.String field_name,
                                  int offset,
                                  int max_n)
                           throws BrokerException
        Get the value of a double sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getDoubleSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getBooleanSeqField

        public boolean[] getBooleanSeqField​(java.lang.String field_name,
                                    int offset,
                                    int max_n)
                             throws BrokerException
        Get the value of a boolean sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getBooleanSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getDateSeqField

        public BrokerDate[] getDateSeqField​(java.lang.String field_name,
                                    int offset,
                                    int max_n)
                             throws BrokerException
        Get the value of a date sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getDateSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getCharSeqField

        public char[] getCharSeqField​(java.lang.String field_name,
                              int offset,
                              int max_n)
                       throws BrokerException
        Get the value of a char sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getCharSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getUCCharSeqField

        public char[] getUCCharSeqField​(java.lang.String field_name,
                                int offset,
                                int max_n)
                         throws BrokerException
        Get the value of a unicode char sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getUCCharSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getStringSeqField

        public java.lang.String[] getStringSeqField​(java.lang.String field_name,
                                            int offset,
                                            int max_n)
                                     throws BrokerException
        Get the value of a string sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values. Can also be used to get the value of a unicode string sequence field.
        Overrides:
        getStringSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getUCStringSeqField

        public java.lang.String[] getUCStringSeqField​(java.lang.String field_name,
                                              int offset,
                                              int max_n)
                                       throws BrokerException
        Get the value of a unicode string sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values.
        Overrides:
        getUCStringSeqField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getSequenceField

        public BrokerField getSequenceField​(java.lang.String field_name,
                                    int offset,
                                    int max_n)
                             throws BrokerException
        Get the value of a sequence field. Gets the entire length if max_n is ENTIRE_SEQUENCE (-1), otherwise gets up to max_n values. The 'value' field in the BrokerField will be set to match the 'field_type' field. For 'field_type' set to BrokerTypeDef.FIELD_TYPE_*: BYTE = byte[], SHORT = short[], INT = int[], LONG = long[], FLOAT = float[], DOUBLE = double[], BOOLEAN = boolean[], DATE = BrokerDate[], CHAR = char[], UNICODE_CHAR = char[], UNICODE_STRING = String[], STRING= String[], STRUCT = BrokerJMSEvent[]. Cannot get a sequence of sequences with this operation.
        Overrides:
        getSequenceField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If the field is a sequence of sequences.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If the field is a sequence of sequences.
        BrokerNullParameterException - If field_name is null.
        BrokerOutOfRangeException - If offset is less than zero or greater than the sequence size, or max_n is less than zero.
        BrokerException

      • getField

        public BrokerField getField​(java.lang.String field_name)
                     throws BrokerException
        Get the value of field. The 'value' field in the BrokerField will be set to match the 'field_type' field. For 'field_type' set to BrokerTypeDef.FIELD_TYPE_*: BYTE = Byte, SHORT = Short, INT = Integer, LONG = Long, FLOAT = Float, DOUBLE = Double, BOOLEAN = Boolean, DATE = BrokerDate, CHAR = Character, UNICODE_CHAR = Character, STRING= String, UNICODE_STRING = String, STRUCT = BrokerJMSEvent. Cannot get a sequence with this operation.
        Overrides:
        getField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If the field is a sequence.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerInvalidTypeException - If the field is a sequence.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • getFieldNames

        public java.lang.String[] getFieldNames​(java.lang.String field_name)
                                 throws BrokerException
        Get the list of field names in an event. If field_name is null or "", it gets the fields at the top level of the event. Otherwise, the field_name should refer to a structure sub-field and it will return the names at that level. Non-structured types will return zero names.
        Overrides:
        getFieldNames in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerException

      • isFieldSet

        public boolean isFieldSet​(java.lang.String field_name)
                   throws BrokerException
        Determine if the specified field is set in the event. For non-typechecked events, this is merely whether the field exists or not. For typechecked events, this tells if the field has been assigned a value or is simply defaulting to a value because it was not set.
        Overrides:
        isFieldSet in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • clear

        public void clear()
        Clears all fields of the event so it can be re-used.
        Overrides:
        clear in class BrokerEvent

      • clearField

        public void clearField​(java.lang.String field_name,
                       boolean ignoreEx)
                throws BrokerException
        Clear (un-set) a field in the event. Will not throw an exception if field is not found. If fieldExists is true
        Overrides:
        clearField in class BrokerEvent
        Parameters:
        field_name - is the field that needs to be cleared from event.
        ignoreEx - set to true, no exception is thrown if field is not found ignoreEx is set to false, exception is thrown if field is not found.
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event and ignoreEx is set to false.
        BrokerFieldTypeMismatchException - If the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerFieldNotFoundException - If the field name does not exist in the event and ignoreEx is set to false.
        BrokerFieldTypeMismatchException - If the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerNullParameterException - If field_name is null.
        BrokerException

      • setAge

        protected void setAge​(int age)

      • getAge

        public int getAge()

      • validate

        public void validate​(BrokerClient client)
              throws BrokerException
        Validate event in the context of the specified client. This can be used on non-typechecked events to typecheck them, or on typechecked events to check if they would be valid for a client other than the one they were created with. An event passes validation if its event type exists on the broker and if it only contains fields which are properly named and typed for that event type.
        Overrides:
        validate in class BrokerEvent
        Throws:
        BrokerFieldTypeMismatchException - If the event does not pass validation.
        BrokerInvalidClientException - If the client parameter is null and the event is not typechecked.
        BrokerFieldTypeMismatchException - If the event does not pass validation.
        BrokerInvalidClientException - If the client parameter is null and the event is not typechecked.
        BrokerException

      • getTag

        public int getTag()
           throws BrokerException
        Get the event's 'tag' envelope field. This is equivalent to getIntegerField("_env.tag"), but it can be more convenient.
        Overrides:
        getTag in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If "_env.tag" is not set on the event.
        BrokerFieldNotFoundException - If "_env.tag" is not set on the event.
        BrokerException

      • setTag

        public void setTag​(int tag)
            throws BrokerException
        Set the event's 'tag' envelope field. This is the same as setIntegerField("_env.tag",tag), but it can be more convenient.
        Overrides:
        setTag in class BrokerEvent
        Throws:
        BrokerException

      • isLastReply

        public boolean isLastReply()
        Determines if the given event is the last event in a reply sequence. Returns true if the event has appSeqn==appLastSeqn, if the event is an Adapter::error event, or if either of appSeqn or appLastSeqn is not set. Returns false if of the above is not true.
        Overrides:
        isLastReply in class BrokerEvent

      • isErrorReply

        public boolean isErrorReply()
        Determine if the given event is an error reply. Returns true if the event is of type Adapter::error. Returns false if of the above is not true.
        Overrides:
        isErrorReply in class BrokerEvent

      • isAckReply

        public boolean isAckReply()
        Determine if the given event is an acknowledgement reply. Returns true if the event is of type Adapter::ack. Returns false if of the above is not true.
        Overrides:
        isAckReply in class BrokerEvent

      • isNullReply

        public boolean isNullReply()
        Determine if the given event is a 'null' event. This means that although The event is a data reply event, it contains no actual data and is just a placeholder to indicate that there will be no data replies. Returns true if the event has appSeqn==-1 and appLastSeqn==-1. Returns false if of the above is not true.
        Overrides:
        isNullReply in class BrokerEvent

      • hasBeenModified

        public boolean hasBeenModified()
        Check if event has been modified since last time the modification flag was cleared.
        Overrides:
        hasBeenModified in class BrokerEvent

      • toString

        public java.lang.String toString()
        Get event content as a string which includes newlines formatted for the US English locale.
        Overrides:
        toString in class BrokerEvent

      • toString

        public java.lang.String toString​(java.util.Locale locale)
        Get event content as a string which includes newlines formatted for the specified locale.
        Overrides:
        toString in class BrokerEvent

      • toString

        public java.lang.String toString​(int indent_level)
        Get event content as a string suitable for human viewing formatted for the US English locale. The "indent_level" is the number of 4-space indents that the output should be generated for.
        Overrides:
        toString in class BrokerEvent

      • toString

        public java.lang.String toString​(int indent_level,
                                 java.util.Locale locale)
        Get event content as a string suitable for human viewing formatted for the specified locale. The "indent_level" is the number of 4-space indents that the output should be generated for.
        Overrides:
        toString in class BrokerEvent

      • toLocalizedString

        public java.lang.String toLocalizedString()
        Get event content as a string which includes newlines formatted for the default locale. Equivalent to toString(java.util.Locale.getDefault())
        Overrides:
        toLocalizedString in class BrokerEvent

      • toFormattedString

        public java.lang.String toFormattedString​(java.lang.String formatString)
                                   throws BrokerException
        Format an event string. Take the format_string and replace all references to event fields with their values. Equivalent to toFormattedString(formatString, java.util.Locale.US). See class BrokerFormat for details.
        Overrides:
        toFormattedString in class BrokerEvent
        Throws:
        BrokerException

      • toFormattedString

        public java.lang.String toFormattedString​(java.lang.String formatString,
                                          java.util.Locale locale)
                                   throws BrokerException
        Format an event string. Take the format_string and replace all references to event fields with their values formatted for the specified locale. See class BrokerFormat for details.
        Overrides:
        toFormattedString in class BrokerEvent
        Throws:
        BrokerException

      • toLocalizedFormattedString

        public java.lang.String toLocalizedFormattedString​(java.lang.String formatString)
                                            throws BrokerException
        Format an event string. Take the format_string and replace all references to event fields with their values. Event field values will be formatted for the default locale. Equivalent to toFormattedString(formatString, java.util.Locale.getDefault()) See class BrokerFormat for details.
        Overrides:
        toLocalizedFormattedString in class BrokerEvent
        Throws:
        BrokerException

      • stringToANSI

        public static java.lang.String stringToANSI​(java.lang.String st)
        Convert a String object to another String which only contains characters which cleanly map to ANSI 8-bit characters. All unicode characters that do not map are replaced with '\\u' escapes.

      • stringFromANSI

        public static java.lang.String stringFromANSI​(java.lang.String st)
        Convert a String object which contains only ANSI 8-bit characters, to another String which contains unicode characters. Converts uses of '\\u' escapes to proper characters.

      • toBinData

        public byte[] toBinData()
        Get out the event's data as a byte array. This is useful for storage on disk or in a database.
        Overrides:
        toBinData in class BrokerEvent

      • getEventField

        public BrokerEvent getEventField​(java.lang.String field_name)
                          throws BrokerException
        Get the value of an event field. If field_name is "" or null, the top level of this event is returned.
        Overrides:
        getEventField in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the field is not of the specified type, or the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerException

      • getPropertyNames

        public java.lang.String[] getPropertyNames​(java.lang.String field_name)
                                    throws BrokerException
        Get the list of property names in an event. Returns a list of names that are not defined in the broker.
        Overrides:
        getPropertyNames in class BrokerEvent
        Throws:
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerFieldNotFoundException - If the field name does not exist in the event.
        BrokerFieldTypeMismatchException - If the name incorrectly accesses a type (such as using [2] on a non-sequence field).
        BrokerInvalidFieldNameException - If the field name is not valid.
        BrokerException