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

Class IMSIAddress

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

com.opencloud.slee.resources.in.datatypes.cc.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
	8	7	6	5	4	3	2	1
Octet 0	Mobile country code digit 2				Mobile country code digit 1
Octet 1	Mobile network code digit 1				Mobile 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 character	0	1	2	3	4	5	6	7	8	9
Encoded hexadecimal	0	1	2	3	4	5	6	7	8	9	A	B	C	D	E	F

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static BCDStringCodec<IMSIAddress>	ADDRESS_CODEC BCD string codec for field Address.

Fields inherited from class AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
IMSIAddress() Constructs a new IMSIAddress object with no fields set.
IMSIAddress(byte[] data) Constructs a new IMSIAddress object from network-encoded data.
IMSIAddress(byte[] data, int start, int len) Constructs a new IMSIAddress object from part of network-encoded data.
IMSIAddress(DataInput in) Constructs a new IMSIAddress object from data deserialized from a stream that was written by toStream(DataOutput).
IMSIAddress(String address) Constructs a new IMSIAddress object from given values for all fields.
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.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
IMSIAddress	clone() Constructs a copy of this object and everything reachable from it.
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.
protected void	decode() Computes the decoded form from the encoded form.
protected void	encode() Computes the encoded form from the decoded form.
protected boolean	encodedIsInvalid() Determines whether the encoded form is invalid.
String	getAddress() Gets the value of the number digits.
String	getAddress(StringCodec<IMSIAddress> codec) Gets the value of the number digits using the given codec.
StringCodec<IMSIAddress>	getAddressCodec() Gets the codec used for field Address.
byte[]	getAddressEncoded() Gets a clone of the encoded value of the number digits.
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.
byte[]	getEncodedForm() Gets the encoded form.
static FieldAccessor[]	getFieldAccessors() Gets a new array of the accessors for fields of this type.
Map<String,Object>	getFieldsMap(boolean withAbsents) Gets a Map from field-name to field-value for the fields of a sequence.
boolean	hasAddress() Tests whether the field Address has a value.
IMSIAddress	setAddress(String value) Sets the value of the number digits.
IMSIAddress	setAddress(String value, StringCodec<IMSIAddress> codec) Sets the value of the number digits using the given codec.
IMSIAddress	setAddressEncoded(byte[] encoded) Sets the encoded value of the number digits to a clone of the given byte array.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by IMSIAddress(DataInput).

Methods inherited from class AbstractLazyEncodedDataObject

checkDecode, checkModifyAndDecode

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly, setReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ADDRESS_CODEC

public static final BCDStringCodec<IMSIAddress> ADDRESS_CODEC

BCD string codec for field Address.

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

toStream

public void toStream(DataOutput out)
              throws IOException

Serializes this object to a stream in a form suitable for reading by IMSIAddress(DataInput).

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

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

checkFieldsSet

public void checkFieldsSet()
                    throws EncodeException

Checks that all mandatory fields are present. Should be called immediately before all calls to encode().

Specified by:

checkFieldsSet in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if any mandatory field is not present

getAddress

public String getAddress()
                  throws DecodeException

Gets the value of the number digits. Equivalent to getAddress(null).

Returns:

String representation of the number digits

Throws:

DecodeException - if encoded state cannot be decoded

setAddress

public IMSIAddress setAddress(String value)
                       throws IllegalStateException

Sets the value of the number digits.

Parameters:

value - String representation of the number digits

Returns:

this

Throws:

IllegalStateException

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

setAddress

public IMSIAddress setAddress(String value,
                     StringCodec<IMSIAddress> codec)
                       throws IllegalArgumentException

Sets the value of the number digits using the given codec. If the given codec is null, uses the standard codec.

Parameters:

value - String representation of the number digits

codec - StringCodec to use for encoding

Returns:

this

Throws:

IllegalArgumentException

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

clone

public IMSIAddress clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

Returns:

copy of object

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

encode

protected void encode()
               throws EncodeException

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if address is less than 5 or more than 15 digits

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if less than 3 or more than 7.5 octets to be decoded