Package com.opencloud.slee.resources.in.datatypes.map.nsap

Class NSAPAddress

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class NSAPAddress
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class NSAPAddress encapsulates a Network Service Access Point (NSAP) Address. It represents some octets within the ASN.1 OCTET STRING type ISDN-SubaddressString.

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

     NSAPAddress ::= SEQUENCE {
     authorityAndFormatId DigitString       (SIZE (2)) (FROM ("0" .. "9", "A" .. "F", "a" .. "f")),
     initialDomainId      DigitString       (SIZE (0 .. 15)) (FROM ("0" .. "9")),
     domainSpecificPart   DigitOrCharString (SIZE (0 .. 38))
 }
    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. For the initial domain identifier and decimal format domain specific part, digit encoding and decoding may be overridden by using suitable StringCodecs.

    Data Encoding - based on ITU X.213 / ISO/IEC 8348:2002(E) Annex A
    87654321
    1 octetAuthority and format identifier (AFI) digit 2Authority and format identifier (AFI) digit 1
    m octetsPadded initial domain identifier (IDI) digits in semi-octets
    ≤20-1-m octetsDomain specific part (DSP) in binary, decimal, character or national character format

    The authority and format identifier (AFI) determines:
    • the length of the initial domain identifier (IDI) field;
    • the digit used for any leading padding of the IDI needed to bring it up to the fixed length;
    • and the format of the domain specific part (DSP).
    The digit used for leading padding is one that cannot start the IDI; for some AFIs it is 0 and for others it is 1, never anything else. If the format of the DSP is not decimal, then it must start on an octet boundary, and hence a filler semi-octet of 0xF is inserted if the IDI has an odd number of semi-octets.

    IDIs' maximum length of 15 octets (30 digits) is regardless of particular AFI. The maximum length of an NSAPAddress is 20 octets. The maximum length of the DSP is the space remaining when the lengths of the other fields are subtracted from the overall maximum.

    The properties determined by an AFI are recorded by AuthorityAndFormatIds.

    Each digit of the AFI field is encoded into a semi-octet. Unless overridden by a particular StringCodec, the encoding to semi-octets is as tabulated below.

    Decoded character0123456789abcdef
    Encoded hexadecimal0123456789ABCDEF

    Each digit of the IDI field is encoded into a semi-octet. Unless overridden by a particular StringCodec, the encoding to semi-octets is as tabulated below.

    Decoded character0123456789
    Encoded hexadecimal0123456789ABCDEF

    If the DSP field is encoded using BCD, then each digit of the DSP 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

    • Field Detail

      • AUTHORITYANDFORMATID_CODEC

        public static final BCDStringCodec<NSAPAddress> AUTHORITYANDFORMATID_CODEC
        BCD string codec for field AuthorityAndFormatId.

      • INITIALDOMAINID_CODEC

        public static final BCDStringCodec<NSAPAddress> INITIALDOMAINID_CODEC
        BCD string codec for field InitialDomainId.

      • DOMAINSPECIFICPART_CODEC_BCD

        public static final BCDStringCodec<NSAPAddress> DOMAINSPECIFICPART_CODEC_BCD
        BCD string codec for field DomainSpecificPart.

      • DOMAINSPECIFICPART_CODEC_BINARY

        public static final BinaryStringCodec<NSAPAddress> DOMAINSPECIFICPART_CODEC_BINARY
        Binary string codec for field DomainSpecificPart.

      • DOMAINSPECIFICPART_CODEC_ISO646BCD

        public static final ISO646BCDStringCodec<NSAPAddress> DOMAINSPECIFICPART_CODEC_ISO646BCD
        Printable ASCII/ISO646-US string codec for field DomainSpecificPart.

    • Constructor Detail

      • NSAPAddress

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

      • NSAPAddress

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

      • NSAPAddress

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

      • NSAPAddress

        public NSAPAddress​(String authorityAndFormatId,
                   String initialDomainId,
                   String domainSpecificPart)
        Constructs a new NSAPAddress object from given values for all fields.
        Parameters:
        authorityAndFormatId - Authority and format identifier
        initialDomainId - Initial domain identifier
        domainSpecificPart - Domain specific part

      • NSAPAddress

        public NSAPAddress​(String authorityAndFormatId,
                   String initialDomainId,
                   String domainSpecificPart,
                   StringCodec<NSAPAddress> AuthorityAndFormatId_codec,
                   StringCodec<NSAPAddress> InitialDomainId_codec,
                   StringCodec<NSAPAddress> DomainSpecificPart_codec)
        Constructs a new NSAPAddress object from given arguments, using the given codecs for encoding fields of type String.
        Parameters:
        authorityAndFormatId - Authority and format identifier
        initialDomainId - Initial domain identifier
        domainSpecificPart - Domain specific part
        AuthorityAndFormatId_codec - StringCodec for authorityAndFormatId
        InitialDomainId_codec - StringCodec for initialDomainId
        DomainSpecificPart_codec - StringCodec for domainSpecificPart

      • NSAPAddress

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

      • hasAuthorityAndFormatId

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

      • hasInitialDomainId

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

      • hasDomainSpecificPart

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

      • getAuthorityAndFormatId

        public String getAuthorityAndFormatId​(StringCodec<NSAPAddress> codec)
                               throws DecodeException
        Gets the value of Authority and format identifier using the given codec. If the field AuthorityAndFormatId 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 Authority and format identifier
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getAuthorityAndFormatIdEncoded

        public EncodedStringWithIndicators getAuthorityAndFormatIdEncoded()
        Gets a clone of the encoded value of Authority and format identifier.
        Returns:
        EncodedStringWithIndicators representation of Authority and format identifier

      • setAuthorityAndFormatId

        public NSAPAddress setAuthorityAndFormatId​(String value,
                                           StringCodec<NSAPAddress> codec)
                                    throws IllegalArgumentException
        Sets the value of Authority and format identifier using the given codec. If the given codec is null, uses the standard codec.
        Parameters:
        value - String representation of Authority and format identifier
        codec - StringCodec to use for encoding
        Returns:
        this
        Throws:
        IllegalArgumentException

      • setAuthorityAndFormatIdEncoded

        public NSAPAddress setAuthorityAndFormatIdEncoded​(EncodedStringWithIndicators encoded)
        Sets the encoded value of Authority and format identifier to a clone of the given EncodedStringIndicators.
        Parameters:
        encoded - EncodedStringWithIndicators representation of Authority and format identifier
        Returns:
        this

      • getInitialDomainId

        public String getInitialDomainId​(StringCodec<NSAPAddress> codec)
                          throws DecodeException
        Gets the value of Initial domain identifier using the given codec. If the field InitialDomainId 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 Initial domain identifier
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getInitialDomainIdEncoded

        public EncodedStringWithIndicators getInitialDomainIdEncoded()
        Gets a clone of the encoded value of Initial domain identifier.
        Returns:
        EncodedStringWithIndicators representation of Initial domain identifier

      • setInitialDomainIdEncoded

        public NSAPAddress setInitialDomainIdEncoded​(EncodedStringWithIndicators encoded)
        Sets the encoded value of Initial domain identifier to a clone of the given EncodedStringIndicators.
        Parameters:
        encoded - EncodedStringWithIndicators representation of Initial domain identifier
        Returns:
        this

      • getDomainSpecificPart

        public String getDomainSpecificPart​(StringCodec<NSAPAddress> codec)
                             throws DecodeException
        Gets the value of Domain specific part using the given codec. If the field DomainSpecificPart is not set, returns null. If the given codec is null, then uses the standard codec for this field. The standard codec is determined by the values of other fields, so beware that changes to those other fields can affect the decoding done by this getter.
        Parameters:
        codec - StringCodec to use for decoding
        Returns:
        String representation of Domain specific part
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getDomainSpecificPartEncoded

        public byte[] getDomainSpecificPartEncoded()
        Gets a clone of the encoded value of Domain specific part.
        Returns:
        byte[] representation of Domain specific part

      • setDomainSpecificPart

        public NSAPAddress setDomainSpecificPart​(String value,
                                         StringCodec<NSAPAddress> codec)
                                  throws IllegalArgumentException
        Sets the value of Domain specific part using the given codec. If the given codec is null, uses the standard codec. The standard codec is determined by the values of other fields, so ensure that those other fields are set before calling this setter.
        Parameters:
        value - String representation of Domain specific part
        codec - StringCodec to use for encoding
        Returns:
        this
        Throws:
        IllegalArgumentException

      • setDomainSpecificPartEncoded

        public NSAPAddress setDomainSpecificPartEncoded​(byte[] encoded)
        Sets the encoded value of Domain specific part to a clone of the given byte array.
        Parameters:
        encoded - byte[] representation of Domain specific part
        Returns:
        this

      • copyOf

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

      • 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

      • getAuthorityAndFormatIdCodec

        public StringCodec<NSAPAddress> getAuthorityAndFormatIdCodec()
        Gets the codec used for field AuthorityAndFormatId.
        Returns:
        StringCodec

      • getInitialDomainIdCodec

        public StringCodec<NSAPAddress> getInitialDomainIdCodec()
        Gets the codec used for field InitialDomainId.
        Returns:
        StringCodec

      • getDomainSpecificPartCodec

        public StringCodec<NSAPAddress> getDomainSpecificPartCodec()
        Gets the codec used for field DomainSpecificPart. This depends on the current value of field AuthorityAndFormatId.
        Returns:
        StringCodec, or null if AuthorityAndFormatId is uninitialised

      • toRPF

        public String toRPF()
             throws DecodeException
        Gets this NSAPAddress in Reference Publication Format (RPF). For example, the RPF for an NSAP address with an AFI value of 39, an IDI value of 840, and a binary-syntax DSP value of 01001100 11100101 would be 39840+4CE5.
        Returns:
        String containing this NSAPAddress in RPF
        Throws:
        DecodeException - if properties of AFI are unknown