| Re: [osgi-dev] Agenda for today's specification call |
Dear Tim,
Please find my first batch of edits attached.
Sincerely,
James
Hi all,
Here is the agenda for today's call - apologies for putting it out late.
- Build and release process status update
- Typed Events 1.1 review process update
- OSGi Test status updates
- Feature Launcher TCK - progress update (Stefan)
- Web Services Whiteboard update (Christoph)
- RSA Issues
- AOB
I look forward to seeing you on the call, https://eclipse.zoom.us/j/82332136963?pwd=cmNe2NtWUYUJvP1XpHqFAk930jLFCI.1
All the best,
Tim Ward
_______________________________________________ osgi-dev mailing list osgi-dev@xxxxxxxxxxx To unsubscribe from this list, visit https://accounts.eclipse.org
;; This buffer is for text that is not saved, and for Lisp evaluation.
;; To create a file, visit it with ‘C-x C-f’ and enter text in its buffer.
157.1
line 3 Should be a . not a :, since each list element is a separate
sentence. either : .... ; ... ; ... . or ... . ... . ... . ... .
157.2.1
* The line "Type Safe Event classes are expected to either:" should
not have a colon, since there is not a full sentence before the colon.
No punctuation is necessary.
157.2.4.1
* You might want to reference copy-on-write semantics. Any nested DTO
need only be copied if it is also modified.
* If an Event Handler does need to make changes to an incoming event
then it must copy the event data into a new DTO instance.
This sentence needs a comma.
If an Event Handler does need to make changes to an incoming event,
then it must copy the event data into a new DTO instance.
* The following sentence is unclear.
Note that any nested DTO values in the event data must also be
copied if they are to be mutated.
Not the same goes for any nested values, in the event that a mutated
version is needed.
157.2.4.2
* In the following sentence, I opine that "make a copy" is meant.
The Typed Event Bus is not required to take a copy of this Map, and
therefore the event source must not change the Map, or any data
structures within the Map, after the call to deliverUntyped(String,Map).
I also suggest a sight change to the punctuation.
The Typed Event Bus is not required to make a copy of the Map;
therefore, the event source must not change the Map, or any data
structures within the Map, after the call to deliverUntyped(String,Map).
157.3.1
* The following sentence should end in a period, not a colon, since
there is not real continuation of the sentence, but rather a figure
with an example.
More precisely, the topic must conform to the following grammar:
* I think you mean enables here,
... preferred order allows a handler ...
* Despite how broken spell checkers work, a prefix should one be
followed by a hyphen, when two vowel would meet and it is an
uncommon use of the prefix, root work combination.
non-normative ==> nonnormative
157.3.4
* Because the topic for a TypedEventPublisher is defined at creation
time the implementation may only validate it once.
==>
Because the topic for a TypedEventPublisher is defined at creation
time, the implementation need only validate it once.
* Note that this means an Event Source must not share a
TypedEventPublisher outside its own bundle.
==>
Note, this means an Event Source must not share a
TypedEventPublisher outside its own bundle.
157.4.1
* A simple example of receiving a typed event follows:
==>
A simple example of receiving a typed event follows.
* By default the reified type of the TypedEventHandler will be used as
the target topic for the Event Handler.
==>
By default, the reified type of the TypedEventHandler will be used
as the target topic for the Event Handler.
* If the event.type property is set then this is used as the default
topic instead of the reified type.
==>
If the event.type property is set, then this is used as the default
topic instead of the reified type.
* To use a specific named topic the Typed Event Handler service may be
registered with an event.topics service property specifying the
topic(s) as a String+ value.
==>
To use a specific named topic, the Typed Event Handler service may be
registered with an event.topics service property specifying the
topic(s) as a String+ value.
157.4.1
* When delivering an event to an Untyped Event Handler the Typed Event
Service must, if necessary, convert the event data to a nested map
structure.
==>
When delivering an event to an Untyped Event Handler, the Typed Event
Service must, when necessary, convert the event data to a nested map
structure.
157.4.3.1
* The following sentence is unclear.
Using a single-level wildcard means that the Event Handler must be
called Events sent to topics matching the rest of the topic String.
Do you mean the following?
Using a single-level wildcard means the Event Handler must be called
on Events sent to topics matching the rest of the topic String.
* For example the component: .... would receive events sent to the
topics foo/bar/foobar and foo/baz/foobar, but not the topics
foo/foobar or foo/bar/foobar/baz.
==>
In the following example, the component would receive events sent to
the topics foo/bar/foobar and foo/baz/foobar, but not the topics
foo/foobar or foo/bar/foobar/baz.
...
157.4.3.2
* Multi-Level ==> Multilevel (in all text, see prefixes above)
* For example the component: ... would receive events sent to the
topics foo/bar and foo/baz, but not the topics foo or foobar/fizzbuzz.
==>
In the following example, the component would receive events sent to the
topics foo/bar and foo/baz, but not the topics foo or foobar/fizzbuzz.
...
157.4.4
* If any services are found then the Typed Event implementation will
call the notifyUnhandled method passing the topic name and event
data to all of the registered Unhandled Event Handler services.
==>
If any services are found, then the Typed Event implementation will
call the notifyUnhandled method passing the topic name and event
data to all of the registered Unhandled Event Handler services.
157.4.5
* In these cases the consumer can further restrict the events that
they receive by using a filter.
==>
In these cases, the consumer can further restrict the events that
they receive by using a filter.
157.4.5.1
* As LDAP filtering is only designed to match against simple data this
means that some event properties cannot be filtered using the event.
==>
As LDAP filtering is only designed to match against simple data,
some event properties cannot be filtered using the event.
157.4.5.2
* Note that the use of a filter is different from receiving an event and
choosing to ignore it based on its data.
==>
Note, the use of a filter is different from receiving an event and
choosing to ignore it based on its data.
* If an event fails to match the filter supplied by an event handler
service then it is not delivered to that event handler.
==>
If an event fails to match the filter supplied by an event handler
service, it is not delivered to that event handler.
* This means that the event data remains eligible to be sent to an
UnhandledEventHandler unless another event handler does receive it.
==>
This means the event data remains eligible to be sent to an
UnhandledEventHandler, unless another event handler receive it.
157.4.6
* Event Handler implementations are called by the Typed Event Bus
implementation, and are expected:
* Not to throw exceptions from their callback method
* To return quickly - any long running tasks should be moved to
another thread
==>
Event Handler implementations are called by the Typed Event Bus
implementation, and are expected to
* not throw exceptions from their callback method, and
* return quickly.
Any long running tasks should be moved to another thread.
* In general, statements of the form
if .... then ...
should contain a comma and then is not necessary
if ... , ...
The 'then' is superfluous.
This pertains to most of the rest of the section.