Package com.opencloud.slee.resources.in.datatypes.cc

Class BearerCapability.ITU_T

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    Enclosing class:
    BearerCapability
    public static final class BearerCapability.ITU_T
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class ITU_T indicates a requested bearer service to be provided by the network, coded in ITU_T format. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.BearerCapability.

    The API offered by this class is as if the type were specified in ASN.1 as follows. 

     ITU_T ::= SEQUENCE {
     transferCapability TransferCapability,
     transferMode       TransferMode,
     transferRate       TransferRate,
     ericsson           Ericsson         OPTIONAL,
     rateMultiplier     INTEGER          OPTIONAL,
     layer1Capability   Layer1Capability OPTIONAL,
     layer2Protocol     Layer2Protocol   OPTIONAL,
     layer3Capability   Layer3Capability OPTIONAL
 }
    The class takes care of encoding the field values into a byte-array and decoding field values from a byte-array, the encoded representation being as tabulated below.

    Data Encoding - based on ITU-T Q.931 (05/98) §4.5.5 p58 and a comment in Ericsson-INAP-CS1-Datatypes.asn
    87654321
    Octet 3ext. 1Coding standard (00)Information transfer capability
    Octet 4ext. 0/1Transfer modeInformation transfer rate
    Octet 4a*ext. 0/1StructureConfigurationEstablishment
    Octet 4b*ext. 1SymmetryReverse information transfer rate
    Octet 4.1*ext. 1Rate multiplier
    Octet 5*ext. 0/1Layer 1 ident. (01)User information layer 1 protocol
    Octet 5a*ext. 0/1Asynch?In-band negotiationUser rate
    Octet 5b*ext. 0/1Intermediate rateNIC on TxNIC on RxFlow control on TxFlow control on RxSpare (0)
    Octet 5b*ext. 0/1Rate adaptation headerMultiframeModeLLI negotiationMessage originatorNegotiationSpare (0)
    Octet 5c*ext. 0/1Number of stop bitsNumber of data bitsParity
    Octet 5d*ext. 1Duplex modeModem type
    Octet 6*ext. 1Layer 2 ident. (10)User information layer 2 protocol
    Octet 7*ext. 0Layer 3 ident. (11)User information layer 3 protocol
    Octet 7a*ext. 0Spare (000)Additional layer 3 protocol information (most significant bits)
    Octet 7b*ext. 1Spare (000)Additional layer 3 protocol information (least significant bits)

    The octet numbering in the above table is that used in the cited standard for the octets encoded here. Octets 4a and 4b are specific to Ericsson-INAP-CS1 (Ericsson numbers them 2a and 2b). Field names ending in ? are booleans: 1 for true, 0 for false.
    See Also:
    Serialized Form

    • Constructor Detail

      • ITU_T

        public ITU_T()
        Constructs a new ITU_T object with no fields set.

      • ITU_T

        public ITU_T​(byte[] data)
        Constructs a new ITU_T object from network-encoded data. The data is not decoded and might not be decodable.
        Parameters:
        data - network-encoded data
        Throws:
        NullPointerException - if data is null

      • ITU_T

        public ITU_T​(byte[] data,
             int start,
             int len)
        Constructs a new ITU_T object from part of network-encoded data. The part starts at index start and is len bytes long. The data is not decoded and might not be decodable.
        Parameters:
        data - network-encoded data
        start - starting offset of network-encoded data in byte array
        len - default length if not predictable
        Throws:
        NullPointerException - if data is null
        IllegalArgumentException - if len is negative

    • Method Detail

      • toStream

        public void toStream​(DataOutput out)
              throws IOException
        Serializes this object to a stream in a form suitable for reading by {@link #BearerCapability.ITU_T(DataInput)}.
        Specified by:
        toStream in interface FastSerializable
        Parameters:
        out - the stream to write to
        Throws:
        IOException - if an I/O error occurs

      • hasTransferCapability

        public boolean hasTransferCapability()
                              throws DecodeException
        Tests whether the field TransferCapability has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasTransferMode

        public boolean hasTransferMode()
                        throws DecodeException
        Tests whether the field TransferMode has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasTransferRate

        public boolean hasTransferRate()
                        throws DecodeException
        Tests whether the field TransferRate has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasEricsson

        public boolean hasEricsson()
                    throws DecodeException
        Tests whether the field Ericsson has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasRateMultiplier

        public boolean hasRateMultiplier()
                          throws DecodeException
        Tests whether the field RateMultiplier has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setRateMultiplierPresent

        public BearerCapability.ITU_T setRateMultiplierPresent​(boolean flag)
                                                throws IllegalStateException
        Sets the presence or absence of the field RateMultiplier.
        Parameters:
        flag - whether the field should be marked as present
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • hasLayer1Capability

        public boolean hasLayer1Capability()
                            throws DecodeException
        Tests whether the field Layer1Capability has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasLayer2Protocol

        public boolean hasLayer2Protocol()
                          throws DecodeException
        Tests whether the field Layer2Protocol has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasLayer3Capability

        public boolean hasLayer3Capability()
                            throws DecodeException
        Tests whether the field Layer3Capability has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getRateMultiplier

        public int getRateMultiplier()
                      throws DecodeException
        Gets the value of the rate multiplier, relevant if TransferRate is MULTIRATE.
        Returns:
        int representation of the rate multiplier, relevant if TransferRate is MULTIRATE
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setRateMultiplier

        public BearerCapability.ITU_T setRateMultiplier​(int value)
                                         throws IllegalStateException
        Sets the value of the rate multiplier, relevant if TransferRate is MULTIRATE.
        Parameters:
        value - int representation of the rate multiplier, relevant if TransferRate is MULTIRATE
        Returns:
        this
        Throws:
        IllegalStateException

      • copyOf

        public static BearerCapability.ITU_T copyOf​(BearerCapability.ITU_T from)
        Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
        Parameters:
        from - the object from which to copy
        Returns:
        ITU_T

      • getFieldAccessors

        public static FieldAccessor[] getFieldAccessors()
        Gets a new array of the accessors for fields of this type.
        Returns:
        FieldAccessor[]

      • getFieldsMap

        public Map<String,​Object> getFieldsMap​(boolean withAbsents)
        Gets a Map from field-name to field-value for the fields of a sequence. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an uninitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED. For a field of String type, the encoded form is used if the String cannot be decoded. For a type that represents an OCTET STRING that cannot be decoded, a map from "encodedValue" to the byte array value is returned.
        Specified by:
        getFieldsMap in class AbstractFieldsObject
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value

      • encodedIsInvalid

        protected boolean encodedIsInvalid()
        Determines whether the encoded form is invalid.
        Returns:
        boolean

      • getEncodedForm

        public byte[] getEncodedForm()
                      throws EncodeException
        Gets the encoded form.
        Returns:
        encoded form
        Throws:
        EncodeException - if encoding fails

      • getContainedLength

        public static int getContainedLength​(byte[] data,
                                     int start,
                                     int len)
        Determines the length of the encoded value that commences at offset start in the given data. The value is not fully decoded and might not be decodable. If the encoded value ends with a filling field, then the given len is returned. If the encoded value is so currupt that its length cannot be determined, then 0 is returned.
        Parameters:
        data - network-encoded data
        start - index into data where value commences
        len - length in data to be considered
        Returns:
        length of encoded value, or 0 if not decodable
        Throws:
        NullPointerException - if data is null