This specification is currently a draft under development. |
Subscription Event Protocol
The CloudOS Subscription Event Protocol provides an event based model for managing subscriptions between Personal Clouds. The current implementation of the protocol will create a symmetric relationship between both Personal Clouds. In addition, the target Personal Cloud will automatically create (approve) the subscription request from the originating Personal Cloud. In other words there is no user approval required. Optional user approval is the next major feature that will be added to the Subscription Event Protocol specification. In order to used the Subscription Event Protocol the CloudOS ruleset must be installed in the Personal Cloud for both the originating and target.
Subscribe
The system:subscribe event is used to create a Personal Channel between two Personal Clouds.
- domain: system
- type: subscribe
- attributes:
- channelName
- namespace
- relationship
- targetChannel
- The channelName attribute is a label associated with the subscription that should convey meaning to developer. The channelName is only used as a component in the creation of the channel token. If no channelName is specified the value of "orphan" will be used.
- The namespace attribute is provided as a means for the developer to group subscriptions within a single, or group, or applications. The namespace is used to filter the list of subscriptions returned by the subscriptionList() function. If not namespace is specified the value of "shared" will be used.
- The relationship attribute is provided as a means for the developer to characterize the relationship between the originating and target Personal Cloud. The relationship attribute should be specified as a pair of values separated by a dash (e.g. parent-child, peer-peer, master-slave). The first value of the relationship attribute will be stored with the originating Personal Cloud subscription, the second value will be stored with the target Personal Cloud subscription. The relationship attribute values are used to filter the list of subscriptions returned by the subscriptionList() function. If not relationship is specified the value of "peer-peer" will be used.
- The targetChannel attribute is the Personal Channel token for the target Personal Cloud to which the subscription is to be made.
During the processing of creating the Personal Channels between the two Personal Clouds callback events are raised within each respective Personal Cloud. These events are raised to enable the developer to take additional actions when the Personal Channels are actually created.
- domain: explicit
- type: CloudOS_subscriptionAdded
- attributes: eventChannel, backChannel
The eventChannel attribute is the Personal Channel token for the remote Personal Cloud, while the backChannel is the Personal Channel token for the current Personal Cloud.
Unsubscribe
The system:unsubscribe event is used to remove the Personal Channels between two Personal Clouds.
- domain: system
- type: unsubscribe
- attribute: backChannel
The backChannel attribute uniquely identifies the Personal Channel within the Personal Cloud, and provided to the target Personal Cloud for raising events into the current Personal Cloud. The backChannel is one of the attributes provided by the subscriptionList() function.
During the processing of removing the Personal Channels bewteen the two Personal Clouds callback events are raised within each respective Personal Cloud. These events are raised to enable the developer to take additional actions when the Personal Channels are actually being removed.
- domain: explicit
- type: CloudOS_subscriptionRemoved
- attributes: eventChannel, backChannel
The eventChannel attribute is the Personal Channel token for the remote Personal Cloud, while the backChannel is the Personal Channel token for the current Personal Cloud
Subscription List
subscriptionList(namespace, relationship)