Class AccessPointName
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<byte[]>
-
- AbstractLazyEncodedByteArray
-
- com.opencloud.slee.resources.in.datatypes.map.AccessPointName
-
- All Implemented Interfaces:
DataObject
,FastSerializable
,Serializable
public 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 alsoAccessPointName
.The API offered by this class is as if the type were specified in ASN.1 as follows.
AccessPointName ::= SEQUENCE { networkId CharString }
The networkId is of the form label.label.label..., with at least one label and a maximum length of 62 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 8 7 6 5 4 3 2 1 Octet 0 Length (n) of 1st label Octet 1 Characters 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 length of the character string.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static IA5StringCodec<AccessPointName>
NETWORKID_CODEC
ASCII/ISO646-US string codec for field NetworkId.-
Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
isDecoded
-
Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject
encoded
-
Fields inherited from class com.opencloud.util.AbstractFieldsObject
FIELD_ABSENT, FIELD_UNINITIALISED
-
-
Constructor Summary
Constructors Constructor Description AccessPointName()
Constructs a new AccessPointName object with no fields set.AccessPointName(byte[] data)
Constructs a new AccessPointName object from network-encoded data.AccessPointName(byte[] data, int start, int len)
Constructs a new AccessPointName object from part of network-encoded data.AccessPointName(DataInput in)
Constructs a new AccessPointName object from data deserialized from a stream that was written bytoStream(DataOutput)
.AccessPointName(String networkId)
Constructs a new AccessPointName object from given values for all fields.AccessPointName(String networkId, StringCodec<AccessPointName> NetworkId_codec)
Constructs a new AccessPointName object from given arguments, using the given codecs for encoding fields of type String.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkFieldsSet()
Checks that all mandatory fields are present.AccessPointName
clone()
Constructs a copy of this object and everything reachable from it.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.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.static int
getContainedLength(byte[] data, int start, int len)
Determines the length of the encoded value that commences at offsetstart
in the givendata
.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.String
getNetworkId()
Gets the value of the network identifier.String
getNetworkId(StringCodec<AccessPointName> codec)
Gets the value of the network identifier using the given codec.StringCodec<AccessPointName>
getNetworkIdCodec()
Gets the codec used for field NetworkId.byte[]
getNetworkIdEncoded()
Gets a clone of the encoded value of the network identifier.boolean
hasNetworkId()
Tests whether the field NetworkId has a value.AccessPointName
setNetworkId(String value)
Sets the value of the network identifier.AccessPointName
setNetworkId(String value, StringCodec<AccessPointName> codec)
Sets the value of the network identifier using the given codec.AccessPointName
setNetworkIdEncoded(byte[] encoded)
Sets the encoded value of the network identifier to a clone of the given byte array.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading byAccessPointName(DataInput)
.-
Methods inherited from class com.opencloud.slee.resources.cgin.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
-
-
-
-
Field Detail
-
NETWORKID_CODEC
public static final IA5StringCodec<AccessPointName> NETWORKID_CODEC
ASCII/ISO646-US string codec for field NetworkId.
-
-
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 indexstart
and islen
bytes long. The data is not decoded and might not be decodable.- Parameters:
data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictable- Throws:
NullPointerException
- if data is nullIllegalArgumentException
- if len is negative
-
AccessPointName
public AccessPointName(String networkId)
Constructs a new AccessPointName object from given values for all fields.- Parameters:
networkId
- the network identifier
-
AccessPointName
public AccessPointName(String networkId, StringCodec<AccessPointName> NetworkId_codec)
Constructs a new AccessPointName object from given arguments, using the given codecs for encoding fields of type String.- Parameters:
networkId
- the network identifierNetworkId_codec
- StringCodec for networkId
-
AccessPointName
public AccessPointName(DataInput in) throws IOException
Constructs a new AccessPointName object from data deserialized from a stream that was written bytoStream(DataOutput)
.- Parameters:
in
- the stream to read from- Throws:
EOFException
- if reading is pre-empted by end-of-fileIOException
- 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 byAccessPointName(DataInput)
.- Specified by:
toStream
in interfaceFastSerializable
- Parameters:
out
- the stream to write to- Throws:
IOException
- if an I/O error occurs
-
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
-
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 classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if any mandatory field is not present
-
getNetworkId
public String getNetworkId() throws DecodeException
Gets the value of the network identifier. Equivalent togetNetworkId(null)
.- Returns:
- String representation of the network identifier
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setNetworkId
public AccessPointName setNetworkId(String value) throws IllegalStateException
Sets the value of the network identifier.- Parameters:
value
- String representation of the network identifier- Returns:
- this
- Throws:
IllegalStateException
-
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
-
setNetworkId
public AccessPointName setNetworkId(String value, StringCodec<AccessPointName> codec) throws IllegalArgumentException
Sets the value of the network identifier using the given codec. If the given codec is null, uses the standard codec.- Parameters:
value
- String representation of the network identifiercodec
- StringCodec to use for encoding- Returns:
- this
- Throws:
IllegalArgumentException
-
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
-
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
-
clone
public AccessPointName clone()
Constructs a copy of this object and everything reachable from it.- Specified by:
clone
in interfaceDataObject
- Specified by:
clone
in classAbstractDataObject
- 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 classAbstractFieldsObject
- 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 offsetstart
in the givendata
. 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 datastart
- index into data where value commenceslen
- 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
-
encode
protected void encode() throws EncodeException
Computes the encoded form from the decoded form.- Specified by:
encode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if cannot encode data
-
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 classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if cannot decode data
-
-