NasCoder (OSS 5GS NAS/Java API)

java.lang.Object
- com.oss.nas.NasCoder<T>

Type Parameters:

T - defines the NAS PDU type.

Direct Known Subclasses:

NASCoder
```
public class NasCoder<T extends AbstractData>
extends java.lang.Object
```
Implements encoding, decoding, and printing of NAS messages. The NasCoder can
- Print a binary NAS message in JSON, XML, or ASN.1 value notation format.
- Decode a binary NAS message into a Java object.
- Encode a Java object that represents a NAS message into binary octets.
- Print a Java object that represents a NAS message in JSON, XML, or ASN.1 value notation format.
Since:

NAS/Java 1.0

Field Summary

Fields
Modifier and Type Field and Description

Originator originator
Identifies the originator of an NAS message.

Fields
Modifier and Type	Field and Description
`Originator`	`originator` Identifies the originator of an NAS message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`decode(java.nio.ByteBuffer nasMessage)` Decodes a binary NAS message into a Java object.
`java.lang.String`	`decodeToJSON(java.nio.ByteBuffer nasMessage)` Converts a binary NAS message to a JSON value.
`java.lang.String`	`decodeToText(java.nio.ByteBuffer nasMessage)` Converts a binary NAS message to ASN.1 value notation format.
`java.lang.String`	`decodeToXML(java.nio.ByteBuffer nasMessage)` Converts a binary NAS message to an XML document.
`Diagnostics`	`diagnostics()` Returns the diagnostic report created by the most recent invocation of the `NasCoder` API.
`java.nio.ByteBuffer`	`encode(T nasMessage)` Encodes the Java object that represents the NAS message into binary bytes.
`java.nio.ByteBuffer`	`encode(T nasMessage, java.nio.ByteBuffer sink)` Attempts to encode the Java object that represents the NAS message into a pre-allocated buffer.
`JSONOptions`	`getJSONOptions()` Retrieves the current formatting options that are used when the NAS message is converted to JSON format.
`TextOptions`	`getTextOptions()` Retrieves the current formatting options that are used when the NAS message is converted to ASN.1 value notation format.
`XMLOptions`	`getXMLOptions()` Retrieves the current formatting options that are used when the NAS message is converted to an XML document.
`boolean`	`hasDiagnostics()` Indicates whether the most recent invocation of the `NasCoder` API revealed defects in the NAS message.
`java.lang.String`	`printJSON(T nasMessage)` Converts the Java object that represents the NAS message to a JSON value.
`java.lang.String`	`printMessage(T nasMessage)` Converts the Java object that represents the NAS message into ASN.1 value notation format.
`java.lang.String`	`printXML(T nasMessage)` Converts the Java object that represents the NAS message to an XML document.
`void`	`setJSONOptions(JSONOptions options)` Specifies the formatting options that are used when the NAS message is converted to JSON format.
`void`	`setTextOptions(TextOptions options)` Specifies the formatting options that are used when the NAS message is converted to ASN.1 value notation format.
`void`	`setXMLOptions(XMLOptions options)` Specifies the formatting options that are used when the NAS message is converted to an XML document.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - originator
```
public Originator originator
```
    Identifies the originator of an NAS message. Some NAS messages can originate only from the network, while other NAS messages can be sent only by the UE.
- Method Detail
  - decodeToJSON
```
public java.lang.String decodeToJSON(java.nio.ByteBuffer nasMessage)
                              throws NASDecodeFailedException
```
    Converts a binary NAS message to a JSON value.
    
    Parameters:
    
    nasMessage - the binary NAS message.
    
    Returns:
    
    the String that contains the JSON value.
    
    Throws:
    
    NASDecodeFailedException - when the conversion fails because the binary message is syntactically invalid and cannot be decoded.
  - decodeToXML
```
public java.lang.String decodeToXML(java.nio.ByteBuffer nasMessage)
                             throws NASDecodeFailedException
```
    Converts a binary NAS message to an XML document.
    
    Parameters:
    
    nasMessage - the binary NAS message.
    
    Returns:
    
    the String that contains the XML document.
    
    Throws:
    
    NASDecodeFailedException - when the conversion fails because the binary message is syntactically invalid and cannot be decoded.
  - decodeToText
```
public java.lang.String decodeToText(java.nio.ByteBuffer nasMessage)
                              throws NASDecodeFailedException
```
    Converts a binary NAS message to ASN.1 value notation format.
    
    Parameters:
    
    nasMessage - the binary NAS message.
    
    Returns:
    
    the String that contains the ASN.1 value notation of the message.
    
    Throws:
    
    NASDecodeFailedException - when the conversion fails because the binary message is syntactically invalid and cannot be decoded.
  - decode
```
public T decode(java.nio.ByteBuffer nasMessage)
         throws NASDecodeFailedException
```
    Decodes a binary NAS message into a Java object.
    
    Parameters:
    
    nasMessage - the binary NAS message.
    
    Returns:
    
    the Java object that represents the contents of the NAS message.
    
    Throws:
    
    NASDecodeFailedException - when the binary message is syntactically invalid and cannot be decoded.
  - encode
```
public java.nio.ByteBuffer encode(T nasMessage)
                           throws NASEncodeFailedException
```
    Encodes the Java object that represents the NAS message into binary bytes. The ByteBuffer object that receives the binary bytes is allocated dynamically. The returned ByteBuffer is not flipped. You must invoke its flip() method before using it.
    
    Parameters:
    
    nasMessage - the Java object that represents the NAS message.
    
    Returns:
    
    the ByteBuffer object that contains the encoded NAS message.
    
    Throws:
    
    NASEncodeFailedException - when the message cannot be encoded because the value represented by the nasMessage has semantic errors.
  - encode
```
public java.nio.ByteBuffer encode(T nasMessage,
                                  java.nio.ByteBuffer sink)
                           throws NASEncodeFailedException
```
    Attempts to encode the Java object that represents the NAS message into a pre-allocated buffer. When the buffer capacity is too small to receive the encoded message it is expanded as necessary. In this case the returned ByteBuffer object can differ from the ByteBuffer passed in the sink parameter. The returned ByteBuffer is not flipped. You must invoke its flip() method before using it.
    
    Parameters:
    
    nasMessage - the Java object that represents the NAS message.
    
    sink - the pre-allocated ByteBuffer that will receive the encoded data.
    
    Returns:
    
    the ByteBuffer object that contains the encoded NAS message.
    
    Throws:
    
    NASEncodeFailedException - when the message cannot be encoded because the value represented by the nasMessage has semantic errors.
  - printJSON
```
public java.lang.String printJSON(T nasMessage)
```
    Converts the Java object that represents the NAS message to a JSON value. Unlike the decodeToJSON method, it does not throw an exception when the Java object has semantic errors but returns a null String. You can use the diagnostics() method to retrieve the diagnostics report in that case.
    
    Parameters:
    
    nasMessage - the Java object that represents the NAS message.
    
    Returns:
    
    the String that contains the JSON object.
  - printXML
```
public java.lang.String printXML(T nasMessage)
```
    Converts the Java object that represents the NAS message to an XML document. Unlike the decodeToXML method, it does not throw an exception when the Java object has semantic errors but returns a null String. You can use the diagnostics() method to retrieve the diagnostics report in that case.
    
    Parameters:
    
    nasMessage - the Java object that represents the NAS message.
    
    Returns:
    
    the String that contains the XML document.
  - printMessage
```
public java.lang.String printMessage(T nasMessage)
```
    Converts the Java object that represents the NAS message into ASN.1 value notation format. Unlike the decodeToText method, it does not throw an exception when the Java object has semantic errors but returns a null String. You can use the diagnostics() method to retrieve the diagnostics report in that case.
    
    Parameters:
    
    nasMessage - the Java object that represents the NAS message.
    
    Returns:
    
    the String that contains the ASN.1 value notation for the NAS message.
  - hasDiagnostics
```
public boolean hasDiagnostics()
```
    Indicates whether the most recent invocation of the NasCoder API revealed defects in the NAS message.
    
    Returns:
    
    true when the most recent invocation of the NasCoder API reported some errors or warnings for the NAS message.
  - diagnostics
```
public Diagnostics diagnostics()
```
    Returns the diagnostic report created by the most recent invocation of the NasCoder API. If the operation aborted due to an exception, the diagnostics report returned is identical to the diagnostics reported by the diagnostics() method of the NASException. Even when the exception is not thrown the operation can return a non-empty report because the encoder or decoder detected non-critical defects that did not cause it to treat the message as invalid.
    
    Returns:
    
    the diagnostic report created by the most recent invocation of the NasCoder API.
  - setJSONOptions
```
public void setJSONOptions(JSONOptions options)
```
    Specifies the formatting options that are used when the NAS message is converted to JSON format.
    
    Parameters:
    
    options - specifies the new JSON formatting options.
  - getJSONOptions
```
public JSONOptions getJSONOptions()
```
    Retrieves the current formatting options that are used when the NAS message is converted to JSON format.
    
    Returns:
    
    the current formatting options that are used when the NAS message is converted to JSON format.
  - setXMLOptions
```
public void setXMLOptions(XMLOptions options)
```
    Specifies the formatting options that are used when the NAS message is converted to an XML document.
    
    Parameters:
    
    options - specifies the new XML formatting options.
  - getXMLOptions
```
public XMLOptions getXMLOptions()
```
    Retrieves the current formatting options that are used when the NAS message is converted to an XML document.
    
    Returns:
    
    the current formatting options that are used when the NAS message is converted to an XML document.
  - setTextOptions
```
public void setTextOptions(TextOptions options)
```
    Specifies the formatting options that are used when the NAS message is converted to ASN.1 value notation format.
    
    Parameters:
    
    options - specifies the new ASN.1 value notation formatting options.
  - getTextOptions
```
public TextOptions getTextOptions()
```
    Retrieves the current formatting options that are used when the NAS message is converted to ASN.1 value notation format.
    
    Returns:
    
    the current formatting options that are used when the NAS message is converted to ASN.1 value notation format.

Copyright © 2023 OSS Nokalva, Inc. All rights reserved.
This document is proprietary to OSS Nokalva, Inc., and may be used only by their direct licensees. Distribution is not permitted. This copyright statement must not be removed.

Class NasCoder<T extends AbstractData>

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

originator

Method Detail

decodeToJSON

decodeToXML

decodeToText

decode

encode

encode

printJSON

printXML

printMessage

hasDiagnostics

diagnostics

setJSONOptions

getJSONOptions

setXMLOptions

getXMLOptions

setTextOptions

getTextOptions