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

Class IMSIAddress

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class IMSIAddress
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class IMSIAddress represents International Mobile Subscriber Identity (or International Mobile Station Identity in ITU-T terminology). It represents the ASN.1 OCTET STRING type MAP-CommonDataTypes.IMSI. An IMSI is an address formed from up to 15 digits, comprising:
    • Mobile Country Code (MCC), which is 3 digits;
    • Mobile Network Code (MNC), which is 2 or 3 digits depending on MCC;
    • Mobile Station Identification Number (MSIN).

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

     IMSI ::= SEQUENCE {
     address DigitString
 }
    (The MCC, MNC and MSIN are not separated in this class.) The class takes care of encoding the field value into a byte-array and decoding the field value from a byte-array, the encoded representation being as tabulated below.

    Data Encoding - based on 3GPP TS 23.003 V10.0.0 (2010-09) §2.2 p14
    87654321
    Octet 0Mobile country code digit 2Mobile country code digit 1
    Octet 1Mobile network code digit 1Mobile country code digit 3
    Octet 2..Rest of IMSI address

    The length of the data encoding is between 3 octets (sufficient to encode 3+2 BCD digits) and 8 octets (sufficient to contain 15 BCD digits).

    Each digit of the address field is encoded into a semi-octet, and if there is an odd number of digits then the last semi-octet is assigned a filler. Unless overridden by a particular StringCodec, the filler is 0xF and the encoding to semi-octets is as tabulated below.

    Decoded character0123456789
    Encoded hexadecimal0123456789ABCDEF
    See Also:
    Serialized Form

    • Constructor Detail

      • IMSIAddress

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

      • IMSIAddress

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

      • IMSIAddress

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

      • IMSIAddress

        public IMSIAddress​(String address)
        Constructs a new IMSIAddress object from given values for all fields.
        Parameters:
        address - the number digits

      • IMSIAddress

        public IMSIAddress​(String address,
                   StringCodec<IMSIAddress> Address_codec)
        Constructs a new IMSIAddress object from given arguments, using the given codecs for encoding fields of type String.
        Parameters:
        address - the number digits
        Address_codec - StringCodec for address

      • IMSIAddress

        public IMSIAddress​(DataInput in)
            throws IOException
        Constructs a new IMSIAddress 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

      • hasAddress

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

      • getAddress

        public String getAddress​(StringCodec<IMSIAddress> codec)
                  throws DecodeException
        Gets the value of the number digits using the given codec. If the field Address is not set, returns null. If the given codec is null, then uses the standard codec for this field.
        Parameters:
        codec - StringCodec to use for decoding
        Returns:
        String representation of the number digits
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getAddressEncoded

        public byte[] getAddressEncoded()
        Gets a clone of the encoded value of the number digits.
        Returns:
        byte[] representation of the number digits

      • setAddressEncoded

        public IMSIAddress setAddressEncoded​(byte[] encoded)
        Sets the encoded value of the number digits to a clone of the given byte array.
        Parameters:
        encoded - byte[] representation of the number digits
        Returns:
        this

      • copyOf

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

      • 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 variable length, so the given 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:
        len, or 0 if encoded value is not long enough

      • getAddressCodec

        public StringCodec<IMSIAddress> getAddressCodec()
        Gets the codec used for field Address.
        Returns:
        StringCodec