Deserialization engine limiting which types can be deserialized

Introduced properties

fun accept(dynamic_type: Text, static_type: nullable Text): Bool

serialization :: SafeDeserializer :: accept

Should self accept to deserialize an instance of dynamic_type for an attribute wuth static_type?
fun check_subtypes: Bool

serialization :: SafeDeserializer :: check_subtypes

Should objects be checked if they a subtype of the static type before deserialization?
fun check_subtypes=(check_subtypes: Bool)

serialization :: SafeDeserializer :: check_subtypes=

Should objects be checked if they a subtype of the static type before deserialization?
fun whitelist: Array[Text]

serialization :: SafeDeserializer :: whitelist

Accepted parameterized classes to deserialize
protected fun whitelist=(whitelist: Array[Text])

serialization :: SafeDeserializer :: whitelist=

Accepted parameterized classes to deserialize

Redefined properties

redef type SELF: SafeDeserializer

serialization $ SafeDeserializer :: SELF

Type of this instance, automatically specialized in every class

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun accept(dynamic_type: Text, static_type: nullable Text): Bool

serialization :: SafeDeserializer :: accept

Should self accept to deserialize an instance of dynamic_type for an attribute wuth static_type?
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
fun check_subtypes: Bool

serialization :: SafeDeserializer :: check_subtypes

Should objects be checked if they a subtype of the static type before deserialization?
fun check_subtypes=(check_subtypes: Bool)

serialization :: SafeDeserializer :: check_subtypes=

Should objects be checked if they a subtype of the static type before deserialization?
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
abstract fun deserialize(static_type: nullable String): nullable Object

serialization :: Deserializer :: deserialize

Deserialize and return an object, storing errors in the attribute errors
abstract fun deserialize_attribute(name: String, static_type: nullable String): nullable Object

serialization :: Deserializer :: deserialize_attribute

Deserialize the attribute with name from the object open for deserialization
fun deserialize_attribute_missing: Bool

serialization :: Deserializer :: deserialize_attribute_missing

Was the attribute queried by the last call to deserialize_attribute missing?
protected fun deserialize_attribute_missing=(deserialize_attribute_missing: Bool)

serialization :: Deserializer :: deserialize_attribute_missing=

Was the attribute queried by the last call to deserialize_attribute missing?
protected fun deserialize_class(class_name: Text): nullable Object

serialization :: Deserializer :: deserialize_class

Deserialize the next available object as an instance of class_name
protected fun deserialize_class_intern(class_name: Text): nullable Object

serialization :: Deserializer :: deserialize_class_intern

Generated service to deserialize the next available object as an instance of class_name
fun errors: Array[Error]

serialization :: Deserializer :: errors

Errors encountered in the last call to deserialize
protected fun errors=(errors: Array[Error])

serialization :: Deserializer :: errors=

Errors encountered in the last call to deserialize
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun keep_going: nullable Bool

serialization :: Deserializer :: keep_going

Should self keep trying to deserialize an object after an error?
fun keep_going=(keep_going: nullable Bool)

serialization :: Deserializer :: keep_going=

Should self keep trying to deserialize an object after an error?
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
abstract fun notify_of_creation(new_object: Object)

serialization :: Deserializer :: notify_of_creation

Register a newly allocated object (even if not completely built)
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun whitelist: Array[Text]

serialization :: SafeDeserializer :: whitelist

Accepted parameterized classes to deserialize
protected fun whitelist=(whitelist: Array[Text])

serialization :: SafeDeserializer :: whitelist=

Accepted parameterized classes to deserialize
package_diagram serialization::SafeDeserializer SafeDeserializer serialization::Deserializer Deserializer serialization::SafeDeserializer->serialization::Deserializer serialization::Serializable Serializable serialization::Deserializer->serialization::Serializable ...serialization::Serializable ... ...serialization::Serializable->serialization::Serializable json::JsonDeserializer JsonDeserializer json::JsonDeserializer->serialization::SafeDeserializer msgpack::MsgPackDeserializer MsgPackDeserializer msgpack::MsgPackDeserializer->serialization::SafeDeserializer github::GithubDeserializer GithubDeserializer github::GithubDeserializer->json::JsonDeserializer github::GithubDeserializer... ... github::GithubDeserializer...->github::GithubDeserializer

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Parents

abstract class Deserializer

serialization :: Deserializer

Abstract deserialization service

Children

class JsonDeserializer

json :: JsonDeserializer

Deserializer from a Json string.
class MsgPackDeserializer

msgpack :: MsgPackDeserializer

Deserialize MessagePack format to full Nit objects

Descendants

class GithubDeserializer

github :: GithubDeserializer

JsonDeserializer specific for Github objects.

Class definitions

serialization $ SafeDeserializer
# Deserialization engine limiting which types can be deserialized
class SafeDeserializer
	super Deserializer

	# Accepted parameterized classes to deserialize
	#
	# If `whitelist.empty`, all types are accepted.
	#
	# ~~~
	# import json
	#
	# class MyClass
	#     serialize
	# end
	#
	# var json_string = """
	# {"__class": "MyClass"}
	# """
	#
	# var deserializer = new JsonDeserializer(json_string)
	# var obj = deserializer.deserialize
	# assert deserializer.errors.is_empty
	# assert obj isa MyClass
	#
	# deserializer = new JsonDeserializer(json_string)
	# deserializer.whitelist.add "Array[String]"
	# deserializer.whitelist.add "AnotherAcceptedClass"
	# obj = deserializer.deserialize
	# assert deserializer.errors.length == 1
	# assert obj == null
	# ~~~
	var whitelist = new Array[Text]

	# Should objects be checked if they a subtype of the static type before deserialization?
	#
	# Defaults to `true`, as it should always be activated.
	# It can be turned off to implement the subtype check itself.
	var check_subtypes = true is writable

	# Should `self` accept to deserialize an instance of `dynamic_type` for an attribute wuth `static_type`?
	#
	# Uses `whitelist` if not empty...
	# Check correct inheritance if `check_subtypes`...
	fun accept(dynamic_type: Text, static_type: nullable Text): Bool
	do
		if whitelist.not_empty and not whitelist.has(dynamic_type) then
			errors.add new Error("Deserialization Error: '{dynamic_type}' not in whitelist")
			return false
		end

		if static_type != null and check_subtypes then
			var static_class = static_type.strip_nullable_and_params.to_s
			var dynamic_class = dynamic_type.strip_nullable_and_params.to_s
			if not class_inheritance_metamodel.has_edge(dynamic_class, static_class) then
				errors.add new Error("Deserialization Error: `{dynamic_type}` is not a subtype of the static type `{static_type}`")
				return false
			end
		end

		return true
	end
end
lib/serialization/safe.nit:23,1--84,3