com.objsys.asn1j.runtime

Class Asn1NasEncodeBuffer

java.lang.Object

com.objsys.asn1j.runtime.Asn1MessageBufferBase

com.objsys.asn1j.runtime.Asn1MessageBuffer

com.objsys.asn1j.runtime.Asn1EncodeBuffer

com.objsys.asn1j.runtime.Asn1EncodeBitBuffer

com.objsys.asn1j.runtime.Asn1NasEncodeBuffer

All Implemented Interfaces:

Asn1BitMessageBuffer, Asn1Writable

public class Asn1NasEncodeBuffer
extends Asn1EncodeBitBuffer

This class handles non-ASN.1 encodings related to 3GPP specifications. NAS stands for Non-Access Stratum, though not everything this class is used for is necessarily part of NAS; we use the term NAS as more of an umbrella term for messages that are not defined using ASN.1.

Field Summary

Fields inherited from class com.objsys.asn1j.runtime.Asn1EncodeBitBuffer

mByteIndex, mData, mTraceHandler

Fields inherited from class com.objsys.asn1j.runtime.Asn1EncodeBuffer

INITIAL_SIZE

Fields inherited from class com.objsys.asn1j.runtime.Asn1MessageBufferBase

context, mTypeCode

Constructor Summary

Constructors

Constructor and Description
Asn1NasEncodeBuffer() This constructor creates an encode buffer object with the default initial size.
Asn1NasEncodeBuffer(int size) This constructor creates an encode buffer object with the given initial size.

Method Summary

Modifier and Type	Method and Description
void	encodeAltDetmnt(int detmnt, int detmntBits, int lhmask) Encode the given alternative determinant value in the given number of bits, translating L/H bits according to the pattern 0x2B and based on the buffer's bit offset.
void	encodeAPN(java.lang.String apn) Encode an APN string, given using dot-notation (a.b.c), following TS 24.008 and TS 23.003.
void	encodeBitsPattern(byte pattern, int nbits) This function encodes the given number of bits using a repeating bit pattern.
void	encodeByteAlignPattern(byte pattern) This function will byte-align the buffer by encoding according to the given pattern.
void	encodeMCCMNC(Asn1IA5String mcc, Asn1IA5String mnc) Encode an MCC-MNC pair.
void	encodeMobileIdentityType1(int type, java.lang.String str) Encode alternatives of MobileIdentity.
byte	getPatternBit(byte pattern) This function picks out the bit from the given pattern that corresponds to the current bit offset in buffer.
boolean	isContainerClosed() Return true if the container closed flag is set.
void	setContainerClosed(boolean value) Set or clear the container closed flag.

Methods inherited from class com.objsys.asn1j.runtime.Asn1EncodeBitBuffer

binDump, byteAlign, checkSize, copy, copy, encodeBit, encodeBits, encodeBits, encodeBits, encodeLongBits, encodeLongBits, getBitOffsetInByte, getBuffer, getByteArrayInputStream, getByteIndex, getMsgBitCnt, getMsgByteCnt, getMsgCopy, getMsgLength, getTraceHandler, hexDump, isByteAligned, reset, reverseBytes, setMsgBitCnt, toString, write, write, write, write

Methods inherited from class com.objsys.asn1j.runtime.Asn1EncodeBuffer

binDump, copy, encodeIntSigned, encodeIntUnsigned, getInputStream, getMinimalOctetsSigned, getMinimalOctetsUnsigned, getOutputStream, hexDump

Methods inherited from class com.objsys.asn1j.runtime.Asn1MessageBuffer

addNamedEventHandler, getEventHandlerListCount, hasEventHandlers, invokeCharacters, invokeEndElement, invokeStartElement, setEventHandlerList

Methods inherited from class com.objsys.asn1j.runtime.Asn1MessageBufferBase

getContext, hexDump, hexDump, setKey, setTypeCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.objsys.asn1j.runtime.Asn1BitMessageBuffer

getInputStream

Constructor Detail

Asn1NasEncodeBuffer

public Asn1NasEncodeBuffer()

This constructor creates an encode buffer object with the default initial size. Whenever the buffer becomes full, it will be expanded.

Asn1NasEncodeBuffer

public Asn1NasEncodeBuffer(int size)

This constructor creates an encode buffer object with the given initial size. Whenever the buffer becomes full, it will be expanded. For best performance, this size should be large enough to prevent resizing in normal operation.

Parameters:

size - The initial size in bytes of an encode buffer.

Method Detail

encodeAltDetmnt

public final void encodeAltDetmnt(int detmnt,
                                  int detmntBits,
                                  int lhmask)

Encode the given alternative determinant value in the given number of bits, translating L/H bits according to the pattern 0x2B and based on the buffer's bit offset. The lhmask specifies which bits are L/H bits and which are simply 0/1 bits.

Parameters:

detmnt - The determinant value to encode (in lowest bits)

detmntBits - The number of bits from detmnt to encode.

lhmask - A mask which indicates whether each bit in detmnt is a 0/1 bit or an L/H bit. L/H bits are represented in detmnt using 0/1, respectively. This is left-aligned so that the highest bit in the mask applies to the first bit to be encoded.

encodeAPN

public void encodeAPN(java.lang.String apn)

Encode an APN string, given using dot-notation (a.b.c), following TS 24.008 and TS 23.003.

Parameters:

apn - The APN to encode.

encodeBitsPattern

public void encodeBitsPattern(byte pattern,
                              int nbits)

This function encodes the given number of bits using a repeating bit pattern. This function may be used to encode any number of bits (including more than 8 bits). It will take the bit values to encode from the pattern, in accordance with the buffer's bit offset. For example, if the next bit to encode is the highest bit of the next byte in the buffer, then the bit value encoded will be the highest bit of the pattern.

Parameters:

pattern - The repeating pattern.

nbits - The number of bits to encode.

encodeByteAlignPattern

public final void encodeByteAlignPattern(byte pattern)

This function will byte-align the buffer by encoding according to the given pattern. If the buffer is not aligned, the lowest bits of the current byte, which have not be written already, will be set to the corresponding lowest bits of the given pattern.

encodeMCCMNC

public void encodeMCCMNC(Asn1IA5String mcc,
                         Asn1IA5String mnc)
                  throws java.io.IOException

Encode an MCC-MNC pair.

Parameters:

mcc -

mnc -

Throws:

java.io.IOException

encodeMobileIdentityType1

public final void encodeMobileIdentityType1(int type,
                                            java.lang.String str)

Encode alternatives of MobileIdentity.

Parameters:

type - Identifies the alternative used. Values correspond to the values generated for choice for MobileIdentity: IMSI = 1 IMEI = 2 IMEISV = 3 TMSI = 4 TMGI = 5

str - The value of the alternative.

getPatternBit

public final byte getPatternBit(byte pattern)

This function picks out the bit from the given pattern that corresponds to the current bit offset in buffer. For example, if the buffer's bit offset is set to write to the most significant next, then this will return the value of the most significant bit in the given pattern. This can be used to get the value of a CSN.1 "L" bit by using pattern 0x2B or an H bit using pattern 0xD4.

Returns:

bit value of 0 or 1 as described above

isContainerClosed

public final boolean isContainerClosed()

Return true if the container closed flag is set.

Returns:

setContainerClosed

public final void setContainerClosed(boolean value)

Set or clear the container closed flag.

Parameters:

value -