com.basho.riak.client.http.request.RequestMeta Maven / Gradle / Ivy
/*
* This file is provided to you 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 com.basho.riak.client.http.request;
import com.basho.riak.client.cap.Quorum;
import java.util.Date;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import org.apache.http.impl.cookie.DateUtils;
import com.basho.riak.client.http.util.ClientUtils;
import com.basho.riak.client.http.util.Constants;
/**
* Extra headers and query parameters to send with a Riak operation.
*/
public class RequestMeta {
private Map queryParams = new LinkedHashMap();
private Map headers = new HashMap();
/**
* Use the given r parameter for fetchMeta, fetch, or stream operations
*
* @param r
* r- parameter for fetchMeta, fetch, or stream: the number of
* successful read response required for a successful overall
* response
* @return A {@link RequestMeta} object with the appropriate query
* parameters
*/
public static RequestMeta readParams(int r) {
RequestMeta meta = new RequestMeta();
meta.setQueryParam(Constants.QP_R, Integer.toString(r));
return meta;
}
/**
* Use the given w and dw params for store or delete operations.
*
* @param w
* w- parameter for store and delete: the number of successful
* write responses required for a successful store operation
* @param dw
* dw- parameter for store and delete: The number of successful
* durable write responses required for a successful store
* operation
* @return A {@link RequestMeta} object with the appropriate query
* parameters
*/
public static RequestMeta writeParams(Integer w, Integer dw) {
RequestMeta meta = new RequestMeta();
if (w != null) {
meta.setQueryParam(Constants.QP_W, Integer.toString(w));
}
if (dw != null) {
meta.setQueryParam(Constants.QP_DW, Integer.toString(dw));
}
return meta;
}
/**
* Use the given w and dw params for store or delete operations.
*
* @param w
* w- parameter for store and delete: the number of successful
* write responses required for a successful store operation
* @param dw
* dw- parameter for store and delete: The number of successful
* durable write responses required for a successful store
* operation
* @return A {@link RequestMeta} object with the appropriate query
* parameters
*/
public static RequestMeta writeParams(Quorum w, Quorum dw) {
RequestMeta meta = new RequestMeta();
if (w != null) {
if (w.isSymbolic()) {
meta.setQueryParam(Constants.QP_W, w.getName());
} else {
meta.setQueryParam(Constants.QP_W, Integer.toString(w.getIntValue()));
}
}
if (dw != null) {
if (dw.isSymbolic())
{
meta.setQueryParam(Constants.QP_DW, dw.getName());
} else {
meta.setQueryParam(Constants.QP_DW, Integer.toString(dw.getIntValue()));
}
}
return meta;
}
/**
* Use the given rw parameter for delete operations
*
* @param rw
* rw- parameter for delete: the number of
* successful read/write response required for a successful overall
* response
* @return A {@link RequestMeta} object with the appropriate query
* parameters
*/
public static RequestMeta deleteParams(int rw) {
RequestMeta meta = new RequestMeta();
meta.setQueryParam(Constants.QP_RW, Integer.toString(rw));
return meta;
}
/**
* Add the specified HTTP header
*
* @param key
* header name
* @param value
* header value
*/
public RequestMeta setHeader(String key, String value) {
headers.put(key, value);
return this;
}
/**
* Return the value for the HTTP header or null if not set
*
* @param key
* header name
* @return value of header or null if not set
*/
public String getHeader(String key) {
return headers.get(key);
}
/**
* Whether the HTTP header has been set
*
* @param key
* header name
*/
public boolean hasHeader(String key) {
return headers.containsKey(key);
}
/**
* Map of HTTP header names to values
*/
public Map getHeaders() {
return headers;
}
/**
* Query parameter value or null if not set
*
* @param param
* query parameter name
*/
public String getQueryParam(String param) {
return queryParams.get(param);
}
/**
* Add the given query parameter to the request
*
* @param param
* query parameter name
* @param value
* query parameter value
*/
public RequestMeta setQueryParam(String param, String value) {
queryParams.put(param, value);
return this;
}
/**
* A string containing all the specified query parameters in this
* {@link RequestMeta} in the form: p1=v1&p2=v2
*/
public String getQueryParams() {
StringBuilder qp = new StringBuilder();
for (String param : queryParams.keySet()) {
if (queryParams.get(param) != null) {
if (qp.length() > 0) {
qp.append("&");
}
qp.append(param).append("=").append(queryParams.get(param));
}
}
return qp.toString();
}
/**
* Get a copy of the query params in a map
*
* @return a {@link LinkedHashMap} of the query params (copy, does not
* read/write through)
*/
public Map getQueryParamMap() {
return new LinkedHashMap(queryParams);
}
/** Convenience method for the X-Riak-ClientId HTTP header */
public String getClientId() {
return getHeader(Constants.HDR_CLIENT_ID);
}
public RequestMeta setClientId(String clientId) {
return setHeader(Constants.HDR_CLIENT_ID, clientId);
}
/** Convenience method for the If-Modified-Since HTTP header */
public String getIfModifiedSince() {
return getHeader(Constants.HDR_IF_MODIFIED_SINCE);
}
public RequestMeta setIfModifiedSince(String lastmod) {
return setHeader(Constants.HDR_IF_MODIFIED_SINCE, lastmod);
}
public RequestMeta setIfModifiedSince(Date lastmod) {
return setHeader(Constants.HDR_IF_MODIFIED_SINCE, DateUtils.formatDate(lastmod));
}
/** Convenience method for the If-Unmodified-Since HTTP header */
public String getIfUnmodifiedSince() {
return getHeader(Constants.HDR_IF_UNMODIFIED_SINCE);
}
public RequestMeta setIfUnmodifiedSince(String lastmod) {
return setHeader(Constants.HDR_IF_UNMODIFIED_SINCE, lastmod);
}
public RequestMeta setIfUnmodifiedSince(Date lastmod) {
return setHeader(Constants.HDR_IF_UNMODIFIED_SINCE, DateUtils.formatDate(lastmod));
}
/** Convenience method for the If-Match HTTP header */
public String getIfMatch() {
return getHeader(Constants.HDR_IF_MATCH);
}
public RequestMeta setIfMatch(String etags) {
return setHeader(Constants.HDR_IF_MATCH, etags);
}
public RequestMeta setIfMatch(String[] etags) {
return setHeader(Constants.HDR_IF_MATCH, ClientUtils.join(etags, ","));
}
/** Convenience method for the If-None-Match HTTP header */
public String getIfNoneMatch() {
return getHeader(Constants.HDR_IF_NONE_MATCH);
}
public RequestMeta setIfNoneMatch(String etags) {
return setHeader(Constants.HDR_IF_NONE_MATCH, etags);
}
public RequestMeta setIfNoneMatch(String[] etags) {
return setHeader(Constants.HDR_IF_NONE_MATCH, ClientUtils.join(etags, ","));
}
/** Convenience method for the Accept HTTP header */
public String getAccept() {
return getHeader(Constants.HDR_ACCEPT);
}
public RequestMeta setAccept(String contentTypes) {
return setHeader(Constants.HDR_ACCEPT, contentTypes);
}
public RequestMeta setAsis(boolean asis) {
return setHeader(Constants.QP_ASIS, String.valueOf(asis));
}
public RequestMeta setTimeout(int timeout) {
return setHeader(Constants.QP_TIMEOUT, String.valueOf(timeout));
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy