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

Class RedirectionInformation

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class RedirectionInformation
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class RedirectionInformation represents redirection information. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.RedirectionInformation.

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

     RedirectionInformation ::= SEQUENCE {
     redirecting        Redirecting,
     originalReason     OriginalReason,
     redirectingReason  RedirectingReason,
     redirectionCounter INTEGER
 }
    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.763 (12/1999) §3.45 p49
    87654321
    Octet 1Original redirection reasonSpareRedirecting
    Octet 2Redirecting reasonReserved for national useRedirection counter

    The octet numbering in the above table is that used in the cited standard.
    See Also:
    Serialized Form

    • Constructor Detail

      • RedirectionInformation

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

      • RedirectionInformation

        public RedirectionInformation​(byte[] data)
        Constructs a new RedirectionInformation 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

      • RedirectionInformation

        public RedirectionInformation​(byte[] data,
                              int start,
                              int len)
        Constructs a new RedirectionInformation 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

      • RedirectionInformation

        public RedirectionInformation​(DataInput in)
                       throws IOException
        Constructs a new RedirectionInformation object from data deserialized from a stream that was written by toStream(DataOutput).
        Parameters:
        in - the stream to read from
        Throws:
        EOFException - if reading is pre-empted by end-of-file
        IOException - if the data cannot be read

    • Method Detail

      • hasRedirecting

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

      • hasOriginalReason

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

      • hasRedirectingReason

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

      • hasRedirectionCounter

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

      • setRedirectionCounterPresent

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

      • getRedirectionCounter

        public int getRedirectionCounter()
                          throws DecodeException
        Gets the value of the number of redirections the call has undergone.
        Returns:
        int representation of the number of redirections the call has undergone
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setRedirectionCounter

        public RedirectionInformation setRedirectionCounter​(int value)
                                             throws IllegalStateException
        Sets the value of the number of redirections the call has undergone.
        Parameters:
        value - int representation of the number of redirections the call has undergone
        Returns:
        this
        Throws:
        IllegalStateException

      • copyOf

        public static RedirectionInformation copyOf​(RedirectionInformation 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:
        RedirectionInformation

      • 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. Values of this type are of a fixed length, so that length is returned if the data is long enough, otherwise 0 is returned.
        Parameters:
        data - network-encoded data
        start - index into data where value commences
        len - length in data to be considered
        Returns:
        2, or 0 if encoded value is not long enough

      • encode

        protected void encode()
               throws EncodeException
        Computes the encoded form from the decoded form.
        Specified by:
        encode in class AbstractLazyEncodedDataObject<byte[]>
        Throws:
        EncodeException - if OriginalReason is not in range [0,15] or Redirecting is not in range [0,7] or RedirectingReason is not in range [0,15] or RedirectionCounter s not in range [1,5]