Editing a Data Service with Introduce

Data services may be edited via the Introduce toolkit in conjunction with the data services extension. When a data service is created or opened with Introduce, the data service extension adds a tab to the main service modification window titled "Data Service." This tab has a number of sub-tabs which control or display various aspects of the data service.

Domain Model Tab

The first tab shown is the Domain Model tab. This tab allows the service developer to control aspects of the service's exposed data model.

Data Service Domain Model Tab

This tab allows the service developer to select the project and packages from the caDSR which the data service should expose. Individual classes may be added or removed from the model by using the tree of packages and classes and checking the box next to classes to be included at the bottom. The "Visualize Domain Model" button shows a graphical representation of the current domain model, including classes, their attributes, and associations. The "Advanced Options" button gives the service developer access to options for no domain model and a model from the local file system. In the case either of these options is selected, the class selection tree on the Domain Model tab is disabled.

Query Processor Tab

The next tab is the Query Processor tab. This tab allows the service developer to set the query processor class which will be used to handle CQL against the service's backend data store, as well as configure the query processor's parameters.

Data Service Query Processor Tab

The selected class dropdown menu shows all classes found in the jars list which extend from the base abstract CQL query processor class. To add a new class to this list, it must appear in a jar file listed in the Additional Jars list. Jars can be added by using the Add Jar button and browsing to the jar file on your local file system. This will copy the jar into your service. The Remove Jars button removes the selected jars from the list.

The Launch Query Processor Configurator button will launch a special dialog for configuring the selected query processor, if it supplies one. If it does not, a message will be displayed indicating as much.

The Processor Parameter Configuration table shows the configuration properties of the selected query processor, their default value, and the currently configured value. The values may be edited in this table, or in the service properties table directly. Changes in one of these tables are reflected in the other, with the exception that the properties on this page are not prefixed for readability.

Details Tab

The details tab allows the service developer to control mapping between XML schema types and the data types in the exposed domain model, as well as enable or disable query validation.

Data Service Details Tab

The serializer and deserializer fields may be edited by right-clicking and choosing an option from the popup menu which appears. Selecting custom serialization allows the service developer to manually enter class names, and default serialization resets the fields to be blank, allowing Globus and Axis to handle serialization and deserialization.

The targetable field contains a check box which indicates that a class is eligible to be the target of a CQL query. If deselected, a class can still be part of a query (i.e. an Association somewhere within the query), but cannot ever be returned by a query. Queries against classes which are not targetable will generate an error.

Auditing Tab

The data service framework supports some rudimentary auditing support, which can be configured with the Auditing tab in the Introduce toolkit. Multiple auditors may be added to the service, each of which may handle auditing events in its own way. Multiple instances of the same auditor type may be added as well, allowing configuration options to dictate their behavior and handling of auditing events.

Data Service Auditing Tab

Clicking the Discover button causes the panel to locate all Java classes which implement the Auditor interface currently in the service's lib directory. Instances of any class it locates may be selected from the dropdown menu and configured.

Four points of the data service query process may be audited:

• Query Begins
  • This event is fired when a query is first submitted to the data service before any validation or processing has been done.
• Validation Failure
  • This event is fired when a query fails the validation process. If validation is not enabled, this event will never be fired.
• Query Processing Failure
  • If a query should fail to process correctly, this event is fired. The reason (exception) causing the failure is included in this event.
• Query Results
  • When a query completes successfully, this event is fired. The results of the query are available at this point as well.

Other style-specific tabs

Data Service Styles may optionally provide a custom tab which will appear as a subtab of the Data Service tab in Introduce. This tab may contain configuration or information specific to the service style. For example, tn the above screenshots, a tab for the caCORE SDK 4.0 style is visible.