com.googlecode.sardine.impl.methods.HttpUnlock.java Source code

Introduction

Here is the source code for com.googlecode.sardine.impl.methods.HttpUnlock.java

Source

/*
 * Copyright 2009-2011 Jon Stevens et al.
 *
 * 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 com.googlecode.sardine.impl.methods;

import java.net.URI;

import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.protocol.HTTP;

/**
 * @version $Id: HttpUnlock.java 290 2011-07-04 17:22:05Z latchkey $
 */
public class HttpUnlock extends HttpRequestBase {
    public static final String METHOD_NAME = "UNLOCK";

    /**
     * @param url   The resource
     * @param token The Lock-Token request header is used with the UNLOCK method to identify the lock to be removed.
     *              The lock token in the Lock-Token request header must identify a lock that contains the resource
     *              identified by Request-URI as a member.
     */
    public HttpUnlock(String url, String token) {
        this(URI.create(url), token);
    }

    /**
     * @param url   The resource
     * @param token The Lock-Token request header is used with the UNLOCK method to identify the lock to be removed.
     *              The lock token in the Lock-Token request header must identify a lock that contains the resource
     *              identified by Request-URI as a member.
     */
    public HttpUnlock(URI url, String token) {
        this.setURI(url);
        this.setHeader("Content-Type", "text/xml" + HTTP.CHARSET_PARAM + HTTP.UTF_8.toLowerCase());
        this.setHeader("Lock-Token", "<" + token + ">");
    }

    @Override
    public String getMethod() {
        return METHOD_NAME;
    }
}