com.basho.riak.client.response.StoreResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of riak-client Show documentation
HttpClient-based client for Riak
There is a newer version: 2.1.1
/*
 * 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.response;

import java.util.Collection;
import java.util.Map;

import com.basho.riak.client.RiakObject;
import com.basho.riak.client.util.Constants;

/**
 * Response from a PUT request for an object. Decorates an HttpResponse to
 * interpret store responses from Riak which returns updated object metadata in
 * HTTP headers.
 *
 * @deprecated with the addition of a protocol buffers client in 0.14 all the
 *             existing REST client code should be in client.http.* this class
 *             has therefore been moved. Please use
 *             com.basho.riak.client.http.response.StoreResponse
 *             instead.
 *             WARNING: This class will be REMOVED in the next version.
 * @see com.basho.riak.client.http.response.StoreResponse
 */
@Deprecated
public class StoreResponse extends HttpResponseDecorator implements WithBodyResponse {

    private final FetchResponse fetchResponse;
    private String vclock = null;
    private String lastmod = null;
    private String vtag = null;

    /**
     * On a 2xx response, parses the HTTP headers into updated object metadata.
     */
    public StoreResponse(FetchResponse fetchResponse) {
        super(fetchResponse);

        this.fetchResponse = fetchResponse;

        if (fetchResponse != null && fetchResponse.isSuccess()) {
            Map headers = fetchResponse.getHttpHeaders();
            vclock = headers.get(Constants.HDR_VCLOCK);
            lastmod = headers.get(Constants.HDR_LAST_MODIFIED);
            vtag = headers.get(Constants.HDR_ETAG);
        }
    }

    /** The object's updated vclock or null if Riak didn't return one. */
    public String getVclock() {
        return vclock;
    }

    /**
     * The object's last modified date or null if Riak didn't return one.
     */
    public String getLastmod() {
        return lastmod;
    }

    /** The object's updated etag or null if Riak didn't return one. */
    public String getVtag() {
        return vtag;
    }

    /**
     * @return
     * @see com.basho.riak.client.response.FetchResponse#hasObject()
     */
    public boolean hasObject() {
        return fetchResponse.hasObject();
    }

    /**
     * @return
     * @see com.basho.riak.client.response.FetchResponse#getObject()
     */
    public RiakObject getObject() {
        return fetchResponse.getObject();
    }

    /**
     * @return
     * @see com.basho.riak.client.response.FetchResponse#hasSiblings()
     */
    public boolean hasSiblings() {
        return fetchResponse.hasSiblings();
    }

    /**
     * @return
     * @see com.basho.riak.client.response.FetchResponse#getSiblings()
     */
    public Collection getSiblings() {
        return fetchResponse.getSiblings();
    }
}