org.odata4j.producer
Interface ODataProducer

All Superinterfaces:

OExtensible<ODataProducer>

All Known Implementing Classes:

CommandProducer, InMemoryProducer, JdbcProducer, JPAProducer, MetadataProducer, ODataProducerDelegate

public interface ODataProducer
extends OExtensible<ODataProducer>

Implement ODataProducer on the server-side to create a new java-based OData producer.

The interface contains methods for clients to retrieve/query entities and to introspect service metadata (for read-only services) as well as methods to create/modify/delete entities (for read-write services).

Note that all client requests/responses are normalized - all details involving the OData http protocol, query expression model, EDM structure are handled by odata4j at a higher level.

Method Summary

BaseResponse	callFunction(EdmFunctionImport name, Map<String,OFunctionParameter> params, QueryInfo queryInfo) Calls a function (aka Service Operation).
void	close() Releases any resources managed by this producer.
EntityResponse	createEntity(String entitySetName, OEntity entity) Creates a new OData entity.
EntityResponse	createEntity(String entitySetName, OEntityKey entityKey, String navProp, OEntity entity) Creates a new OData entity as a reference of an existing entity, implicitly linked to the existing entity by a navigation property.
void	createLink(OEntityId sourceEntity, String targetNavProp, OEntityId targetEntity) Creates a link between two entities.
void	deleteEntity(String entitySetName, OEntityKey entityKey) Deletes an existing entity.
void	deleteLink(OEntityId sourceEntity, String targetNavProp, OEntityKey targetEntityKey) Deletes an existing link between two entities.
EntitiesResponse	getEntities(String entitySetName, QueryInfo queryInfo) Gets all the entities for a given set matching the query information.
CountResponse	getEntitiesCount(String entitySetName, QueryInfo queryInfo) Gets the count of all the entities for a given set matching the query information.
EntityResponse	getEntity(String entitySetName, OEntityKey entityKey, EntityQueryInfo queryInfo) Obtains a single entity based on its type and key.
EntityIdResponse	getLinks(OEntityId sourceEntity, String targetNavProp) Returns the value of an entity's navigation property as a collection of entity links (or a single link if the association cardinality is 1).
EdmDataServices	getMetadata() Obtains the service metadata for this producer.
MetadataProducer	getMetadataProducer() Obtains the ODataProducer implementation that serves the metadata as OData EDM constructs.
BaseResponse	getNavProperty(String entitySetName, OEntityKey entityKey, String navProp, QueryInfo queryInfo) Given a specific entity, follow one of its navigation properties, applying constraints as appropriate.
CountResponse	getNavPropertyCount(String entitySetName, OEntityKey entityKey, String navProp, QueryInfo queryInfo) Given a specific entity, follow one of its navigation properties, applying constraints as appropriate.
void	mergeEntity(String entitySetName, OEntity entity) Modifies an existing entity using merge semantics.
void	updateEntity(String entitySetName, OEntity entity) Modifies an existing entity using update semantics.
void	updateLink(OEntityId sourceEntity, String targetNavProp, OEntityKey oldTargetEntityKey, OEntityId newTargetEntity) Replaces an existing link between two entities.

Methods inherited from interface org.odata4j.core.OExtensible

findExtension

Method Detail

callFunction

BaseResponse callFunction(EdmFunctionImport name,
                          Map<String,OFunctionParameter> params,
                          QueryInfo queryInfo)

Calls a function (aka Service Operation).

Parameters:

name - the name of the function

params - the parameters to the function

queryInfo - additional query parameters to apply to collection-valued results

Returns:

a BaseResponse appropriately typed to hold the function results From the spec:

    The return type of <Function> MUST be one of the following:
        An EDMSimpleType or collection of EDMSimpleTypes.
        An entity type or collection of entity types.
        A complex type or collection of complex types.
        A row type or collection of row types.
        <ReturnType> can contain a maximum of one <CollectionType> element.
        <ReturnType> can contain a maximum of one <ReferenceType> element.
        <ReturnType> can contain a maximum of one <RowType> element.
        A ref type or collection of ref types.

close

void close()

Releases any resources managed by this producer.

createEntity

EntityResponse createEntity(String entitySetName,
                            OEntity entity)

Creates a new OData entity.

Parameters:

entitySetName - the entity-set name

entity - the request entity sent from the client

Returns:

the newly-created entity, fully populated with the key and default properties

See Also:

[odata.org] Creating new Entries

createEntity

EntityResponse createEntity(String entitySetName,
                            OEntityKey entityKey,
                            String navProp,
                            OEntity entity)

Creates a new OData entity as a reference of an existing entity, implicitly linked to the existing entity by a navigation property.

Parameters:

entitySetName - the entity-set name of the existing entity

entityKey - the entity-key of the existing entity

navProp - the navigation property off of the existing entity

entity - the request entity sent from the client

Returns:

the newly-created entity, fully populated with the key and default properties, and linked to the existing entity

See Also:

[odata.org] Creating new Entries

createLink

void createLink(OEntityId sourceEntity,
                String targetNavProp,
                OEntityId targetEntity)

Creates a link between two entities.

Parameters:

sourceEntity - an entity with at least one navigation property

targetNavProp - the navigation property

targetEntity - the link target entity

See Also:

[odata.org] Creating Links between Entries

deleteEntity

void deleteEntity(String entitySetName,
                  OEntityKey entityKey)

Deletes an existing entity.

Parameters:

entitySetName - the entity-set name of the entity

entityKey - the entity-key of the entity

See Also:

[odata.org] Deleting Entries

deleteLink

void deleteLink(OEntityId sourceEntity,
                String targetNavProp,
                OEntityKey targetEntityKey)

Deletes an existing link between two entities.

Parameters:

sourceEntity - an entity with at least one navigation property

targetNavProp - the navigation property

targetEntityKey - if the navigation property represents a set, the key identifying the target entity within the set, else n/a

getEntities

EntitiesResponse getEntities(String entitySetName,
                             QueryInfo queryInfo)

Gets all the entities for a given set matching the query information.

Parameters:

entitySetName - the entity-set name for entities to return

queryInfo - the additional constraints to apply to the entities

Returns:

a packaged collection of entities to pass back to the client

getEntitiesCount

CountResponse getEntitiesCount(String entitySetName,
                               QueryInfo queryInfo)

Gets the count of all the entities for a given set matching the query information.

Parameters:

entitySetName - the entity-set name for entities whose count is returned

queryInfo - the additional constraints to apply to the entities

Returns:

count of the entities

getEntity

EntityResponse getEntity(String entitySetName,
                         OEntityKey entityKey,
                         EntityQueryInfo queryInfo)

Obtains a single entity based on its type and key.

Parameters:

entitySetName - the entity-set name for entities to return

entityKey - the unique entity-key of the entity to start with

queryInfo - the additional constraints applicable to single-entity queries

Returns:

the resulting entity

getLinks

EntityIdResponse getLinks(OEntityId sourceEntity,
                          String targetNavProp)

Returns the value of an entity's navigation property as a collection of entity links (or a single link if the association cardinality is 1).

Parameters:

sourceEntity - an entity with at least one navigation property

targetNavProp - the navigation property

Returns:

a collection of entity links (or a single link if the association cardinality is 1)

getMetadata

EdmDataServices getMetadata()

Obtains the service metadata for this producer.

Returns:

a fully-constructed metadata object

getMetadataProducer

MetadataProducer getMetadataProducer()

Obtains the ODataProducer implementation that serves the metadata as OData EDM constructs.

Returns:

the MetadataProducer object

getNavProperty

BaseResponse getNavProperty(String entitySetName,
                            OEntityKey entityKey,
                            String navProp,
                            QueryInfo queryInfo)

Given a specific entity, follow one of its navigation properties, applying constraints as appropriate. Return the resulting entity, entities, or property value.

Parameters:

entitySetName - the entity-set of the entity to start with

entityKey - the unique entity-key of the entity to start with

navProp - the navigation property to follow

queryInfo - additional constraints to apply to the result

Returns:

the resulting entity, entities, or property value

getNavPropertyCount

CountResponse getNavPropertyCount(String entitySetName,
                                  OEntityKey entityKey,
                                  String navProp,
                                  QueryInfo queryInfo)

Given a specific entity, follow one of its navigation properties, applying constraints as appropriate. Return the count of the resulting entities.

Parameters:

entitySetName - the entity-set of the entity to start with

entityKey - the unique entity-key of the entity to start with

navProp - the navigation property to follow

queryInfo - additional constraints to apply to the result

Returns:

the count of the resulting entities

mergeEntity

void mergeEntity(String entitySetName,
                 OEntity entity)

Modifies an existing entity using merge semantics.

Parameters:

entitySetName - the entity-set name

entity - the entity modifications sent from the client

See Also:

[odata.org] Updating Entries

updateEntity

void updateEntity(String entitySetName,
                  OEntity entity)

Modifies an existing entity using update semantics.

Parameters:

entitySetName - the entity-set name

entity - the entity modifications sent from the client

See Also:

[odata.org] Updating Entries

updateLink

void updateLink(OEntityId sourceEntity,
                String targetNavProp,
                OEntityKey oldTargetEntityKey,
                OEntityId newTargetEntity)

Replaces an existing link between two entities.

Parameters:

sourceEntity - an entity with at least one navigation property

targetNavProp - the navigation property

oldTargetEntityKey - if the navigation property represents a set, the key identifying the old target entity within the set, else n/a

newTargetEntity - the new link target entity

See Also:

[odata.org] Replacing Links between Entries