Package org.apache.olingo.server.api.processor

Olingo Processors

See: Description

Interface Summary

Interface	Description
ActionComplexCollectionProcessor	Processor interface for handling an action request with a return type of ComplexCollection.
ActionComplexProcessor	Processor interface for handling an action request with a return type of Complex.
ActionEntityCollectionProcessor	Processor interface for handling an action request with a return type of Entity Collection.
ActionEntityProcessor	Processor interface for handling an action request with a return type of Entity.
ActionPrimitiveCollectionProcessor	Processor interface for handling an action request with a return type of Primitive Collection.
ActionPrimitiveProcessor	Processor interface for handling an action request with a return type of Primitive.
ActionVoidProcessor	Processor interface for handling an action request with no return type.
BatchProcessor	Processor interface for handling a single instance of an Entity Type.
ComplexCollectionProcessor	Processor interface for handling a collection of complex-type instances, e.g., a property of an entity defined as collection of complex-type instances.
ComplexProcessor	Processor interface for handling an instance of a complex type, e.g., a complex property of an entity.
CountComplexCollectionProcessor	Processor interface for handling counting a collection of complex properties, e.g.
CountEntityCollectionProcessor	Processor interface for handling counting a collection of entities, e.g.
CountPrimitiveCollectionProcessor	Processor interface for handling counting a collection of primitive properties, e.g.
DeltaProcessor	Processor interface for handling a single instance of an Delta Response.
EntityCollectionProcessor	Processor interface for handling a collection of entities, e.g., an Entity Set.
EntityProcessor	Processor interface for handling a single instance of an Entity Type.
ErrorProcessor	Processor which is called if any error/exception occurs inside the library or another processor.
MediaEntityProcessor	Processor interface for handling Entity Media.
MetadataProcessor	Processor interface for handling the metadata document.
PrimitiveCollectionProcessor	Processor interface for handling a collection of primitive-type instances, e.g., a property of an entity defined as collection of primitive-type instances.
PrimitiveProcessor	Processor interface for handling an instance of a primitive type, e.g., a primitive property of an entity.
PrimitiveValueProcessor	Processor interface for handling an instance of a primitive type, e.g., a primitive property of an entity.
Processor	Base interface for all processor types.
ReferenceCollectionProcessor	Processor interface for handling a collection an Entity References.
ReferenceProcessor	Processor interface for handling a single instance of an Entity Reference.
ServiceDocumentProcessor	Processor interface for handling the service document.

Class Summary

Class	Description
DefaultProcessor	Processor implementation for handling default cases: request for the metadata document request for the service document error handling

Package org.apache.olingo.server.api.processor Description

Olingo Processors

Processors are used to handle OData requests and send back the OData reponse. Before a specific processor is called the Olingo library will parse the URI and validate it. Afterwards the Processor which matches the return type is called. Example: If a primitive property is requested by the URI we will call the PrimitiveProcessor.readPrimitive method.

Processors can be registered at the ODataHttpHandler object. Per default the DefaultProcessor is registered to perform basic functionality like delivering the metadata and service documents, respectively, as well as rendering an OData error. In case an application would like to perform custom tasks for these cases a new ServiceDocumentProcessor can be registered in order to overwrite the default behavior.