io.orchestrate.client.KvListResource Maven / Gradle / Ivy
/*
* Copyright 2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.orchestrate.client;
import com.fasterxml.jackson.databind.JsonNode;
import lombok.NonNull;
import org.glassfish.grizzly.http.HttpContent;
import org.glassfish.grizzly.http.HttpRequestPacket;
import org.glassfish.grizzly.http.HttpResponsePacket;
import org.glassfish.grizzly.http.Method;
import javax.annotation.Nullable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import static io.orchestrate.client.Preconditions.checkArgument;
import static io.orchestrate.client.Preconditions.checkNotNegative;
import static io.orchestrate.client.Preconditions.checkNotNull;
import static io.orchestrate.client.Preconditions.checkNotNullOrEmpty;
/**
* The resource for the KV list features in the Orchestrate API.
*/
public class KvListResource extends BaseResource {
/** The collection for the request. */
private final String collection;
/** The start of the key range to paginate from. */
private @Nullable String startKey;
/** Include the specified "startKey" if it exists. */
private boolean startInclusive;
/** The end of the key range to paginate from. */
private @Nullable String stopKey;
/** Include the specified "startKey" if it exists. */
private boolean stopInclusive;
/** The number of KV objects to retrieve. */
private int limit;
/** Whether to retrieve the values for the list of objects. */
private boolean withValues;
/** The fully-qualified names of fields to select when filtering the result JSON */
private String withFields;
/** The fully-qualified names of fields to reject when filtering the result JSON */
private String withoutFields;
KvListResource(final OrchestrateClient client,
final JacksonMapper mapper,
final String collection) {
super(client, mapper);
assert (collection != null);
assert (collection.length() > 0);
this.collection = collection;
this.startInclusive = false;
this.stopInclusive = false;
this.limit = 10;
this.withValues = true;
this.withFields = null;
this.withoutFields = null;
}
/**
* Fetch a paginated, lexicographically ordered list of items contained in a
* collection.
*
* Usage:
*
* {@code
* KvList objects =
* client.listCollection("someCollection")
* .limit(10)
* .get(String.class)
* .get();
* }
*
*
* @param clazz Type information for marshalling objects at runtime.
* @param The type to deserialize the result of the request to.
* @return The prepared get request.
*/
public OrchestrateRequest> get(final @NonNull Class clazz) {
checkArgument(!startInclusive || startKey != null, "'startInclusive' requires 'startKey' for request.");
checkArgument(!stopInclusive || stopKey != null, "'stopInclusive' requires 'stopKey' for request.");
final String uri = client.uri(collection);
String query = "limit=".concat(Integer.toString(limit));
query = query.concat("&values=").concat(Boolean.toString(withValues));
if (startKey != null) {
final String keyName = (startInclusive) ? "startKey" : "afterKey";
query = query
.concat('&' + keyName + '=')
.concat(client.encode(startKey));
}
if (stopKey != null) {
final String keyName = (stopInclusive) ? "endKey" : "beforeKey";
query = query
.concat('&' + keyName + '=')
.concat(client.encode(stopKey));
}
if (withFields != null) {
query = query.concat("&with_fields=").concat(client.encode(withFields));
}
if (withoutFields != null) {
query = query.concat("&without_fields=").concat(client.encode(withoutFields));
}
final HttpContent packet = HttpRequestPacket.builder()
.method(Method.GET)
.uri(uri)
.query(query)
.build()
.httpContentBuilder()
.build();
return new OrchestrateRequest>(client, packet, new ResponseConverter>() {
@Override
public KvList from(final HttpContent response) throws IOException {
final int status = ((HttpResponsePacket) response.getHttpHeader()).getStatus();
assert (status == 200);
final JsonNode jsonNode = toJsonNode(response);
final OrchestrateRequest> next = parseLink("next", jsonNode, this);
final int count = jsonNode.get("count").asInt();
final List> results = new ArrayList>(count);
final Iterator iter = jsonNode.get("results").elements();
while (iter.hasNext()) {
results.add(toKvObject(iter.next(), clazz));
}
return new KvList(results, count, next);
}
});
}
/**
* Add the 'startKey' to the result set, equivalent to:
*
*
* {@code
* this.inclusive(Boolean.TRUE);
* }
*
*
* @return The KV list resource.
* @see #inclusive(boolean)
* @deprecated Use startKey(String, boolean)
*/
@Deprecated
public KvListResource inclusive() {
return inclusive(Boolean.TRUE);
}
/**
* If {@code inclusive} is {@code true} the 'startKey' will be included in
* the result set.
*
* @param inclusive Whether to include the 'startKey' in the result set.
* @return The KV list resource.
* @deprecated Use startKey(String, boolean)
*/
@Deprecated
public KvListResource inclusive(final boolean inclusive) {
this.startInclusive = inclusive;
return this;
}
/**
* The number of results to return.
*
* @param limit The number of KV objects to retrieve.
* @return The KV list resource.
*/
public KvListResource limit(final int limit) {
this.limit = checkNotNegative(limit, "limit");
return this;
}
/**
* The start (non-inclusive) of the key range to paginate from including the specified value
* if it exists.
*
* @param startKey The start of the key range to paginate from.
* @return The KV list resource.
*/
public KvListResource startKey(final String startKey) {
startKey(startKey, false);
return this;
}
/**
* The start of the key range to paginate from including the specified value
* if it exists.
*
* @param startKey The start of the key range to paginate from.
* @return The KV list resource.
*/
public KvListResource startKey(final String startKey, final boolean inclusive) {
this.startKey = checkNotNullOrEmpty(startKey, "startKey");
this.startInclusive = inclusive;
return this;
}
/**
* The end (non-inclusive) of the key range to paginate from including the specified value
* if it exists.
*
* @param stopKey The end of the key range to paginate from.
* @return The KV list resource.
*/
public KvListResource stopKey(final String stopKey) {
stopKey(stopKey, false);
return this;
}
/**
* The end of the key range to paginate from including the specified value
* if it exists.
*
* @param stopKey The end of the key range to paginate from.
* @param inclusive true to include the specified key in the results, false to stop just before it.
* @return The KV list resource.
*/
public KvListResource stopKey(final String stopKey, final boolean inclusive) {
this.stopKey = checkNotNullOrEmpty(stopKey, "stopKey");
this.stopInclusive = inclusive;
return this;
}
/**
* If {@code withValues} is {@code true} then the KV objects being listed
* will be retrieved with their values. Defaults to {@code true}.
*
* @param withValues The setting for whether to retrieve KV values.
* @return The KV list resource.
*/
public KvListResource withValues(final boolean withValues) {
this.withValues = withValues;
return this;
}
/**
* Apply field-filtering to the result JSON, using this list of fully-qualified
* field names as a whitelist of fields to include.
*
*
* {@code
* KvList objects =
* client.listCollection("someCollection")
* .withFields("value.name.first,value.name.last")
* .get(String.class)
* .get();
* }
*
*
* @param withFields The comma separated list of fully-qualified field names to select.
* @return This request.
*/
public KvListResource withFields(final String withFields) {
this.withFields = checkNotNull(withFields, "withFields");
return this;
}
/**
* Apply field-filtering to the result JSON, using this list of fully-qualified
* field names as a blacklist of fields to exclude.
*
*
* {@code
* KvList objects =
* client.listCollection("someCollection")
* .withoutFields("value.name.first,value.name.last")
* .get(String.class)
* .get();
* }
*
*
* @param withoutFields The comma separated list of fully-qualified field names to reject.
* @return This request.
*/
public KvListResource withoutFields(final String withoutFields) {
this.withoutFields = checkNotNull(withoutFields, "withoutFields");
return this;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy