Package COM.activesw.api.client

Class BrokerPacked

  • public class BrokerPacked
extends java.lang.Object
    Manages a packed broker event.

    • Constructor Summary

      Constructors 
      Constructor Description
      BrokerPacked​(byte[] data)
      Create a packed event from some read in data.
      BrokerPacked​(BrokerPacked packed_event)
      Copy constructor.
      BrokerPacked​(java.lang.String bin_string)
      Create from a bin string
      BrokerPacked​(java.lang.String event_type_name, int version)
      Create an empty packed event.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean allowSetEnvelope​(boolean allowed)
      Allow/disallow setting of envelope fields for this thread.
      void clearField​(java.lang.String field_name, boolean is_typechecked)
      Clear a field's value
      java.lang.String eventToBinString()
      Stringify an event in binary form.
      void eventToString​(BrokerTypeDef def, int indent_level, java.util.Locale locale, java.lang.StringBuffer buf)
      Stringify an event.
      static boolean getAllowSetEnvelope()  
      byte[] getData()
      Get the binary form
      long getEventId()
      Get the event ID.
      BrokerField getField​(java.lang.String field_name, boolean is_typechecked)
      Get a field's value - throws BrokerFieldNotFoundException if field not found
      java.lang.String[] getFieldNames​(java.lang.String field_name)
      Get field names
      BrokerField getFieldType​(java.lang.String field_name)
      Get a field's type
      int getPackVersion()
      Get the packed format version
      BrokerField getSequenceField​(java.lang.String field_name, int offset, int max_n, boolean is_typechecked)
      Get a sequence field's value
      int getSequenceSize​(java.lang.String field_name, boolean is_typechecked)
      Get a sequence field's size
      int getSystemPackVersion()
      Get the system pack version
      java.lang.String getTypeName()
      Get the type name
      int getTypeVersion()
      Get the type version
      static boolean isExtendedReservedWord​(java.lang.String st)
      Check if a name is an extended reserved word
      static boolean isReservedWord​(java.lang.String st)
      Check if a name is a reserved word
      boolean isValidEvent()
      Determine if this event is valid
      void setField​(java.lang.String field_name, short value_type, java.lang.Object value)
      Set a field's value
      void setSequenceSize​(java.lang.String field_name, short type, int size)
      Set a sequence field's size
      void validate​(BrokerTypeDef def)
      Validate an event against its definition.
      static void validateEventTypeName​(java.lang.String event_type_name)
      Check if event name is valid
      static boolean validateFieldName​(java.lang.String name)
      Check if field name is valid
      static boolean validateFieldNameChars​(char[] c)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BrokerPacked

        public BrokerPacked​(java.lang.String event_type_name,
                    int version)
             throws BrokerException
        Create an empty packed event.
        Throws:
        BrokerException

      • BrokerPacked

        public BrokerPacked​(byte[] data)
             throws BrokerException
        Create a packed event from some read in data. Does not copy the data.
        Throws:
        BrokerException

      • BrokerPacked

        public BrokerPacked​(BrokerPacked packed_event)
        Copy constructor.

    • Method Detail

      • eventToBinString

        public java.lang.String eventToBinString()
        Stringify an event in binary form.

      • getData

        public byte[] getData()
        Get the binary form

      • getSystemPackVersion

        public int getSystemPackVersion()
        Get the system pack version

      • getTypeVersion

        public int getTypeVersion()
        Get the type version

      • getEventId

        public long getEventId()
        Get the event ID.

      • getTypeName

        public java.lang.String getTypeName()
        Get the type name

      • getField

        public BrokerField getField​(java.lang.String field_name,
                            boolean is_typechecked)
                     throws BrokerException
        Get a field's value - throws BrokerFieldNotFoundException if field not found
        Throws:
        BrokerException

      • getSequenceField

        public BrokerField getSequenceField​(java.lang.String field_name,
                                    int offset,
                                    int max_n,
                                    boolean is_typechecked)
                             throws BrokerException
        Get a sequence field's value
        Throws:
        BrokerException

      • setField

        public void setField​(java.lang.String field_name,
                     short value_type,
                     java.lang.Object value)
              throws BrokerException
        Set a field's value
        Throws:
        BrokerException

      • clearField

        public void clearField​(java.lang.String field_name,
                       boolean is_typechecked)
                throws BrokerException
        Clear a field's value
        Throws:
        BrokerException

      • getSequenceSize

        public int getSequenceSize​(java.lang.String field_name,
                           boolean is_typechecked)
                    throws BrokerException
        Get a sequence field's size
        Throws:
        BrokerException

      • setSequenceSize

        public void setSequenceSize​(java.lang.String field_name,
                            short type,
                            int size)
                     throws BrokerException
        Set a sequence field's size
        Throws:
        BrokerException

      • getFieldNames

        public java.lang.String[] getFieldNames​(java.lang.String field_name)
                                 throws BrokerException
        Get field names
        Throws:
        BrokerException

      • allowSetEnvelope

        public static boolean allowSetEnvelope​(boolean allowed)
        Allow/disallow setting of envelope fields for this thread. Allows setting of all broker controlled fields and of undefined fields.

      • getAllowSetEnvelope

        public static boolean getAllowSetEnvelope()

      • isValidEvent

        public boolean isValidEvent()
        Determine if this event is valid

      • validateFieldName

        public static boolean validateFieldName​(java.lang.String name)
                                 throws BrokerException
        Check if field name is valid
        Throws:
        BrokerException

      • validateEventTypeName

        public static void validateEventTypeName​(java.lang.String event_type_name)
                                  throws BrokerException
        Check if event name is valid
        Throws:
        BrokerException

      • isReservedWord

        public static boolean isReservedWord​(java.lang.String st)
        Check if a name is a reserved word

      • isExtendedReservedWord

        public static boolean isExtendedReservedWord​(java.lang.String st)
        Check if a name is an extended reserved word