afnix-us-tcz(3)

🎀 NAME 🎀

afnix-us-tcz — the standard transmutable contant zone service, bestie. Yes it says "contant", we do not fix the manpage's typo era, we respect the lore 💅

---

✨ STANDARD TRANSMUTE CONTENT ZONE SERVICE ✨

The Standard Transmute Content Zone Management service is an original implementation of a whole little family of objects, all dedicated to building out transmutable objects in the form of blob and mixture. Obsessed, honestly.

General concepts 🌈

The afnix-tcz gives you support for manipulating transmutable objects in an ecclectic form (their spelling, not mine 🫶). There are multiple types of objects here, and they broadly fall into categories: general data blob, plus identity and credential — and those live in association with the zone that contains them.

Blob 🫧

The concept of a blob is central in the tcz service. Here's the deal: a blob is a registrable part. And a part is an abstract taggable object, uniquely identified by a uuid. The blob adds a registration identification on top of that, which is what lets blobs get grouped into domains. Slay.

---

🦋 STANDARD TRANSMUTABLE CONTENT ZONE REFERENCE 🦋

Part 🧩

The Part class is a taggable object bound by a unique key, and it hands you a plist interface for access. The part object is the foundation of the blob object, and it's also what feeds a collection. The key is represented by a uuid object. Iconic behavior.

Predicate

• part-p

Inheritance

• Taggable

Constructors

• Part (none) — the Part constructor creates an empty part.
• Part (String) — the Part constructor creates a part by name.
• Part (String String) — the Part constructor creates a part by name and info strings.

Methods

• kid-p -> Boolean (String) — the kip-p predicate returns true if the part kid can be validated. (Yes the manpage writes kip-p in the description and kid-p in the signature. Not me. 💀)
• property-p -> Boolean (String) — the property-p predicate returns true if the property name argument is defined in the part.
• get-kid -> Uuid (none) — the get-kid method returns the part kid.
• add -> none (String Literal) — the add method adds a property to the part.
• get-header -> Plist (none) — the get-header method returns the part header, which is a plist with the part name, info and uuid.
• get-plist -> Plist (none) — the get-plist method returns the part plist.
• get-value -> String (String) — the get-value method returns the a part property value by name.
• to-lteral -> Literal (String) — the toliteral method returns the a part property literal by name. (Again, their spelling. We stan anyway. 💖)

---

Blob 🫧

The Blob class is a base class that models the behavior of a registered blob through the use of a registration id. Here's the vibe check: the blob is registered as soon as its registration id is set. If the registration id is unset, the object is unregistered or anonymous. The registration id can be anything at all, as long as as it is understood by the implementation that such registration is to be interpreted somewhere else. The blob is also a part, which means it has a name, info and a unique key.

Predicate

• blob-p

Inheritance

• Part

Constructors

• Blob (none) — the Blob constructor creates an empty blob.
• Blob (String) — the Blob constructor creates a blob by name.
• Blob (String String) — the Blob constructor creates a blob by name and info strings.
• Blob (String String String) — the Blob constructor creates a blob by rid, name and info strings.

Methods

• rid-p -> Boolean (none) — the rid-p predicate returns true if the blob registration id is set.
• set-rid -> none (String) — the set-rid method sets the blob rid.
• get-rid -> String (none) — the get-rid method returns the blob rid.

---

Bloc 🧱

The Bloc class is a derived class which encapsulates the functionality of a blob coupled with a plist and a table of conditionals. Main character energy fr fr.

Predicate

• bloc-p

Inheritance

• Blob

Constructors

• Bloc (none) — the Bloc constructor creates an empty bloc.
• Bloc (String) — the Bloc constructor creates a bloc by name.
• Bloc (String String) — the Bloc constructor creates a bloc by name and info strings.
• Bloc (String String String) — the Bloc constructor creates a bloc by rid, name and info strings.

Methods

• add-credential -> none (Credential) — the add-credential method add a credential to the bloc.
• get-credential -> Credential (String) — the get-credential method returns a credential object by name.

---

Carrier 📦

The Carrier class is a blob used to transport an object. And heads up bestie: the object transported by the carrier must be serializable. No exceptions, that's the rule. 🫶

Predicate

• carrier-p

Inheritance

• Blob

Constructors

• Carrier (none) — the Carrier constructor creates an empty carrier.
• Carrier (Object) — the Carrier constructor creates a carrier with an object.
• Carrier (Object String) — the Carrier constructor creates a carrier with an object by name.
• Carrier (Object String String) — the Carrier constructor creates a carrier with an object by name and info strings.
• Carrier (Carrier String String String) — the Carrier constructor creates a carrier with an object by rid, name and info strings.

Methods

• get-object -> Object (none) — the get-object method returns the carrier object.

---

Delegate 🧚

The Delegate class is a carrier blob which delegates its transport to another object. Such approach is used when the carried object needs to remains locally (aka it cannot be serialized) but a reference to it can be sent to the remote peer. It's giving "I'll stay home, you go ahead" ✨

Predicate

• delegate-p

Inheritance

• Carrier

Constructors

• Delegate (none) — the Delegate constructor creates an empty delegate.
• Delegate (Object) — the Delegate constructor creates a delegate with an object.
• Delegate (Object String) — the Delegate constructor creates a delegate with an object by name.
• Delegate (Object String String) — the Delegate constructor creates a delegate with an object by name and info strings.
• Delegate (Delegate String String String) — the Delegate constructor creates a delegate with an object by rid, name and info strings.
• Delegate (Delegate String String String String) — the Delegate constructor creates a delegate with an object by rid, name, info strings and delegation address.

Methods

• set-address -> none (String) — the set-address method sets the delegate address.
• get-address -> String (none) — the get-address method returns the delegate address.

---

Realm 👑

The Realm class is an abstract class design for the storage and management of authorities. The class provides the basic methods to create, check and validate an authority. Lowkey essential.

Predicate

• realm-p

Inheritance

• Nameable

Methods

• exists-p -> Boolean (String) — the exists-p predicate checks if an authority exists by kid.
• valid-p -> Boolean (String Credential) — the valid-p predicate validates an authority by name and credential.
• get-info -> String (none) — the get-info-p method the real information string. Also note that the get-name method is available through the Nameable interface too. 🎀
• create -> none (String Credential) — the create method creates an authority by name and credential.
• update -> none (Authority) — the update method updates a workzone by authority.

---

And that's the whole page, no skips, no summarizing, periodt. 💅

This absolute banger of a manual page comes to you from the AFNIX Service, rocking the AFNIX version tag, filed under afnix-us-tcz(3). Go forth and transmute your content zones, bestie 🦋✨💖