com.microsoft.azure.documentdb.DocumentClient Maven / Gradle / Ivy
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
*/
package com.microsoft.azure.documentdb;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import org.apache.commons.lang3.StringUtils;
import org.codehaus.jackson.map.ObjectMapper;
import org.json.JSONObject;
/**
* Provides a client-side logical representation of the Azure DocumentDB service. This client is used to configure and
* execute requests against the service.
*
* The service client encapsulates the endpoint and credentials used to access the DocumentDB service.
*/
public final class DocumentClient {
private int maxRetryAttempts;
private URI serviceEndpoint;
private String masterKey;
private Map resourceTokens;
private ConnectionPolicy connectionPolicy;
private GatewayProxy gatewayProxy;
private SessionContainer sessionContainer;
private ConsistencyLevel desiredConsistencyLevel;
private ConcurrentHashMap partitionResolvers;
private PartitionKeyDefinitionMap partitionKeyDefinitionMap;
/**
* A client query compatibility mode when making query request. Can be used to force a specific query request
* format.
*/
enum QueryCompatibilityMode {
Default,
Query,
SqlQuery
}
/**
* Compatibility mode:
* Allows to specify compatibility mode used by client when making query requests. Should be removed when
* application/sql is no longer supported.
*/
QueryCompatibilityMode queryCompatibilityMode = QueryCompatibilityMode.Default;
/**
* Initializes a new instance of the DocumentClient class using the specified DocumentDB service endpoint and keys.
*
* @param serviceEndpoint the URI of the service end point.
* @param masterKey the master key.
* @param connectionPolicy the connection policy.
* @param desiredConsistencyLevel the desired consistency level.
*/
public DocumentClient(String serviceEndpoint,
String masterKey,
ConnectionPolicy connectionPolicy,
ConsistencyLevel desiredConsistencyLevel) {
URI uri = null;
try {
uri = new URI(serviceEndpoint);
} catch (URISyntaxException e) {
throw new IllegalArgumentException("Invalid serviceEndPoint.", e);
}
this.masterKey = masterKey;
this.initialize(uri, connectionPolicy, desiredConsistencyLevel);
}
/**
* Initializes a new instance of the Microsoft.Azure.Documents.Client.DocumentClient class using the specified
* DocumentDB service endpoint and permissions.
*
* @param serviceEndpoint the URI of the service end point.
* @param permissionFeed the permission feed.
* @param connectionPolicy the connection policy.
* @param desiredConsistencyLevel the desired consistency level.
*/
public DocumentClient(String serviceEndpoint,
List permissionFeed,
ConnectionPolicy connectionPolicy,
ConsistencyLevel desiredConsistencyLevel) {
URI uri = null;
try {
uri = new URI(serviceEndpoint);
} catch (URISyntaxException e) {
throw new IllegalArgumentException("Invalid serviceEndPoint.", e);
}
this.resourceTokens = new HashMap();
for (Permission permission : permissionFeed) {
String[] segments = permission.getResourceLink().split("/");
if (segments.length <= 0) {
throw new IllegalArgumentException("link");
}
String resourceId = segments[segments.length - 1];
this.resourceTokens.put(resourceId, permission.getToken());
}
this.initialize(uri, connectionPolicy, desiredConsistencyLevel);
}
private void initialize(URI serviceEndpoint,
ConnectionPolicy connectionPolicy,
ConsistencyLevel desiredConsistencyLevel) {
this.serviceEndpoint = serviceEndpoint;
if (connectionPolicy != null) {
this.connectionPolicy = connectionPolicy;
} else {
this.connectionPolicy = new ConnectionPolicy();
}
this.maxRetryAttempts = this.connectionPolicy.getMaxRetryOnThrottledAttempts();
this.sessionContainer = new SessionContainer(this.serviceEndpoint.getHost());
this.desiredConsistencyLevel = desiredConsistencyLevel;
UserAgentContainer userAgentContainer = new UserAgentContainer();
String userAgentSuffix = this.connectionPolicy.getUserAgentSuffix();
if(userAgentSuffix != null && userAgentSuffix.length() > 0) {
userAgentContainer.setSuffix(userAgentSuffix);
}
this.gatewayProxy = new GatewayProxy(this.serviceEndpoint,
this.connectionPolicy,
desiredConsistencyLevel,
this.queryCompatibilityMode,
this.masterKey,
this.resourceTokens,
userAgentContainer);
this.partitionResolvers = new ConcurrentHashMap();
this.partitionKeyDefinitionMap = new InMemoryPartitionKeyDefinitionMap(this);
}
/**
* Registers the partition resolver associated with the database link
* @throws DocumentClientException
*/
public void registerPartitionResolver(String databaseLink, PartitionResolver partitionResolver)
throws DocumentClientException {
if(StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
if(partitionResolver == null) {
throw new IllegalArgumentException("partitionResolver");
}
this.partitionResolvers.put(Utils.trimBeginingAndEndingSlashes(databaseLink), partitionResolver);
}
/**
* Gets the partition resolver associated with the database link on the client
*/
protected PartitionResolver getPartitionResolver(String databaseLink) {
if(StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
return this.partitionResolvers.get(Utils.trimBeginingAndEndingSlashes(databaseLink));
}
// used by unit test to mock gateway proxy.
void setGatewayProxyOverride(GatewayProxy proxyOverride) {
this.gatewayProxy = proxyOverride;
}
// used by unit test to mock partition key definition map.
void setPartitionKeyDefinitionMapOverride(PartitionKeyDefinitionMap mapOverride) {
this.partitionKeyDefinitionMap = mapOverride;
}
ConnectionPolicy getConnectionPolicy() {
return this.connectionPolicy;
}
/**
* Creates a database.
*
* @param database the database.
* @param options the request options.
* @return the resource response with the created database.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createDatabase(Database database, RequestOptions options)
throws DocumentClientException {
if (database == null) {
throw new IllegalArgumentException("Database");
}
DocumentClient.validateResource(database);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Database,
Paths.DATABASES_ROOT,
database,
requestHeaders);
return new ResourceResponse(this.doCreate(request), Database.class);
}
/**
* Deletes a database.
*
* @param databaseLink the database link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deleteDatabase(String databaseLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
String path = Utils.joinPath(databaseLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Database,
path,
requestHeaders);
return new ResourceResponse(this.doDelete(request), Database.class);
}
/**
* Reads a database.
*
* @param databaseLink the database link.
* @param options the request options.
* @return the resource response with the read database.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readDatabase(String databaseLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
String path = Utils.joinPath(databaseLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Database,
path,
requestHeaders);
return new ResourceResponse(this.doRead(request), Database.class);
}
/**
* Reads all databases.
*
* @param options the feed options.
* @return the feed response with the read databases.
*/
public FeedResponse readDatabases(FeedOptions options) {
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Database,
Paths.DATABASES_ROOT,
requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Feed, Database.class));
}
/**
* Query for databases.
*
* @param query the query.
* @param options the feed options.
* @return the feed response with the obtained databases.
*/
public FeedResponse queryDatabases(String query, FeedOptions options) {
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryDatabases(new SqlQuerySpec(query, null), options);
}
/**
* Query for databases.
*
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response with the obtained databases.
*/
public FeedResponse queryDatabases(SqlQuerySpec querySpec, FeedOptions options) {
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Database,
Paths.DATABASES_ROOT,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Query, Database.class));
}
/**
* Creates a document collection.
*
* @param databaseLink the database link.
* @param collection the collection.
* @param options the request options.
* @return the resource response with the created collection.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createCollection(String databaseLink,
DocumentCollection collection,
RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
if (collection == null) {
throw new IllegalArgumentException("collection");
}
DocumentClient.validateResource(collection);
String path = Utils.joinPath(databaseLink, Paths.COLLECTIONS_PATH_SEGMENT);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.DocumentCollection,
path,
collection,
requestHeaders);
return new ResourceResponse(this.doCreate(request), DocumentCollection.class);
}
/**
* Replaces a document collection.
*
* @param collection the document collection to use.
* @param options the request options.
* @return the resource response with the replaced document collection.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replaceCollection(DocumentCollection collection,
RequestOptions options)
throws DocumentClientException {
if (collection == null) {
throw new IllegalArgumentException("collection");
}
DocumentClient.validateResource(collection);
String path = Utils.joinPath(collection.getSelfLink(), null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.DocumentCollection,
path,
collection,
requestHeaders);
return new ResourceResponse(this.doReplace(request), DocumentCollection.class);
}
/**
* Deletes a document collection by the collection link.
*
* @param collectionLink the collection link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deleteCollection(String collectionLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
String path = Utils.joinPath(collectionLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.DocumentCollection,
path,
requestHeaders);
return new ResourceResponse(this.doDelete(request), DocumentCollection.class);
}
/**
* Reads a document collection by the collection link.
*
* @param collectionLink the collection link.
* @param options the request options.
* @return the resource response with the read collection.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readCollection(String collectionLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
String path = Utils.joinPath(collectionLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.DocumentCollection,
path,
requestHeaders);
return new ResourceResponse(this.doRead(request), DocumentCollection.class);
}
/**
* Reads all document collections in a database.
*
* @param databaseLink the database link.
* @param options the fee options.
* @return the feed response with the read collections.
*/
public FeedResponse readCollections(String databaseLink, FeedOptions options) {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
String path = Utils.joinPath(databaseLink,
Paths.COLLECTIONS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.DocumentCollection,
path,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Feed,
DocumentCollection.class));
}
/**
* Query for document collections in a database.
*
* @param databaseLink the database link.
* @param query the query.
* @param options the feed options.
* @return the feed response with the obtained collections.
*/
public FeedResponse queryCollections(String databaseLink, String query, FeedOptions options) {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryCollections(databaseLink, new SqlQuerySpec(query, null), options);
}
/**
* Query for document collections in a database.
*
* @param databaseLink the database link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response with the obtained collections.
*/
public FeedResponse queryCollections(String databaseLink,
SqlQuerySpec querySpec,
FeedOptions options) {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
String path = Utils.joinPath(databaseLink, Paths.COLLECTIONS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.DocumentCollection,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Query,
DocumentCollection.class));
}
/**
* Creates a document.
*
* @param databaseOrDocumentCollectionLink the database link when using partitioning, otherwise document collection link.
* @param document the document represented as a POJO or Document object.
* @param options the request options.
* @param disableAutomaticIdGeneration the flag for disabling automatic id generation.
* @return the resource response with the created document.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createDocument(String databaseOrDocumentCollectionLink,
Object document,
RequestOptions options,
boolean disableAutomaticIdGeneration)
throws DocumentClientException {
String documentCollectionLink = this.getTargetDocumentCollectionLink(databaseOrDocumentCollectionLink, document);
DocumentServiceRequest request = getDocumentRequest(documentCollectionLink, document, options,
disableAutomaticIdGeneration);
return new ResourceResponse(this.doCreate(request), Document.class);
}
/**
* Upserts a document.
*
* @param databaseOrDocumentCollectionLink the database link when using partitioning, otherwise document collection link.
* @param document the document represented as a POJO or Document object to upsert.
* @param options the request options.
* @param disableAutomaticIdGeneration the flag for disabling automatic id generation.
* @return the resource response with the upserted document.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse upsertDocument(String databaseOrDocumentCollectionLink,
Object document,
RequestOptions options,
boolean disableAutomaticIdGeneration)
throws DocumentClientException {
String documentCollectionLink = this.getTargetDocumentCollectionLink(databaseOrDocumentCollectionLink, document);
DocumentServiceRequest request = getDocumentRequest(documentCollectionLink, document, options,
disableAutomaticIdGeneration);
return new ResourceResponse(this.doUpsert(request), Document.class);
}
protected static final String PartitionResolverErrorMessage = "Couldn't find any partition resolvers for the database link provided. Ensure that the link you used when registering the partition resolvers matches the link provided or you need to register both types of database link(self link as well as ID based link).";
private String getTargetDocumentCollectionLink(String databaseOrDocumentCollectionLink, Object document) {
if (StringUtils.isEmpty(databaseOrDocumentCollectionLink)) {
throw new IllegalArgumentException("databaseOrDocumentCollectionLink");
}
if (document == null) {
throw new IllegalArgumentException("document");
}
String documentCollectionLink = databaseOrDocumentCollectionLink;
if(Utils.isDatabaseLink(databaseOrDocumentCollectionLink)) {
// Gets the partition resolver(if it exists) for the specified database link
PartitionResolver partitionResolver = this.getPartitionResolver(databaseOrDocumentCollectionLink);
// If the partition resolver exists, get the collection to which the Create/Upsert should be directed using the partition key
if(partitionResolver != null) {
documentCollectionLink = partitionResolver.resolveForCreate(document);
}
else {
throw new IllegalArgumentException(PartitionResolverErrorMessage);
}
}
return documentCollectionLink;
}
private DocumentServiceRequest getDocumentRequest(String documentCollectionLink, Object document, RequestOptions options,
boolean disableAutomaticIdGeneration) {
if (StringUtils.isEmpty(documentCollectionLink)) {
throw new IllegalArgumentException("documentCollectionLink");
}
if (document == null) {
throw new IllegalArgumentException("document");
}
Document typedDocument = Document.FromObject(document);
DocumentClient.validateResource(typedDocument);
if (typedDocument.getId() == null && !disableAutomaticIdGeneration) {
// We are supposed to use GUID. Basically UUID is the same as GUID
// when represented as a string.
typedDocument.setId(UUID.randomUUID().toString());
}
options = this.insertPartitionKeyIfNeeded(documentCollectionLink, typedDocument, options);
String path = Utils.joinPath(documentCollectionLink, Paths.DOCUMENTS_PATH_SEGMENT);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Document,
path,
typedDocument,
requestHeaders);
return request;
}
/**
* Replaces a document using a POJO object.
*
* @param documentLink the document link.
* @param document the document represented as a POJO or Document object.
* @param options the request options.
* @return the resource response with the replaced document.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replaceDocument(String documentLink, Object document, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(documentLink)) {
throw new IllegalArgumentException("documentLink");
}
if (document == null) {
throw new IllegalArgumentException("document");
}
Document typedDocument = Document.FromObject(document);
DocumentClient.validateResource(typedDocument);
options = this.insertPartitionKeyIfNeeded(Utils.getCollectionName(documentLink), typedDocument, options);
String path = Utils.joinPath(documentLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Document,
path,
typedDocument,
requestHeaders);
return new ResourceResponse(this.doReplace(request), Document.class);
}
/**
* Replaces a document with the passed in document.
*
* @param document the document to replace (containing the document id).
* @param options the request options.
* @return the resource response with the replaced document.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replaceDocument(Document document, RequestOptions options)
throws DocumentClientException {
if (document == null) {
throw new IllegalArgumentException("document");
}
DocumentClient.validateResource(document);
options = this.insertPartitionKeyIfNeeded(Utils.getCollectionName(document.getSelfLink()), document, options);
String path = Utils.joinPath(document.getSelfLink(), null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Document,
path,
document,
requestHeaders);
return new ResourceResponse(this.doReplace(request), Document.class);
}
/**
* Deletes a document by the document link.
*
* @param documentLink the document link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deleteDocument(String documentLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(documentLink)) {
throw new IllegalArgumentException("documentLink");
}
String path = Utils.joinPath(documentLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Document, path, requestHeaders);
return new ResourceResponse(this.doDelete(request), Document.class);
}
/**
* Reads a document by the document link.
*
* @param documentLink the document link.
* @param options the request options.
* @return the resource response with the read document.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readDocument(String documentLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(documentLink)) {
throw new IllegalArgumentException("documentLink");
}
String path = Utils.joinPath(documentLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Document, path, requestHeaders);
return new ResourceResponse(this.doRead(request), Document.class);
}
/**
* Reads all documents in a document collection.
*
* @param collectionLink the collection link.
* @param options the feed options.
* @return the feed response with read documents.
*/
public FeedResponse readDocuments(String collectionLink, FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
String path = Utils.joinPath(collectionLink, Paths.DOCUMENTS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Document, path, requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Feed, Document.class));
}
/**
* Query for documents in a document collection.
*
* @param databaseOrDocumentCollectionLink the database link when using partitioning, otherwise document collection link.
* @param query the query.
* @param options the feed options.
* @return the feed response with the obtained documents.
*/
public FeedResponse queryDocuments(String databaseOrDocumentCollectionLink, String query, FeedOptions options) {
return this.queryDocuments(databaseOrDocumentCollectionLink, query, options, null);
}
/**
* Query for documents in a document collection with a partitionKey
*
* @param databaseOrDocumentCollectionLink the database link when using partitioning, otherwise document collection link.
* @param query the query.
* @param options the feed options.
* @param partitionKey the partitionKey.
* @return the feed response with the obtained documents.
*/
public FeedResponse queryDocuments(String databaseOrDocumentCollectionLink, String query, FeedOptions options, Object partitionKey) {
if (StringUtils.isEmpty(databaseOrDocumentCollectionLink)) {
throw new IllegalArgumentException("databaseOrDocumentCollectionLink");
}
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryDocuments(databaseOrDocumentCollectionLink, new SqlQuerySpec(query, null), options, partitionKey);
}
/**
* Query for documents in a document collection.
*
* @param databaseOrDocumentCollectionLink the database link when using partitioning, otherwise document collection link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response with the obtained documents.
*/
public FeedResponse queryDocuments(String databaseOrDocumentCollectionLink, SqlQuerySpec querySpec, FeedOptions options) {
return this.queryDocuments(databaseOrDocumentCollectionLink, querySpec, options, null);
}
/**
* Query for documents in a document collection.
*
* @param databaseOrDocumentCollectionLink the database link when using partitioning, otherwise document collection link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @param partitionKey the partitionKey.
* @return the feed response with the obtained documents.
*/
public FeedResponse queryDocuments(String databaseOrDocumentCollectionLink, SqlQuerySpec querySpec, FeedOptions options, Object partitionKey) {
if (StringUtils.isEmpty(databaseOrDocumentCollectionLink)) {
throw new IllegalArgumentException("databaseOrDocumentCollectionLink");
}
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
if(Utils.isDatabaseLink(databaseOrDocumentCollectionLink)) {
return new FeedResponse(new QueryIterable(this,
databaseOrDocumentCollectionLink,
querySpec,
options,
partitionKey,
ReadType.Query,
Document.class));
}
else {
String path = Utils.joinPath(databaseOrDocumentCollectionLink, Paths.DOCUMENTS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Document,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Query,
Document.class));
}
}
/**
* Creates a stored procedure.
*
* @param collectionLink the collection link.
* @param storedProcedure the stored procedure to create.
* @param options the request options.
* @return the resource response with the created stored procedure.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createStoredProcedure(String collectionLink,
StoredProcedure storedProcedure,
RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getStoredProcedureRequest(collectionLink, storedProcedure, options);
return new ResourceResponse(this.doCreate(request), StoredProcedure.class);
}
/**
* Upserts a stored procedure.
*
* @param collectionLink the collection link.
* @param storedProcedure the stored procedure to upsert.
* @param options the request options.
* @return the resource response with the upserted stored procedure.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse upsertStoredProcedure(String collectionLink,
StoredProcedure storedProcedure,
RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getStoredProcedureRequest(collectionLink, storedProcedure, options);
return new ResourceResponse(this.doUpsert(request), StoredProcedure.class);
}
private DocumentServiceRequest getStoredProcedureRequest(String collectionLink, StoredProcedure storedProcedure,
RequestOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (storedProcedure == null) {
throw new IllegalArgumentException("storedProcedure");
}
DocumentClient.validateResource(storedProcedure);
String path = Utils.joinPath(collectionLink, Paths.STORED_PROCEDURES_PATH_SEGMENT);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.StoredProcedure,
path,
storedProcedure,
requestHeaders);
return request;
}
/**
* Replaces a stored procedure.
*
* @param storedProcedure the stored procedure to use.
* @param options the request options.
* @return the resource response with the replaced stored procedure.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replaceStoredProcedure(StoredProcedure storedProcedure,
RequestOptions options)
throws DocumentClientException {
if (storedProcedure == null) {
throw new IllegalArgumentException("storedProcedure");
}
DocumentClient.validateResource(storedProcedure);
String path = Utils.joinPath(storedProcedure.getSelfLink(), null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.StoredProcedure,
path,
storedProcedure,
requestHeaders);
return new ResourceResponse(this.doReplace(request), StoredProcedure.class);
}
/**
* Deletes a stored procedure by the stored procedure link.
*
* @param storedProcedureLink the stored procedure link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deleteStoredProcedure(String storedProcedureLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(storedProcedureLink)) {
throw new IllegalArgumentException("storedProcedureLink");
}
String path = Utils.joinPath(storedProcedureLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.StoredProcedure,
path,
requestHeaders);
return new ResourceResponse(this.doDelete(request), StoredProcedure.class);
}
/**
* Read a stored procedure by the stored procedure link.
*
* @param storedProcedureLink the stored procedure link.
* @param options the request options.
* @return the resource response with the read stored procedure.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readStoredProcedure(String storedProcedureLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(storedProcedureLink)) {
throw new IllegalArgumentException("storedProcedureLink");
}
String path = Utils.joinPath(storedProcedureLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.StoredProcedure,
path,
requestHeaders);
return new ResourceResponse(this.doRead(request), StoredProcedure.class);
}
/**
* Reads all stored procedures in a document collection link.
*
* @param collectionLink the collection link.
* @param options the feed options.
* @return the feed response with the read stored procedure.
*/
public FeedResponse readStoredProcedures(String collectionLink, FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
String path = Utils.joinPath(collectionLink, Paths.STORED_PROCEDURES_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.StoredProcedure,
path,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Feed,
StoredProcedure.class));
}
/**
* Query for stored procedures in a document collection.
*
* @param collectionLink the collection link.
* @param query the query.
* @param options the feed options.
* @return the feed response with the obtained stored procedures.
*/
public FeedResponse queryStoredProcedures(String collectionLink,
String query,
FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryStoredProcedures(collectionLink, new SqlQuerySpec(query, null), options);
}
/**
* Query for stored procedures in a document collection.
*
* @param collectionLink the collection link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response with the obtained stored procedures.
*/
public FeedResponse queryStoredProcedures(String collectionLink,
SqlQuerySpec querySpec,
FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
String path = Utils.joinPath(collectionLink, Paths.STORED_PROCEDURES_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.StoredProcedure,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Query,
StoredProcedure.class));
}
/**
* Executes a stored procedure by the stored procedure link.
*
* @param storedProcedureLink the stored procedure link.
* @param procedureParams the array of procedure parameter values.
* @return the stored procedure response.
* @throws DocumentClientException the document client exception.
*/
public StoredProcedureResponse executeStoredProcedure(String storedProcedureLink, Object[] procedureParams)
throws DocumentClientException {
return this.executeStoredProcedure(storedProcedureLink, null, procedureParams);
}
/**
* Executes a stored procedure by the stored procedure link.
*
* @param storedProcedureLink the stored procedure link.
* @param options the request options.
* @param procedureParams the array of procedure parameter values.
* @return the stored procedure response.
* @throws DocumentClientException the document client exception.
*/
public StoredProcedureResponse executeStoredProcedure(String storedProcedureLink, RequestOptions options, Object[] procedureParams)
throws DocumentClientException {
String path = Utils.joinPath(storedProcedureLink, null);
Map requestHeaders = new HashMap();
requestHeaders.put(HttpConstants.HttpHeaders.ACCEPT, RuntimeConstants.MediaTypes.JSON);
if (options != null) {
if (options.getPartitionKey() != null) {
requestHeaders.put(HttpConstants.HttpHeaders.PARTITION_KEY, options.getPartitionKey().toString());
}
}
DocumentServiceRequest request = DocumentServiceRequest.create(
ResourceType.StoredProcedure,
path,
procedureParams != null ? DocumentClient.serializeProcedureParams(procedureParams) : "",
requestHeaders);
return new StoredProcedureResponse(this.doCreate(request));
}
/**
* Creates a trigger.
*
* @param collectionLink the collection link.
* @param trigger the trigger.
* @param options the request options.
* @return the resource response with the created trigger.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createTrigger(String collectionLink, Trigger trigger, RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getTriggerRequest(collectionLink, trigger, options);
return new ResourceResponse(this.doCreate(request), Trigger.class);
}
/**
* Upserts a trigger.
*
* @param collectionLink the collection link.
* @param trigger the trigger to upsert.
* @param options the request options.
* @return the resource response with the upserted trigger.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse upsertTrigger(String collectionLink, Trigger trigger, RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getTriggerRequest(collectionLink, trigger, options);
return new ResourceResponse(this.doUpsert(request), Trigger.class);
}
private DocumentServiceRequest getTriggerRequest(String collectionLink, Trigger trigger, RequestOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (trigger == null) {
throw new IllegalArgumentException("trigger");
}
DocumentClient.validateResource(trigger);
String path = Utils.joinPath(collectionLink, Paths.TRIGGERS_PATH_SEGMENT);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Trigger,
path,
trigger,
requestHeaders);
return request;
}
/**
* Replaces a trigger.
*
* @param trigger the trigger to use.
* @param options the request options.
* @return the resource response with the replaced trigger.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replaceTrigger(Trigger trigger, RequestOptions options)
throws DocumentClientException {
if (trigger == null) {
throw new IllegalArgumentException("trigger");
}
DocumentClient.validateResource(trigger);
String path = Utils.joinPath(trigger.getSelfLink(), null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Trigger,
path,
trigger,
requestHeaders);
return new ResourceResponse(this.doReplace(request), Trigger.class);
}
/**
* Deletes a trigger.
*
* @param triggerLink the trigger link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deleteTrigger(String triggerLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(triggerLink)) {
throw new IllegalArgumentException("triggerLink");
}
String path = Utils.joinPath(triggerLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Trigger, path, requestHeaders);
return new ResourceResponse(this.doDelete(request), Trigger.class);
}
/**
* Reads a trigger by the trigger link.
*
* @param triggerLink the trigger link.
* @param options the request options.
* @return the resource response with the read trigger.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readTrigger(String triggerLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(triggerLink)) {
throw new IllegalArgumentException("triggerLink");
}
String path = Utils.joinPath(triggerLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Trigger, path, requestHeaders);
return new ResourceResponse(this.gatewayProxy.doRead(request), Trigger.class);
}
/**
* Reads all triggers in a document collection.
*
* @param collectionLink the collection link.
* @param options the feed options.
* @return the feed response with the read triggers.
*/
public FeedResponse readTriggers(String collectionLink, FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
String path = Utils.joinPath(collectionLink, Paths.TRIGGERS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Trigger, path, requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Feed, Trigger.class));
}
/**
* Query for triggers.
*
* @param collectionLink the collection link.
* @param query the query.
* @param options the feed options.
* @return the feed response with the obtained triggers.
*/
public FeedResponse queryTriggers(String collectionLink,
String query,
FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryTriggers(collectionLink, new SqlQuerySpec(query, null), options);
}
/**
* Query for triggers.
*
* @param collectionLink the collection link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response with the obtained triggers.
*/
public FeedResponse queryTriggers(String collectionLink,
SqlQuerySpec querySpec,
FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
String path = Utils.joinPath(collectionLink, Paths.TRIGGERS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Trigger,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Query, Trigger.class));
}
/**
* Creates a user defined function.
*
* @param collectionLink the collection link.
* @param udf the user defined function.
* @param options the request options.
* @return the resource response with the created user defined function.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createUserDefinedFunction(
String collectionLink,
UserDefinedFunction udf,
RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getUserDefinedFunctionRequest(collectionLink, udf, options);
return new ResourceResponse(this.doCreate(request), UserDefinedFunction.class);
}
/**
* Upserts a user defined function.
*
* @param collectionLink the collection link.
* @param udf the user defined function to upsert.
* @param options the request options.
* @return the resource response with the upserted user defined function.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse upsertUserDefinedFunction(
String collectionLink,
UserDefinedFunction udf,
RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getUserDefinedFunctionRequest(collectionLink, udf, options);
return new ResourceResponse(this.doUpsert(request), UserDefinedFunction.class);
}
private DocumentServiceRequest getUserDefinedFunctionRequest(String collectionLink, UserDefinedFunction udf,
RequestOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (udf == null) {
throw new IllegalArgumentException("udf");
}
DocumentClient.validateResource(udf);
String path = Utils.joinPath(collectionLink, Paths.USER_DEFINED_FUNCTIONS_PATH_SEGMENT);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.UserDefinedFunction,
path,
udf,
requestHeaders);
return request;
}
/**
* Replaces a user defined function.
*
* @param udf the user defined function.
* @param options the request options.
* @return the resource response with the replaced user defined function.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replaceUserDefinedFunction(UserDefinedFunction udf,
RequestOptions options)
throws DocumentClientException {
if (udf == null) {
throw new IllegalArgumentException("udf");
}
DocumentClient.validateResource(udf);
String path = Utils.joinPath(udf.getSelfLink(), null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.UserDefinedFunction,
path,
udf,
requestHeaders);
return new ResourceResponse(this.doReplace(request), UserDefinedFunction.class);
}
/**
* Deletes a user defined function.
*
* @param udfLink the user defined function link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deleteUserDefinedFunction(String udfLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(udfLink)) {
throw new IllegalArgumentException("udfLink");
}
String path = Utils.joinPath(udfLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.UserDefinedFunction,
path,
requestHeaders);
return new ResourceResponse(this.doDelete(request), UserDefinedFunction.class);
}
/**
* Read a user defined function.
*
* @param udfLink the user defined function link.
* @param options the request options.
* @return the resource response with the read user defined function.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readUserDefinedFunction(String udfLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(udfLink)) {
throw new IllegalArgumentException("udfLink");
}
String path = Utils.joinPath(udfLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.UserDefinedFunction,
path,
requestHeaders);
return new ResourceResponse(this.doRead(request), UserDefinedFunction.class);
}
/**
* Reads all user defined functions in a document collection.
*
* @param collectionLink the collection link.
* @param options the feed options.
* @return the feed response with the read user defined functions.
*/
public FeedResponse readUserDefinedFunctions(String collectionLink, FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
String path = Utils.joinPath(collectionLink, Paths.USER_DEFINED_FUNCTIONS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.UserDefinedFunction,
path,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Feed,
UserDefinedFunction.class));
}
/**
* Query for user defined functions.
*
* @param collectionLink the collection link.
* @param query the query.
* @param options the feed options.
* @return the feed response with the obtained user defined functions.
*/
public FeedResponse queryUserDefinedFunctions(String collectionLink,
String query,
FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryUserDefinedFunctions(collectionLink, new SqlQuerySpec(query, null), options);
}
/**
* Query for user defined functions.
*
* @param collectionLink the collection link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response with the obtained user defined functions.
*/
public FeedResponse queryUserDefinedFunctions(String collectionLink,
SqlQuerySpec querySpec,
FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
String path = Utils.joinPath(collectionLink, Paths.USER_DEFINED_FUNCTIONS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.UserDefinedFunction,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Query,
UserDefinedFunction.class));
}
/**
* Creates an attachment.
*
* @param documentLink the document link.
* @param attachment the attachment to create.
* @param options the request options.
* @return the resource response with the created attachment.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createAttachment(String documentLink,
Attachment attachment,
RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getAttachmentRequest(documentLink, attachment, options);
return new ResourceResponse(this.doCreate(request), Attachment.class);
}
/**
* Upserts an attachment.
*
* @param documentLink the document link.
* @param attachment the attachment to upsert.
* @param options the request options.
* @return the resource response with the upserted attachment.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse upsertAttachment(String documentLink,
Attachment attachment,
RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getAttachmentRequest(documentLink, attachment, options);
return new ResourceResponse(this.doUpsert(request), Attachment.class);
}
private DocumentServiceRequest getAttachmentRequest(String documentLink, Attachment attachment,
RequestOptions options) {
if (StringUtils.isEmpty(documentLink)) {
throw new IllegalArgumentException("documentLink");
}
if (attachment == null) {
throw new IllegalArgumentException("attachment");
}
DocumentClient.validateResource(attachment);
String path = Utils.joinPath(documentLink, Paths.ATTACHMENTS_PATH_SEGMENT);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Attachment,
path,
attachment,
requestHeaders);
return request;
}
/**
* Replaces an attachment.
*
* @param attachment the attachment to use.
* @param options the request options.
* @return the resource response with the replaced attachment.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replaceAttachment(Attachment attachment, RequestOptions options)
throws DocumentClientException {
if (attachment == null) {
throw new IllegalArgumentException("attachment");
}
DocumentClient.validateResource(attachment);
String path = Utils.joinPath(attachment.getSelfLink(), null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Attachment,
path,
attachment,
requestHeaders);
return new ResourceResponse(this.doReplace(request), Attachment.class);
}
/**
* Deletes an attachment.
*
* @param attachmentLink the attachment link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deleteAttachment(String attachmentLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(attachmentLink)) {
throw new IllegalArgumentException("attachmentLink");
}
String path = Utils.joinPath(attachmentLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Attachment,
path,
requestHeaders);
return new ResourceResponse(this.doDelete(request), Attachment.class);
}
/**
* Reads an attachment.
*
* @param attachmentLink the attachment link.
* @param options the request options.
* @return the resource response with the read attachment.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readAttachment(String attachmentLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(attachmentLink)) {
throw new IllegalArgumentException("attachmentLink");
}
String path = Utils.joinPath(attachmentLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Attachment, path, requestHeaders);
return new ResourceResponse(this.doRead(request), Attachment.class);
}
/**
* Reads an attachment.
*
* @param documentLink the document link.
* @param options the feed options.
* @return the feed response with the read attachments.
*/
public FeedResponse readAttachments(String documentLink, FeedOptions options) {
if (StringUtils.isEmpty(documentLink)) {
throw new IllegalArgumentException("documentLink");
}
String path = Utils.joinPath(documentLink, Paths.ATTACHMENTS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Attachment,
path,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Feed,
Attachment.class));
}
/**
* Query for attachments.
*
* @param documentLink the document link.
* @param query the query.
* @param options the feed options.
* @return the feed response with the obtained attachments.
*/
public FeedResponse queryAttachments(String documentLink, String query, FeedOptions options) {
if (StringUtils.isEmpty(documentLink)) {
throw new IllegalArgumentException("documentLink");
}
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryAttachments(documentLink, new SqlQuerySpec(query, null), options);
}
/**
* Query for attachments.
*
* @param documentLink the document link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response with the obtained attachments.
*/
public FeedResponse queryAttachments(String documentLink, SqlQuerySpec querySpec, FeedOptions options) {
if (StringUtils.isEmpty(documentLink)) {
throw new IllegalArgumentException("documentLink");
}
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
String path = Utils.joinPath(documentLink, Paths.ATTACHMENTS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Attachment,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Query,
Attachment.class));
}
/**
* Creates an attachment.
*
* @param documentLink the document link.
* @param mediaStream the media stream for creating the attachment.
* @param options the media options.
* @return the resource response with the created attachment.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createAttachment(String documentLink,
InputStream mediaStream,
MediaOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getAttachmentRequest(documentLink, mediaStream, options);
return new ResourceResponse(this.doCreate(request), Attachment.class);
}
/**
* Upserts an attachment to the media stream
*
* @param documentLink the document link.
* @param mediaStream the media stream for upserting the attachment.
* @param options the media options.
* @return the resource response with the upserted attachment.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse upsertAttachment(String documentLink,
InputStream mediaStream,
MediaOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getAttachmentRequest(documentLink, mediaStream, options);
return new ResourceResponse(this.doUpsert(request), Attachment.class);
}
private DocumentServiceRequest getAttachmentRequest(String documentLink, InputStream mediaStream,
MediaOptions options) {
if (StringUtils.isEmpty(documentLink)) {
throw new IllegalArgumentException("documentLink");
}
if (mediaStream == null) {
throw new IllegalArgumentException("mediaStream");
}
String path = Utils.joinPath(documentLink, Paths.ATTACHMENTS_PATH_SEGMENT);
Map requestHeaders = this.getMediaHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Attachment,
path,
mediaStream,
requestHeaders);
request.setIsMedia(true);
return request;
}
/**
* Reads a media by the media link.
*
* @param mediaLink the media link.
* @return the media response.
* @throws DocumentClientException the document client exception.
*/
public MediaResponse readMedia(String mediaLink) throws DocumentClientException {
if (StringUtils.isEmpty(mediaLink)) {
throw new IllegalArgumentException("mediaLink");
}
String path = Utils.joinPath(mediaLink, null);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Media, path, null);
request.setIsMedia(true);
return new MediaResponse(this.doRead(request),
this.connectionPolicy.getMediaReadMode() == MediaReadMode.Buffered);
}
/**
* Updates a media by the media link.
*
* @param mediaLink the media link.
* @param mediaStream the media stream to upload.
* @param options the media options.
* @return the media response.
* @throws DocumentClientException the document client exception.
*/
public MediaResponse updateMedia(String mediaLink, InputStream mediaStream, MediaOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(mediaLink)) {
throw new IllegalArgumentException("mediaLink");
}
if (mediaStream == null) {
throw new IllegalArgumentException("mediaStream");
}
String path = Utils.joinPath(mediaLink, null);
Map requestHeaders = this.getMediaHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Media,
path,
mediaStream,
requestHeaders);
request.setIsMedia(true);
return new MediaResponse(this.doReplace(request),
this.connectionPolicy.getMediaReadMode() == MediaReadMode.Buffered);
}
/**
* Reads a conflict.
*
* @param conflictLink the conflict link.
* @param options the request options.
* @return the resource response with the read conflict.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readConflict(String conflictLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(conflictLink)) {
throw new IllegalArgumentException("conflictLink");
}
String path = Utils.joinPath(conflictLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Conflict, path, requestHeaders);
return new ResourceResponse(this.doRead(request), Conflict.class);
}
/**
* Reads all conflicts in a document collection.
*
* @param collectionLink the collection link.
* @param options the feed options.
* @return the feed response with the read conflicts.
*/
public FeedResponse readConflicts(
String collectionLink, FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
String path = Utils.joinPath(collectionLink,
Paths.CONFLICTS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(
ResourceType.Conflict,
path,
requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Feed, Conflict.class));
}
/**
* Query for conflicts.
*
* @param collectionLink the collection link.
* @param query the query.
* @param options the feed options.
* @return the feed response of the obtained conflicts.
*/
public FeedResponse queryConflicts(String collectionLink, String query, FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryConflicts(collectionLink, new SqlQuerySpec(query, null), options);
}
/**
* Query for conflicts.
*
* @param collectionLink the collection link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response of the obtained conflicts.
*/
public FeedResponse queryConflicts(String collectionLink, SqlQuerySpec querySpec, FeedOptions options) {
if (StringUtils.isEmpty(collectionLink)) {
throw new IllegalArgumentException("collectionLink");
}
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
String path = Utils.joinPath(collectionLink, Paths.CONFLICTS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Conflict,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Query, Conflict.class));
}
/**
* Deletes a conflict.
*
* @param conflictLink the conflict link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deleteConflict(String conflictLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(conflictLink)) {
throw new IllegalArgumentException("conflictLink");
}
String path = Utils.joinPath(conflictLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Conflict, path, requestHeaders);
return new ResourceResponse(this.doDelete(request), Conflict.class);
}
/**
* Creates a user.
*
* @param databaseLink the database link.
* @param user the user to create.
* @param options the request options.
* @return the resource response with the created user.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createUser(String databaseLink, User user, RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getUserRequest(databaseLink, user, options);
return new ResourceResponse(this.doCreate(request), User.class);
}
/**
* Upserts a user.
*
* @param databaseLink the database link.
* @param user the user to upsert.
* @param options the request options.
* @return the resource response with the upserted user.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse upsertUser(String databaseLink, User user, RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getUserRequest(databaseLink, user, options);
return new ResourceResponse(this.doUpsert(request), User.class);
}
private DocumentServiceRequest getUserRequest(String databaseLink, User user, RequestOptions options) {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
if (user == null) {
throw new IllegalArgumentException("user");
}
DocumentClient.validateResource(user);
String path = Utils.joinPath(databaseLink, Paths.USERS_PATH_SEGMENT);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.User, path, user, requestHeaders);
return request;
}
/**
* Replaces a user.
*
* @param user the user to use.
* @param options the request options.
* @return the resource response with the replaced user.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replaceUser(User user, RequestOptions options) throws DocumentClientException {
if (user == null) {
throw new IllegalArgumentException("user");
}
DocumentClient.validateResource(user);
String path = Utils.joinPath(user.getSelfLink(), null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.User, path, user, requestHeaders);
return new ResourceResponse(this.doReplace(request), User.class);
}
/**
* Deletes a user.
*
* @param userLink the user link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deleteUser(String userLink, RequestOptions options) throws DocumentClientException {
if (StringUtils.isEmpty(userLink)) {
throw new IllegalArgumentException("userLink");
}
String path = Utils.joinPath(userLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.User, path, requestHeaders);
return new ResourceResponse(this.doDelete(request), User.class);
}
/**
* Reads a user.
*
* @param userLink the user link.
* @param options the request options.
* @return the resource response with the read user.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readUser(String userLink, RequestOptions options) throws DocumentClientException {
if (StringUtils.isEmpty(userLink)) {
throw new IllegalArgumentException("userLink");
}
String path = Utils.joinPath(userLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.User, path, requestHeaders);
return new ResourceResponse(this.doRead(request), User.class);
}
/**
* Reads all users in a database.
*
* @param databaseLink the database link.
* @param options the feed options.
* @return the feed response with the read users.
*/
public FeedResponse readUsers(String databaseLink, FeedOptions options) {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
String path = Utils.joinPath(databaseLink, Paths.USERS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.User, path, requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Feed, User.class));
}
/**
* Query for users.
*
* @param databaseLink the database link.
* @param query the query.
* @param options the feed options.
* @return the feed response of the obtained users.
*/
public FeedResponse queryUsers(String databaseLink, String query, FeedOptions options) {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryUsers(databaseLink, new SqlQuerySpec(query, null), options);
}
/**
* Query for users.
*
* @param databaseLink the database link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response of the obtained users.
*/
public FeedResponse queryUsers(String databaseLink, SqlQuerySpec querySpec, FeedOptions options) {
if (StringUtils.isEmpty(databaseLink)) {
throw new IllegalArgumentException("databaseLink");
}
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
String path = Utils.joinPath(databaseLink, Paths.USERS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.User,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Query, User.class));
}
/**
* Creates a permission.
*
* @param userLink the user link.
* @param permission the permission to create.
* @param options the request options.
* @return the resource response with the created permission.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse createPermission(String userLink, Permission permission, RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getPermissionRequest(userLink, permission, options);
return new ResourceResponse(this.doCreate(request), Permission.class);
}
/**
* Upserts a permission.
*
* @param userLink the user link.
* @param permission the permission to upsert.
* @param options the request options.
* @return the resource response with the upserted permission.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse upsertPermission(String userLink, Permission permission, RequestOptions options)
throws DocumentClientException {
DocumentServiceRequest request = getPermissionRequest(userLink, permission, options);
return new ResourceResponse(this.doUpsert(request), Permission.class);
}
private DocumentServiceRequest getPermissionRequest(String userLink, Permission permission,
RequestOptions options) {
if (StringUtils.isEmpty(userLink)) {
throw new IllegalArgumentException("userLink");
}
if (permission == null) {
throw new IllegalArgumentException("permission");
}
DocumentClient.validateResource(permission);
String path = Utils.joinPath(userLink, Paths.PERMISSIONS_PATH_SEGMENT);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Permission,
path,
permission,
requestHeaders);
return request;
}
/**
* Replaces a permission.
*
* @param permission the permission to use.
* @param options the request options.
* @return the resource response with the replaced permission.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replacePermission(Permission permission, RequestOptions options)
throws DocumentClientException {
if (permission == null) {
throw new IllegalArgumentException("permission");
}
DocumentClient.validateResource(permission);
String path = Utils.joinPath(permission.getSelfLink(), null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Permission,
path,
permission,
requestHeaders);
return new ResourceResponse(this.doReplace(request), Permission.class);
}
/**
* Deletes a permission.
*
* @param permissionLink the permission link.
* @param options the request options.
* @return the resource response.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse deletePermission(String permissionLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(permissionLink)) {
throw new IllegalArgumentException("permissionLink");
}
String path = Utils.joinPath(permissionLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Permission, path, requestHeaders);
return new ResourceResponse(this.doDelete(request), Permission.class);
}
/**
* Reads a permission.
*
* @param permissionLink the permission link.
* @param options the request options.
* @return the resource response with the read permission.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readPermission(String permissionLink, RequestOptions options)
throws DocumentClientException {
if (StringUtils.isEmpty(permissionLink)) {
throw new IllegalArgumentException("permissionLink");
}
String path = Utils.joinPath(permissionLink, null);
Map requestHeaders = this.getRequestHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Permission, path, requestHeaders);
return new ResourceResponse(this.doRead(request), Permission.class);
}
/**
* Reads a permission.
*
* @param permissionLink the permission link.
* @param options the feed options.
* @return the feed response with the read permissions.
*/
public FeedResponse readPermissions(String permissionLink, FeedOptions options) {
if (StringUtils.isEmpty(permissionLink)) {
throw new IllegalArgumentException("permissionLink");
}
String path = Utils.joinPath(permissionLink, Paths.PERMISSIONS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Permission, path, requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Feed,
Permission.class));
}
/**
* Query for permissions.
*
* @param permissionLink the permission link.
* @param query the query.
* @param options the feed options.
* @return the feed response with the obtained permissions.
*/
public FeedResponse queryPermissions(String permissionLink, String query, FeedOptions options) {
if (StringUtils.isEmpty(permissionLink)) {
throw new IllegalArgumentException("permissionLink");
}
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryPermissions(permissionLink, new SqlQuerySpec(query, null), options);
}
/**
* Query for permissions.
*
* @param permissionLink the permission link.
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return the feed response with the obtained permissions.
*/
public FeedResponse queryPermissions(String permissionLink,
SqlQuerySpec querySpec,
FeedOptions options) {
if (StringUtils.isEmpty(permissionLink)) {
throw new IllegalArgumentException("permissionLink");
}
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
String path = Utils.joinPath(permissionLink, Paths.PERMISSIONS_PATH_SEGMENT);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Permission,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this,
request,
ReadType.Query,
Permission.class));
}
/**
* Replaces an offer.
*
* @param offer the offer to use.
* @return the resource response with the replaced offer.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse replaceOffer(Offer offer) throws DocumentClientException {
if (offer == null) {
throw new IllegalArgumentException("offer");
}
DocumentClient.validateResource(offer);
String path = Utils.joinPath(offer.getSelfLink(), null);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Offer,
path,
offer,
null);
return new ResourceResponse(this.doReplace(request), Offer.class);
}
/**
* Reads an offer.
*
* @param offerLink the offer link.
* @return the resource response with the read offer.
* @throws DocumentClientException the document client exception.
*/
public ResourceResponse readOffer(String offerLink) throws DocumentClientException {
if (StringUtils.isEmpty(offerLink)) {
throw new IllegalArgumentException("offerLink");
}
String path = Utils.joinPath(offerLink, null);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Offer, path, null);
return new ResourceResponse(this.doRead(request), Offer.class);
}
/**
* Reads offers.
*
* @param options the feed options.
* @return the feed response with the read offers.
*/
public FeedResponse readOffers(FeedOptions options) {
String path = Utils.joinPath(Paths.OFFERS_PATH_SEGMENT, null);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Offer, path, requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Feed, Offer.class));
}
/**
* Query for offers in a database.
*
* @param query the query.
* @param options the feed options.
* @return the feed response with the obtained offers.
*/
public FeedResponse queryOffers(String query, FeedOptions options) {
if (StringUtils.isEmpty(query)) {
throw new IllegalArgumentException("query");
}
return queryOffers(new SqlQuerySpec(query, null), options);
}
/**
* Query for offers in a database.
*
* @param querySpec the query specification.
* @param options the feed options.
* @return the feed response with the obtained offers.
*/
public FeedResponse queryOffers(SqlQuerySpec querySpec, FeedOptions options) {
if (querySpec == null) {
throw new IllegalArgumentException("querySpec");
}
String path = Utils.joinPath(Paths.OFFERS_PATH_SEGMENT, null);
Map requestHeaders = this.getFeedHeaders(options);
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.Offer,
path,
querySpec,
this.queryCompatibilityMode,
requestHeaders);
return new FeedResponse(new QueryIterable(this, request, ReadType.Query, Offer.class));
}
/**
* Gets database account information.
*
* @return the database account.
* @throws DocumentClientException the document client exception.
*/
public DatabaseAccount getDatabaseAccount() throws DocumentClientException {
DocumentServiceRequest request = DocumentServiceRequest.create(ResourceType.DatabaseAccount,
"", // path
null);
DocumentServiceResponse response = this.doRead(request);
DatabaseAccount account = response.getResource(DatabaseAccount.class);
// read the headers and set to the account
Map