public class

ODataJerseyConsumer

extends AbstractODataConsumer
java.lang.Object
   ↳ org.odata4j.consumer.AbstractODataConsumer
     ↳ org.odata4j.jersey.consumer.ODataJerseyConsumer

Class Overview

ODataConsumer is the client-side interface to an OData service.

Use #create(String) or one of the other static factory methods to connect to an existing OData service.

Summary

Nested Classes
class ODataJerseyConsumer.Builder Builder for ODataJerseyConsumer objects. 
Fields
private final Map<String, FeedCustomizationMapping> cachedMappings
private EdmDataServices cachedMetadata
private final ODataJerseyClient client
private ODataVersion version
[Expand]
Inherited Fields
From class org.odata4j.consumer.AbstractODataConsumer
From interface org.odata4j.consumer.ODataConsumer
Public Methods
OFunctionRequest<OObject> callFunction(String functionName)
static ODataJerseyConsumer create(String serviceRootUri, ODataVersion version)
Creates a new consumer for the given OData service uri.
OBatchRequest createBatch(String url)
OCreateRequest<OEntity> createEntity(String entitySetName)
OEntityRequest<Void> createLink(OEntityId sourceEntity, String targetNavProp, OEntityId targetEntity)
ConsumerDeleteEntityRequest deleteEntity(String entitySetName, OEntityKey key)
ConsumerDeleteEntityRequest deleteEntity(String entitySetName, Object keyValue, boolean keyIsGuid)
ConsumerDeleteEntityRequest deleteEntity(OEntityId entity)
OEntityRequest<Void> deleteLink(OEntityId sourceEntity, String targetNavProp, Object... targetKeyValues)
<T> OQueryRequest<T> getEntities(Class<T> entityType, String entitySetHref)
<T> OEntityGetRequest<T> getEntity(Class<T> entityType, String entitySetName, OEntityKey key)
Enumerable<EntitySetInfo> getEntitySets()
OQueryRequest<OEntityId> getLinks(OEntityId sourceEntity, String targetNavProp)
EdmDataServices getMetadata()
OModifyRequest<OEntity> mergeEntity(String entitySetName, Object keyValue, boolean keyIsGuid)
OModifyRequest<OEntity> mergeEntity(String entitySetName, OEntityKey key)
OModifyRequest<OEntity> mergeEntity(OEntity entity)
static ODataJerseyConsumer.Builder newBuilder(String serviceRootUri, ODataVersion version)
Constructs a new builder for an ODataJerseyConsumer object.
OModifyRequest<OEntity> updateEntity(OEntity entity)
OEntityRequest<Void> updateLink(OEntityId sourceEntity, OEntityId newTargetEntity, String targetNavProp, Object... oldTargetKeyValues)
[Expand]
Inherited Methods
From class org.odata4j.consumer.AbstractODataConsumer
From class java.lang.Object
From interface org.odata4j.consumer.ODataConsumer

Fields

private final Map<String, FeedCustomizationMapping> cachedMappings

private EdmDataServices cachedMetadata

private final ODataJerseyClient client

private ODataVersion version

Public Methods

public OFunctionRequest<OObject> callFunction (String functionName)

Parameters
functionName

public static ODataJerseyConsumer create (String serviceRootUri, ODataVersion version)

Creates a new consumer for the given OData service uri.

Wrapper for ODataConsumer.newBuilder(serviceRootUri).build().

Parameters
serviceRootUri The service uri

e.g. http://services.odata.org/Northwind/Northwind.svc/
version The OData protocol version to use
Returns
  • a new OData consumer

public OBatchRequest createBatch (String url)

Parameters
url

public OCreateRequest<OEntity> createEntity (String entitySetName)

Parameters
entitySetName

public OEntityRequest<Void> createLink (OEntityId sourceEntity, String targetNavProp, OEntityId targetEntity)

Parameters
sourceEntity
targetNavProp
targetEntity

public ConsumerDeleteEntityRequest deleteEntity (String entitySetName, OEntityKey key)

Parameters
entitySetName
key

public ConsumerDeleteEntityRequest deleteEntity (String entitySetName, Object keyValue, boolean keyIsGuid)

Parameters
entitySetName
keyValue
keyIsGuid

public ConsumerDeleteEntityRequest deleteEntity (OEntityId entity)

Parameters
entity

public OEntityRequest<Void> deleteLink (OEntityId sourceEntity, String targetNavProp, Object... targetKeyValues)

Parameters
sourceEntity
targetNavProp
targetKeyValues

public OQueryRequest<T> getEntities (Class<T> entityType, String entitySetHref)

Parameters
entityType
entitySetHref

public OEntityGetRequest<T> getEntity (Class<T> entityType, String entitySetName, OEntityKey key)

Parameters
entityType
entitySetName
key

public Enumerable<EntitySetInfo> getEntitySets ()

public OQueryRequest<OEntityId> getLinks (OEntityId sourceEntity, String targetNavProp)

Parameters
sourceEntity
targetNavProp

public EdmDataServices getMetadata ()

public OModifyRequest<OEntity> mergeEntity (String entitySetName, Object keyValue, boolean keyIsGuid)

Parameters
entitySetName
keyValue
keyIsGuid

public OModifyRequest<OEntity> mergeEntity (String entitySetName, OEntityKey key)

Parameters
entitySetName
key

public OModifyRequest<OEntity> mergeEntity (OEntity entity)

Parameters
entity

public static ODataJerseyConsumer.Builder newBuilder (String serviceRootUri, ODataVersion version)

Constructs a new builder for an ODataJerseyConsumer object.

Parameters
serviceRootUri The OData service root uri
version

public OModifyRequest<OEntity> updateEntity (OEntity entity)

Parameters
entity

public OEntityRequest<Void> updateLink (OEntityId sourceEntity, OEntityId newTargetEntity, String targetNavProp, Object... oldTargetKeyValues)

Parameters
sourceEntity
newTargetEntity
targetNavProp
oldTargetKeyValues