| afnix-us-tcz(3) | Library Functions Manual | afnix-us-tcz(3) |
NAME¶
afnix-us-tcz - standard transmutable contant zone service
STANDARD TRANSMUTE CONTENT ZONE SERVICE¶
The Standard Transmute Content Zone Management service is an original implementation of various objects dedicated to the elaboration of transmutable objects in the form of blob and mixture.
General concepts
The afnix-tcz provides the support for manipulating transmutable object in an
ecclectic form. There are multiple types of objects which can broadly be
categorized into general data blob, identity and credential associated with
zone that contain them
Blob
The concept of blob is central in the tcz service. A blob is a registrable
part. A part is an abstract taggable object uniquely identified by a uuid.
The blob adds a registration identification, which enables them to be group
into domains.
STANDARD TRANSMUTABLE CONTENT ZONE REFERENCE¶
Part
The Part class is a taggable object which is bound by a unique key and provide
a plist interface access. The part object is the foundation of the blob
object and is also used to feed a collection. The key is represented by a
uuid object.
Predicate
Inheritance
Constructors
The Part constructor creates an empty part
The Part constructor creates a part by name.
The Part constructor creates a part by name and info strings.
Methods
The kip-p predicate returns true if the part kid can be validated.
The property-p predicate returns true if the property name argument is defined in the part.
The get-kid method returns the part kid.
The add method adds a property to the part.
The get-header method returns the part header which is a plist with the part name, info and uuid.
The get-plist method returns the part plist.
The get-value method returns the a part property value by name.
The toliteral method returns the a part property literal by name.
Blob
The Blob class is a base class that models the behavior of a registered blob
through the use of a registration id. 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 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 that it has
a name, info and unique key.
Predicate
Inheritance
Constructors
The Blob constructor creates an empty blob.
The Blob constructor creates a blob by name.
The Blob constructor creates a blob by name and info strings.
The Blob constructor creates a blob by rid, name and info strings.
Methods
The rid-p predicate returns true if the blob registration id is set.
The set-rid method sets the blob rid.
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.
Predicate
Inheritance
Constructors
The Bloc constructor creates an empty bloc.
The Bloc constructor creates a bloc by name.
The Bloc constructor creates a bloc by name and info strings.
The Bloc constructor creates a bloc by rid, name and info strings.
Methods
The add-credential method add a credential to the bloc.
The get-credential method returns a credential object by name.
Carrier
The Carrier class is a blob used to transport an object. The object
transported by the carrier must be serializable.
Predicate
Inheritance
Constructors
The Carrier constructor creates an empty carrier.
The Carrier constructor creates a carrier with an object.
The Carrier constructor creates a carrier with an object by name.
The Carrier constructor creates a carrier with an object by name and info strings.
The Carrier constructor creates a carrier with an object by rid, name and info strings.
Methods
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.
Predicate
Inheritance
Constructors
The Delegate constructor creates an empty delegate.
The Delegate constructor creates a delegate with an object.
The Delegate constructor creates a delegate with an object by name.
The Delegate constructor creates a delegate with an object by name and info strings.
The Delegate constructor creates a delegate with an object by rid, name and info strings.
The Delegate constructor creates a delegate with an object by rid, name, info strings and delegation address.
Methods
The set-address method sets the delegate address.
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.
Predicate
Inheritance
Methods
The exists-p predicate checks if an authority exists by kid.
The valid-p predicate validates an authority by name and credential.
The get-info-p method the real information string. Note that the get-name method is also available through the Nameable interface.
The create method creates an authority by name and credential.
The update method updates a workzone by authority.
| AFNIX | AFNIX Service |