http://www.sbbi.net/jafs/1.0/jbi-service Schema documentation

Definition > Declared Namespaces > Top-level element(s) > List of elements > List of simple types > Element declarations > Simple types declarations

Definition

This grammar is used for the JAFS events registration/reception/unregistration on the JBI NMR bus.

Declared Namespaces

Prefix	Namespace
Default namespace	http://www.sbbi.net/jafs/1.0/jbi-service
xml	http://www.w3.org/XML/1998/namespace
js	http://www.sbbi.net/jafs/1.0/jafs-service
xsd	http://www.w3.org/2001/XMLSchema

Top-level element(s)

event
registration-request
registration-response
unregistration-request

List of elements

event, event-field, filter, registration-request, registration-response, unregistration-request

List of simple types

EventName, EventType

Element declarations

registration-request

Description	Registration request for events notification, the MessageExchange object used for this operation MUST contains a property named net.sbbi.jafs.services.jbi.client.endpoint with the client ServiceEndpoint object as value. This endpoint will be used to dispatch the event messages via the NMR bus.

Content	Sequence : filter, js:server-event, js:services-event, js:session-event

Used inside

registration-response

Description

Registration request response, returned by jafs after a registration-request message sending.

Content

Empty

Attributes

type: xsd:integer
required attribute

The registration id, must be keept to when an unregistration message needs to be sent.

Used inside

filter

Description

Filter setting, this can be used to filter events on certai criteria (client session ip address,server path...)

Content

xsd:string

Attributes

name

type: xsd:string
required attribute

the filter setting name

Used inside

registration-request

unregistration-request

Description

Unregistration request, send this message ot stop to receive events messages

Content

Empty

Attributes

type: xsd:integer
required attribute

The registration id returned during the registration process

Used inside

event

Description

Event notification, this message is sent asynchronously as soon as a registred event is occuring on the server

Content

Sequence : event-field*

Attributes

name	type: EventName required attribute	The event name (onConnect,onDisconnect...)
type	type: EventType required attribute	The event type (session,server,service)
time-stamp	type: xsd:long required attribute	The event timestamp (the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.)
reg-id	type: xsd:integer required attribute	The registration id bound to this event notification, this information is provided for endpoints who have made multiple events registrations.

Used inside

event-field

Description

Events field, the field contains some precious informations about the event (such as a file path for an session onFileUploadFinished event)

Content

xsd:string

Attributes

name

type: xsd:string
required attribute

The event field name

Used inside

event

Simple types declarations

EventType

Description	No type description provided

Base type	xsd:string
Possible values	session \| server \| service

EventName

Description	No type description provided

Base type