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

Class AccessPointName

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class AccessPointName
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class AccessPointName represents a reference to a Gateway GPRS Support Node (GGSN) or Public Data Network (PDN) Gateway (PGW), as used in GPRS subscription data. See also AccessPointName.

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

     AccessPointName ::= SEQUENCE {
     networkId  CharString,
     operatorId CharString OPTIONAL
 }

    The networkId is of the form label.label.label..., with at least one label and a maximum length of 62 characters. The optional operatorId is of the form label.label.gprs, with exactly three labels and a maximum length of 36 characters. All labels are alphanumeric, with hyphens permitted in-between alphanumerics, except for the case of the wildcard access point name, which is just an asterisk.

    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 3GPP TS 23.003 V10.0.0 (2010-12) §9 pp30-32
    87654321
    Octet 0Length (n) of 1st label
    Octet 1Characters of 1st label
    ..
    Octet n
    ...Further labels

    Each label is encoded as its length followed by its characters, excluding any dot. The length of the data encoding depends on the lengths of the character strings.
    See Also:
    Serialized Form

    • Constructor Detail

      • AccessPointName

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

      • AccessPointName

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

      • AccessPointName

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

      • AccessPointName

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

      • hasNetworkId

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

      • hasOperatorId

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

      • getNetworkId

        public String getNetworkId​(StringCodec<AccessPointName> codec)
                    throws DecodeException
        Gets the value of the network identifier using the given codec. If the field NetworkId 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 network identifier
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getNetworkIdEncoded

        public byte[] getNetworkIdEncoded()
        Gets a clone of the encoded value of the network identifier.
        Returns:
        byte[] representation of the network identifier

      • setNetworkIdEncoded

        public AccessPointName setNetworkIdEncoded​(byte[] encoded)
        Sets the encoded value of the network identifier to a clone of the given byte array.
        Parameters:
        encoded - byte[] representation of the network identifier
        Returns:
        this

      • getOperatorId

        public String getOperatorId​(StringCodec<AccessPointName> codec)
                     throws DecodeException
        Gets the value of the operator identifier using the given codec. If the field OperatorId 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 operator identifier
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getOperatorIdEncoded

        public byte[] getOperatorIdEncoded()
        Gets a clone of the encoded value of the operator identifier.
        Returns:
        byte[] representation of the operator identifier

      • setOperatorIdEncoded

        public AccessPointName setOperatorIdEncoded​(byte[] encoded)
        Sets the encoded value of the operator identifier to a clone of the given byte array.
        Parameters:
        encoded - byte[] representation of the operator identifier
        Returns:
        this

      • copyOf

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

      • 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

      • getNetworkIdCodec

        public StringCodec<AccessPointName> getNetworkIdCodec()
        Gets the codec used for field NetworkId.
        Returns:
        StringCodec

      • getOperatorIdCodec

        public StringCodec<AccessPointName> getOperatorIdCodec()
        Gets the codec used for field OperatorId.
        Returns:
        StringCodec

      • decode

        protected void decode()
               throws DecodeException
        Computes the decoded form from the encoded form. The optional Operator Identifier is present if and only if the full sequence of labels has at least three labels and the last label is "gprs".
        Specified by:
        decode in class AbstractLazyEncodedDataObject<byte[]>
        Throws:
        DecodeException - if cannot decode data