Package oracle.odi.dataservices.fwk

Provides an API to assist with implementing Data Services with Oracle Data Integrator.

See: Description

Interface Summary

Interface	Description
IDataService	Interface that a class needs to implement to be considered as a Data Integrator Data Service.

Class Summary

Class	Description
CDCManagedEntity	A data service parameter which represents the entity corresponding to a data change captured for a datastore.
CDCManagedEntityList	A data service parameter that represents a list of CDCManagedEntity objects.
CDCQuery	A data service parameter which represents a query that retrieves a list of captured changes.
ColumnsMeta	This class provides metadata about the columns of the managed entity to which it is attached.
DataServiceMeta	This class provides metadata about the data service, its namespace and its managed entity.
DataServicesParameters	This class defines the range of valid data service parameters.
DataServiceVoid	A data service parameter that represents a void parameter.
ManagedEntity	A data service parameter that represents the entity corresponding to one record of the datastore handled by the data service.
ManagedEntityList	A data service parameter that represents a list of ManagedEntity objects.
QueryFilter	A data service parameter used to define filters and ordering when accessing a datastore via a ManagedEntity.
QueryResponse	A data service parameter that represents the response to an operation (either INSERT, UPDATE or DELETE) performed on the datastore.
UpdateDeleteFilter	A data service parameter used to define filters when deleting or updating a datastore via a ManagedEntity.
UpdateFilter	A data service parameter used to define a filtered update on a datastore via a ManagedEntity.
Utils	A utility class that contains helpful methods for developing Service Knowledge Modules.

Exception Summary

Exception	Description
DataServiceException	A superclass for all exceptions thrown by data services.
InvalidInputMessageException	An exception thrown when input data provided to the web service is incorrect (for example, when an invalid SOAP message is sent to the web service).
InvalidOutputMessageException	An exception thrown when output data returned by the service class is incorrect.
MissingChildException	Exception Thrown by SOAP=>Java mapper when a mandatory child node is missing in the SOAP request message. Created on 14 Apr 2006
OdiSKMException	Exception class that can be used by the SKM tasks.

Package oracle.odi.dataservices.fwk Description

Provides an API to assist with implementing Data Services with Oracle Data Integrator. This API includes a framework to create data services. That is, web services which provide access to information stored in datastores and to changes captured using Data Integrator's CDC feature.

Since:

11.1.1.3.0

Using the Framework with Data Services

Any class implementing the IDataService interface exposes a data service. Any method in this class fulfilling the following requirements will be exposed as an operation of the data service:

• The method is public,
• The method has one and only one valid input parameter,
• The method has a valid output parameter.

Valid input and output parameters are defined and restricted using the DataServicesParameters class. Valid parameters include all classes handled by the data services framework, such as ManagedEntity, ManagedEntityList, QueryFilter and so on.

Package Contents

The oracle.odi.dataservices.fwk package contains the API for the following:

• Providing information about the data service
  • DataServiceMeta - metadata about the data service, including the namespace and the managed entity
  • ColumnsMeta - metadata about the managed entity columns
• Managing information in a datastore
  • ManagedEntity - represents the entity corresponding to one record of the datastore handled by the data service
  • ManagedEntityList - list of ManagedEntity objects
• Filtering operations on entities
  • QueryFilter - used to define filtering and ordering when accessing a datastore via a ManagedEntity
  • UpdateFilter - used to define filtering when updating a datastore via a ManagedEntity
• Managing changes captured for a datastore
  • CDCManagedEntity - represents the entity corresponding to a data change captured for a datastore
  • CDCManagedEntityList - list of CDCManagedEntity
  • CDCQuery - used to define a query for retrieving a list of changes captured
• Issuing other messages for operations
  • QueryResponse - response to an operation performed on the datastore
  • DataServiceVoid - data service void parameter
• Issuing Exceptions
  • DataServiceException - superclass for Exceptions thrown by Data Services
  • InvalidInputMessageException - thrown when the input data provided to the web service is incorrect
  • InvalidOutputMessageException - thrown when the output data returned by the service class is incorrect
• Utilities
  • DataServicesParameters - defines and restricts valid data service parameters
  • Utils - utility class containing helper methods for Service Knowledge Modules coding

Related Documentation

• Data Integrator On-Line Documentation includes information on how to create and customize data services