Hemi.data.ioHemi JavaScript FrameworkHemi JavaScript Framework Project/Hemi/Hemi.data.ioHemiThe Data IO service is used to broker data requests with configured data providers. The built-in interchange format is loosely modelled on the Account Manager 4 Data and Group object model, but the implementation is open for any object type.DataIOProviderThis static class describes the interface an object must expose to provide data via the Data IO Service. A provider must be registered with the ObjectRegistry. The addServiceAPI method may be used to instrument this API for quick access to the service.handle_io_registerThe service that registered the provider.A notification that the provider was registered with the service.handle_io_unregisterThe service that is unregistering the provider.A notification that the provider is being unregistered.handle_io_open_requestThe service that is unregistering the provider.Subject of the requestor (E.G.: The authenticated user, anonymous user, etc).The request that is being opened.The response to the request.A notification that a request has been opened.handle_io_requestThe service that is unregistering the provider.Subject of the requestor (E.G.: The authenticated user, anonymous user, etc).The request that is being opened.The response to the request.Bit indicating that the request response was completed.A notification that a request should be processed.requestTypeActionThe Data IO service raising the request.Subject of the requestor (E.G.: The authenticated user, anonymous user, etc).Parameters and filters of the request.Data, status, and policies of the response.Bit indicating the request was handled.The virtual method is invoked based on the combination of the implements method.implementThe context of the implementation.The action of the implementation.Registers a specific implementation. The order of the invocation is: requestCatalog{Action}, requestAction{Action}. This method is injected onto a provider after registration.handle_proxy_xmlThe URI to an XML/Text/JSON Resource decorated with the proxy protocol.Identifier associated with the request.Bit indicating wether the request should be made via HTTP POST.Data to be included as the POST payload, such as an XMLDocument, text, or JSON structure.Bit indicating whether the response should be cached.Int indicating whether the request and response as text (1) or JSON (2) instead of XML (0).The bus type the proxy service is currently operating in.Returns a Data IO Request based on the supplied input.When registered as a protocol proxy, matching URI requests made from the context of the registered bus are diverted to this provider. The provider implements the handle_proxy_xml method to compose a Data IO Request based on the URI pattern. NOTE: Only one provider may register for a particular protocol, regardless of bus type.3.1.9service3.1.9Static implementation of the hemi.app.module.serviceImpl class.serviceImpl3.1.9The Data IO service provides a bus to registered Data Providers. IORequest and IOSubject objects are used to convey a description of the request to the providers. Each provider may then determine whether and when to handled the request, and return results as an IOResponse.getBusNameBus typeThe name of the specified of bus type.Returns the name of the specified bus type.getBusTypeThe enumeration of bus types.Returns the enumeration of bus types.getListThe request bus.The application to handle the request.The context of the request.The group catalog. Reserved values are: directory, dataThe request, or description, of the catalog. Reserved values are: list, listFull.Bit indicating whether the request should be made asynchronously.Function pointer to be invoked with the service and response.The response object created for the request.Opens a catalog request, where the requestName is 'catalog', Invoked by the instrumented deconstructor mapSessionThe Session Component used by CoreWeb.Maps the Core Session component data to the DataIO subject.updateSubjectNotifies subscribers to onupdatesubject message that the subject was updated.onupdatesubjectThe service for which the subject was updated.Message published to all subscribers when the default subject for the service has been updated.handle_io_responseThe service that is unregistering the provider.Subject of the requestor (E.G.: The authenticated user, anonymous user, etc).The request that is being opened.The response to the request.A notification that a response was created for a pending request.GroupAn object representing a group.Bit indicating whether child data and groups has been populated.The provider of the group.The group parent id.Name of the group.Path of the group.Type of the group.Unique identifier.Namespace. This may be used to distinguish where the data originates and/or where and how it should be persisted.List of data contained by the group.List of groups contained by the group.Bit indicating whether the group pointers (such as children) are populated.The bus via which the group was transferred. Bus is a discriminator used to direct the flow of the request to a subject of IO Providers.IOSubjectAn object representing the subject of a request. This object is determined and set by the framework context.Name of the subject (eg: user name).UID of the subject (eg: user id).Bit indicating whether or not the subject is known to be authenticated.getSubjectThe current IOSubject.Returns the current IOSubject. This is assumed to be updated by any session handling mechanism (E.G.: Refer component.session.xml for implementation when used with Core Web 4 project).arrayToGroupAn array of group namesDefault group policy.Parent path to the group.An array of group objects.Returns an array of group objects.newGroupA new group object.Returns a new group object.arrayToDataAn array of dataDefault data policy.An array of data objects.Returns an array of data objects.DataAn object representing variable data.The provider of the data.The path to the data.Value of the data.Hash of the data value.Name of the data.Type of the data value.Content type of the data value.Unique identifier.Date/time when the data was created.Date/time when the data was last modified.Size of the dataBit indicating whether the data value is included. For data lists, this is usually false.Bit indicating whether the data value represents a post payload.Group identifier. This may be used to differentiate the data relative to other data, such as a directory.Description of the data.Namespace. This may be used to distinguish where the data originates and/or where and how it should be persisted.The bus via which the data was transferred. Bus is a discriminator used to direct the flow of the request to a subject of IO Providers.newDataA new data object.Returns a new data object.PolicyAuthorization policy affecting a particular object.The id of the object that the policy affects.The type of subject.A plain text statement of the policy.Bit indicating whether the subjecrt is able to read the object.Bit indicating whether the subjecrt is able to write (or add-to) the object.Bit indicating whether the subjecrt is able to change the object.Bit indicating whether the subjecrt is able to delete the object.newPolicyA new policy object.Returns a new policy object.IOInstructionInstructions relevent to the request.Bit indicating whether multiple results should be paginate by the recordCount property.For paginated sets of data, the number of records requested for the set.For paginated sets of data, the start index of the returned set of data from the total set.For paginated sets of data, the total set of available data.Bit indicating the data set is paginated.Instruction on how the response should be ordered.Instruction on how the response should be grouped.newIOInstructionA new set of request instructions.Returns a new request object.The requested results should be paginated.For paginated results, the record to begin with.For paginated results, the maximum number of records to return.Record order instruction.Record group instruction.IOResponseAn object representing the response to a request.One or more providers indicated invalid authentication.UID to track this IOResponse.UID of the response (eg: data_id).Path of the response.Response status.Response messages, if any.The id of the IORequest submitted and instigating this response. (IORequest.id property, not IORequest.requestId).The registered identifier of the service for which the response was created.List of data accompanying the response.Namespace. This may be used to distinguish where the data originates and/or where and how it should be persisted.Bus is a discriminator used to direct the flow of the request to a subject of IO Providers.Hash of providers which responded.Handler to be invoked for asynchronous requests.writeDataA data object.The service providing the data.The parent group array.The bus via which the data was provided.Adds the specified data object to the response.writeDataArrayAn array of data objects.The service providing the data.The parent data array.The bus via which the data was provided.Adds the specified data objects to the response.writeGroupA group object.The service providing the group.The parent group array.The bus via which the group was provided.Adds the specified group object to the response.writeGroupArrayAn array of group objects.The service providing the group.The parent group array.The bus via which the group was provided.Adds the specified group objects to the response.newIOResponseThe request object for which to create the response.Function pointer to be invoked with the service and response for asynchronous requests.A new response object.Returns a new response object.IORequestAn object representing the subject of a request. This object is determined and set by the framework context. The parameters are modeled after the Core Web and Account ManagerCore Handler request processor.The name of a preferred application to handle the requested action.The requested action (eg: get, put, delete).The request may be made asynchronously, and the results returned via a handler callback.The request results may be cached.Name of the request (eg: data name).UID of the request being made (eg: data id).The catalog (or group) of the request being made (eg: Home group). This may be used to differentiate the data relative to other data, such as a directory.UID to track this IORequest.Bit indicating whether returned data should include all information, or only meta information.Context is used to distinguish where the data request originated, and where it may be delivered.Namespace. This may be used to distinguish where the data originates and/or where and how it should be persisted.Bus is a discriminator used to direct the flow of the request to a subject of IO Providers.List of data accompanying the request.The registered identifier of the service for which the request was created.Hash of provider identifiers to which the request was submitted.The transaction packet identifier.The transaction packet name.The id of the IOResponse created for this request. (IOResponse.id property, not IOResponse.responseId).Bit indicating that the request is still being processed.A set of instructions for how a request for two or more records should be handled.Expected content type of the response.newIORequestThe request bus.The request application.The context of the request.The name of the request catalog.The requested action.The requested id.The name of the request.The request is for meta information.The request is asynchronous.The request may be cached.A set of instructions for how a request for two or more records should be handled.A new request object.Returns a new request object.createRequestThe subject making the request.The request bus.The request application.The context of the request.The name of the request catalog.The requested action.The requested id.The name of the request.The request is for meta information.The request is asynchronous.The request may be cached.A set of instructions for how a request for two or more records should be handled.Function pointer to be invoked with the service and response.A request object.Constructs a request object from the specified parameters, opens a new request transaction, and returns a new request object, registered with the io service, prepared with a response, and ready for use.openRequestThe subject making the request.A request object.Function pointer to be invoked with the service and response.A request object.Opens a new request transaction, and returns a new request object, registered with the io service, prepared with a response, and ready for use. if(!rq.instruction) rq.instruction = t.newIOInstruction(); Join the providers on the specified bus to this transaction TODO: 2010/07/09 - the array should be compacted on prior removal So this check should be unnecessary this.log(w.bus + ":" + b + "==" + (w.bus == bt.ANY || w.bus == b)); if provider bus is any or provider bus is the same as the request or the request is to any bus alert("Count at add: " + t.getPacket(u).participant_count + " / Check = " + t.getPacket(u)[v.object_id]); this.log('Open Request: ' + v.object_id + " : " + u + " (" + !t.getPacket(u)[v.object_id] + ")"); Now, serve the transaction If the request is synchronous, then the packet must be finalized here Or, it's an error, and any delinquent providers must be forcefully closed endRequestThe transaction service handling the request.The packet representing the transaction.Specified for, and invoked as, the transaction packet handler for transactions opened for requests. r.transactionName = 0; r.transactionId = 0; continueRequestRequest object or request identifier.The provider object instigating the request to continue processing.Bit indicating that the provider completed processing the request and that the underlying transaction may be marked as complete.For asynchronous requests, continues processing the request transaction. The instance invoking this method may indicate that it completed processing its portion of the request, and therefore it should not receive a subsequent transaction processing callback. if the packet is finalized, or the provider is not a participant, or the provider is already completed then return. t.log("Start Transaction"); t.log("End Transaction"); alert('close'); t.log("Do Transaction"); registerHemi FrameworkObject that supports the Provider API.The type of bus the provider will use. Fixed types are: local, offline, online, any.A friendly name for refering to the provider.A custom protocol for directing URI requests through the provider.Bit indicating whether the provider was registered.Registers a Data IO Provider. Object must be registered HemiEngine.object.addObjectAccessor(p, "apiRegister"); MethodType = catalog, request, or action Action = Action name requestCatalog**** requestAction**** v.log(p.data.requestId + " -> " + p.data.responseId); v.log(p.data.requestId + " -> " + p.data.responseId + " = " + o); v.log("End transaction"); isRegisteredHemi FrameworkObject.Bit indicating whether the provider is registered.Determines whether an object is registered as a provider.unregisterHemi FrameworkObject that supports the Provider API.Bit indicating the provider is an internal marker.Bit indicating whether the provider was unregistered.Unregisteres a provider from the Data IO service. Notify provider to cleanup any pending requests Remove the provider from all data io transaction packets Serve the transaction again Otherwise, the request will be stuck open t.log("Cleanup: " + o.object_id + " > " + q.transactionName + " = " + b); The Data IO service is used to broker data requests with configured data providers. The built-in interchange format is loosely modelled on the Account Manager 4 Data and Group object model, but the implementation is open for any object type.Hemi_api.htmlAPI Index